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

Public Member Functions

 CstAFltActionComponent (IPMUnknown *boss)
 
virtual void DoAction (IActiveContext *ac, ActionID actionID, GSysPoint mousePoint=kInvalidMousePoint, IPMUnknown *widget=nil)
 
virtual void UpdateActionStates (IActiveContext *ac, IActionStateList *listToUpdate, GSysPoint mousePoint=kInvalidMousePoint, IPMUnknown *widget=nil)
 
- 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 that are executed when the plug-in's menu items are selected.

Author
Ken Sadahiro

Constructor & Destructor Documentation

Binds the C implementation class onto its ImplementationID making the C code callable by the application * CstAFltActionComponent::CstAFltActionComponent (IPMUnknownboss)

Constructor.

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

Member Function Documentation

void CstAFltActionComponent::DoAction (IActiveContextac,
ActionID actionID,
GSysPoint mousePoint = kInvalidMousePoint,
IPMUnknownwidget = nil 
)
virtual

The action component should do the requested action. This is where the menu item's action is taken. When a menu item is selected, the Menu Manager determines which plug-in is responsible for it, and calls its DoAction with the ID for the menu item chosen.

Parameters
actionIDidentifies the menu item that was selected.
See Also
CActionComponent::DoAction

Implements IActionComponent.

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

Called when the action component is asked to update a list of actions to the proper state. This method is required to be overridden by subclasses only if there are action components with kCustomEnabling specified.

The list of actions is intially disabled and unselected, so it only has to be changed if this state is not correct. Note that action components are never asked to update actions that don't belong to them, or actions they have not specified kCustomEnabling for.

See Also
CActionComponent::UpdateActionStates

Reimplemented from CActionComponent.