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

Public Member Functions

 BPIActionComponent (IPMUnknown *boss)
 
virtual ~BPIActionComponent ()
 
virtual void DoAction (IActiveContext *ac, ActionID actionID, GSysPoint mousePoint, IPMUnknown *widget)
 
virtual void UpdateActionStates (IActiveContext *ac, IActionStateList *listToUpdate, 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 an action component, IActionComponent, defining the actions that are executed when this plug-in's menu items are chosen.

Constructor & Destructor Documentation

BPIActionComponent::BPIActionComponent (IPMUnknownboss)

Constructor.

Parameters
bossinterface ptr from boss object on which this interface is aggregated.
virtual BPIActionComponent::~BPIActionComponent ()
inlinevirtual

Destructor

Member Function Documentation

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

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

Parameters
accontext in which the action is to be performed.
actionIDidentifies the action to be performed.
mousePointontains the global mouse location at time of event causing action (e.g. context menus), kInvalidMousePoint otherwise.
widgetthe widget that invoked the action or nil otherwise

Implements IActionComponent.

void BPIActionComponent::UpdateActionStates (IActiveContextac,
IActionStateListlistToUpdate,
GSysPoint mousePoint,
IPMUnknownwidget 
)
virtual

Called by the framework to allow actions to be enabled or disabled dependent on the capability of the selection.

Parameters
accontext in which the action is to be performed.
listToUpdatelist containing items to be enabled disabled.
mousePointontains the global mouse location at time of event causing action (e.g. context menus), kInvalidMousePoint otherwise.
widgetthe widget that invoked the action or nil otherwise

Reimplemented from CActionComponent.