InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ICSXSPlugPlugExtensions Class Referenceabstract
Inheritance diagram for ICSXSPlugPlugExtensions:
ICSXSPlugPlugEventHandlerIPMUnknown

Public Types

enum  { kDefaultIID = IID_ICSXSPLUGPLUG }
 
- Public Types inherited from ICSXSPlugPlugEventHandler
enum  { kDefaultIID = IID_ICSXSPLUGPLUG }
 
enum  CSXSEventScope { kEventScope_Application = 1, kEventScope_LastValue = 0x7FFFFFFF }
 
enum  CSXSEventErrorCode { kEventErrorCode_Success = 0, kEventErrorCode_OperationFailed, kEventErrorCode_Unknown, kEventErrorCode_LastValue = 0x7FFFFFFF }
 
typedef void(* EventListenerFn )(const CSXSEvent *const csxsEvent, void *const context)
 

Public Member Functions

virtual bool16 LoadExtension (const PMString &extensionID)=0
 
virtual bool16 UnloadExtension (const PMString &extensionID)=0
 
virtual ActionID GetExtensionActionID (const PMString &extensionID)=0
 
virtual WidgetID GetExtensionWidgetID (const PMString &extensionID)=0
 
- Public Member Functions inherited from ICSXSPlugPlugEventHandler
virtual CSXSEventErrorCode AddPlugPlugEventListener (const char *type, EventListenerFn eventListener, void *const context)=0
 
virtual CSXSEventErrorCode RemovePlugPlugEventListener (const char *type, EventListenerFn eventListener, void *const context)=0
 
virtual CSXSEventErrorCode DispatchPlugPlugEvent (const CSXSEvent *const csxsEvent) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual ActionID ICSXSPlugPlugExtensions::GetExtensionActionID (const PMString & extensionID)
pure virtual
Get the action ID for the extension.

The action ID can be used with IActionManager::PerformAction to mimick extension

menu trigger behavior.
Parameters
extensionIDThe ID of the extension to get the action ID for.
Returns
action ID of the extension.
virtual WidgetID ICSXSPlugPlugExtensions::GetExtensionWidgetID (const PMString & extensionID)
pure virtual
Get the widget ID from the extension ID.
Parameters
extensionIDThe ID of the extension to get the widget ID for.
Returns
widgetID of the widget from given extension ID.
virtual bool16 ICSXSPlugPlugExtensions::LoadExtension (const PMString & extensionID)
pure virtual
Loads an extension given its id.
Parameters
extensionIDThe ID of the extension to load.
Returns
kTrue, if the extension starts loading.
virtual bool16 ICSXSPlugPlugExtensions::UnloadExtension (const PMString & extensionID)
pure virtual
Unloads an extension given its id.
Parameters
extensionIDThe ID of the extension to unload.
Returns
kTrue, if the extension starts unloading.