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

Public Member Functions

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

Additional Inherited Members

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

Detailed Description

CstUniActionComponent implements the actions that are executed when the plug-in's menu items are selected.

CstUniActionComponent implements IActionComponent based on the partial implementation CActionComponent.

Constructor & Destructor Documentation

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

Constructor.

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

Member Function Documentation

void CstUniActionComponent::DoAction (IActiveContextac,
ActionID actionID,
GSysPoint mousePoint,
IPMUnknownwidget 
)
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
acrefers to the current active context, such as the front view or front document
actionIDidentifies which action this action component should perform
mousePointcontains the global mouse location at time of event causing action (e.g. context menus). kInvalidMousePoint if not relevant.
widgetcontains the widget that invoked this action. May be nil. e.g. Useful to use as a basis for Utils<IWidgetUtils>()->QueryRelatedWidget(...) to find widgets in a panel after its popup menu is hit.

Implements IActionComponent.