OFX Actions


Detailed Description

These are the actions passed to a plug-in's 'main' function


Modules

 Image Effect Actions
 Intereact Actions

Defines

#define kOfxActionLoad   "OfxActionLoad"
 Action called just after a plug-in has been loaded, for more details see ArchitectureMainFunction and ActionsGeneralLoad.
#define kOfxActionDescribe   "OfxActionDescribe"
 Action called to have a plug-in describe itself to the host, for more details see ArchitectureMainFunction and ActionsGeneralDescribe.
#define kOfxActionUnload   "OfxActionUnload"
 Action called just before a plug-in is unloaded, for more details see ArchitectureMainFunction and ActionsGeneralUnload.
#define kOfxActionPurgeCaches   "OfxActionPurgeCaches"
 Action called to have a plug-in purge any temporary caches it may have allocated ArchitectureMainFunction and ActionsGeneralPurgeCaches.
#define kOfxActionSyncPrivateData   "OfxActionSyncPrivateData"
 Action called to have a plug-in sync any internal data structures into custom parameters.
#define kOfxActionCreateInstance   "OfxActionCreateInstance"
 Action called just after an instance has been created ArchitectureMainFunction and ActionsGeneralCreateInstance.
#define kOfxActionDestroyInstance   "OfxActionDestroyInstance"
 Action called just before an instance is destroyed and ActionsGeneralDestroyInstance.
#define kOfxActionInstanceChanged   "OfxActionInstanceChanged"
 Action indicating something in the instance has been changed, see ActionsGeneralInstanceChanged.
#define kOfxActionBeginInstanceChanged   "OfxActionBeginInstanceChanged"
 Action called before the start of a set of kOfxActionEndInstanceChanged actions, used with kOfxActionEndInstanceChanged to bracket a grouped set of changes, see ActionsGeneralInstanceChangedBeginEnd.
#define kOfxActionEndInstanceChanged   "OfxActionEndInstanceChanged"
 Action called after the end of a set of kOfxActionEndInstanceChanged actions, used with kOfxActionBeginInstanceChanged to bracket a grouped set of changes, see ActionsGeneralInstanceChangedBeginEnd.
#define kOfxActionBeginInstanceEdit   "OfxActionBeginInstanceEdit"
 Action called when an instance has the first editor opened for it.
#define kOfxActionEndInstanceEdit   "OfxActionEndInstanceEdit"
 Action called when an instance has the last editor closed.


Define Documentation

#define kOfxActionBeginInstanceChanged   "OfxActionBeginInstanceChanged"

Action called before the start of a set of kOfxActionEndInstanceChanged actions, used with kOfxActionEndInstanceChanged to bracket a grouped set of changes, see ActionsGeneralInstanceChangedBeginEnd.

#define kOfxActionBeginInstanceEdit   "OfxActionBeginInstanceEdit"

Action called when an instance has the first editor opened for it.

#define kOfxActionCreateInstance   "OfxActionCreateInstance"

Action called just after an instance has been created ArchitectureMainFunction and ActionsGeneralCreateInstance.

#define kOfxActionDescribe   "OfxActionDescribe"

Action called to have a plug-in describe itself to the host, for more details see ArchitectureMainFunction and ActionsGeneralDescribe.

#define kOfxActionDestroyInstance   "OfxActionDestroyInstance"

Action called just before an instance is destroyed and ActionsGeneralDestroyInstance.

#define kOfxActionEndInstanceChanged   "OfxActionEndInstanceChanged"

Action called after the end of a set of kOfxActionEndInstanceChanged actions, used with kOfxActionBeginInstanceChanged to bracket a grouped set of changes, see ActionsGeneralInstanceChangedBeginEnd.

#define kOfxActionEndInstanceEdit   "OfxActionEndInstanceEdit"

Action called when an instance has the last editor closed.

#define kOfxActionInstanceChanged   "OfxActionInstanceChanged"

Action indicating something in the instance has been changed, see ActionsGeneralInstanceChanged.

#define kOfxActionLoad   "OfxActionLoad"

Action called just after a plug-in has been loaded, for more details see ArchitectureMainFunction and ActionsGeneralLoad.

#define kOfxActionPurgeCaches   "OfxActionPurgeCaches"

Action called to have a plug-in purge any temporary caches it may have allocated ArchitectureMainFunction and ActionsGeneralPurgeCaches.

#define kOfxActionSyncPrivateData   "OfxActionSyncPrivateData"

Action called to have a plug-in sync any internal data structures into custom parameters.

#define kOfxActionUnload   "OfxActionUnload"

Action called just before a plug-in is unloaded, for more details see ArchitectureMainFunction and ActionsGeneralUnload.


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.