InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
SnipRunActionComponent Class Reference
Inheritance diagram for SnipRunActionComponent:
CActionComponentIActionComponentIPMUnknown

Public Member Functions

 SnipRunActionComponent (IPMUnknown *boss)
 
virtual void UpdateActionStates (IActiveContext *ac, IActionStateList *listToUpdate, GSysPoint mousePoint=kInvalidMousePoint, IPMUnknown *widget=nil)
 
virtual void DoAction (IActiveContext *ac, ActionID actionID, GSysPoint mousePoint, IPMUnknown *widget)
 
- Public Member Functions inherited from CActionComponent
 CActionComponent (IPMUnknown *boss)
 
virtual ~CActionComponent ()
 

Additional Inherited Members

- Public Types inherited from IActionComponent
enum  { kDefaultIID = IID_IACTIONCOMPONENT }
 

Detailed Description

Implements the actions provided by this plug-in.

Implements IActionComponent based on the partial implementation CActionComponent.

Constructor & Destructor Documentation

SnipRunActionComponent::SnipRunActionComponent (IPMUnknownboss)

Constructor.

Parameters
bossinterface ptr from boss object on which this interface is aggregated.

Member Function Documentation

void SnipRunActionComponent::DoAction (IActiveContextac,
ActionID actionID,
GSysPoint mousePoint,
IPMUnknownwidget 
)
virtual

Called by the framework when the action is to be performed.

Parameters
accontext in which action is to be performed.
actionIDidentifies the action that was selected.
mousePointcontains the global mouse location at time of event causing action (e.g. context menus). kInvalidMousePoint if not relevant.
widget

Implements IActionComponent.

void SnipRunActionComponent::UpdateActionStates (IActiveContextac,
IActionStateListlistToUpdate,
GSysPoint mousePoint = kInvalidMousePoint,
IPMUnknownwidget = nil 
)
virtual

This method is called when the action component's menus need updating – this is where menu items are enabled or disabled, checked or unchecked, etc.

Parameters
accontext in which action is to be performed.
listToUpdatecontains a list of menu items for menu states updates.
mousePointcontains the global mouse location at time of event causing action.
widgetcontains the widget that invoked this action. May be nil.

Reimplemented from CActionComponent.