Main Page | Modules | Class List | File List | Class Members | File Members

OfxPlugin Struct Reference

#include <ofxCore.h>

List of all members.

Detailed Description

The structure that defines a plug-in to a host.

This structure is the first element in any plug-in structure using the OFX plug-in architecture. By examining it's members a host can determine the API that the plug-in implements, the version of that API, it's name and version.

For details see Architecture.


Public Attributes

const char * pluginApi
int apiVersion
const char * pluginIdentifier
unsigned int pluginVersionMajor
unsigned int pluginVersionMinor
void(* setHost )(OfxHost *host)
 Function the host uses to connect the plug-in to the host's api fetcher.
OfxPluginEntryPoint * mainEntry
 Main entry point for plug-ins.

Member Data Documentation

int OfxPlugin::apiVersion
 

Defines the version of the pluginApi that this plug-in implements

OfxPluginEntryPoint* OfxPlugin::mainEntry
 

Main entry point for plug-ins.

Mandatory function.

The exact set of actions is determined by the plug-in API that is being implemented, however all plug-ins can perform several actions. For the list of actions consult OFX Actions.

Preconditions

  • setHost has been called

const char* OfxPlugin::pluginApi
 

Defines the type of the plug-in, this will tell the host what the plug-in does. e.g.: an image effects plug-in would be a "OfxImageEffectPlugin"

const char* OfxPlugin::pluginIdentifier
 

String that uniquely labels the plug-in among all plug-ins that implement an API. It need not necessarily be human sensible, however the preference is to use reverse internet domain name of the developer, followed by a '.' then by a name that represents the plug-in.. It must be a legal ASCII string and have no whitespace in the name and no non printing chars. For example "uk.co.somesoftwarehouse.myPlugin"

unsigned int OfxPlugin::pluginVersionMajor
 

Major version of this plug-in, this gets incremented when backwards compatibility is broken.

unsigned int OfxPlugin::pluginVersionMinor
 

Major version of this plug-in, this gets incremented when software is changed, but does not break backwards compatibility.

void(* OfxPlugin::setHost)(OfxHost *host)
 

Function the host uses to connect the plug-in to the host's api fetcher.

  • fetchApi - pointer to host's API fetcher
Mandatory function.

The very first function called in a plug-in. The plug-in must not call any OFX functions within this, it must only set it's local copy of the host pointer.

Precondition:
  • nothing else has been called
Postcondition:
  • the pointer suite is valid until the plug-in is unloaded

The documentation for this struct was generated from the following file:
Copyright 2003-2004 The Foundry Visonmongers Ltd. All rights reserved.
Copying and redistribution with or without modification, is permitted provided that the following conditions are met:
  1. Redistributions of the document must retain the above copyright notice and this list of conditions.
  2. Neither the name of The Foundry Visonmongers Ltd nor names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
Automatic documentation generated by DOxygen.