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

Public Member Functions

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

Protected Member Functions

IXMLMrkSuitequeryOurSuite (IActiveContext *ac)
 
void DoAbout ()
 
void DoCompoundSection (IActiveContext *ac)
 
void DoCompoundTable (IActiveContext *ac)
 
void DoCompoundItemizedList (IActiveContext *ac)
 
void DoCompoundMediaObject (IActiveContext *ac)
 
void DoCompoundKeywordSet (IActiveContext *ac)
 

Additional Inherited Members

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

Detailed Description

This class implements the actions that are executed when the plug-in's menu items are selected. XMLMrkActionComponent implements IActionComponent based on the partial implementation CActionComponent.

The implementations are very straightforward given the IXMLMrkSuite interface that may be present on the abstract selection; given this interface, determine if a capability exists, and if it does then exercise that capability.

Constructor & Destructor Documentation

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

Constructor.

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

Member Function Documentation

void XMLMrkActionComponent::DoAbout ()
protected

Encapsulates functionality for the about menu item.

void XMLMrkActionComponent::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 XMLMrkActionComponent::DoCompoundItemizedList (IActiveContextac)
protected

Encapsulates functionality for the CompoundItemizedList menu item.

void XMLMrkActionComponent::DoCompoundKeywordSet (IActiveContextac)
protected

Encapsulates functionality for the CompoundKeywordSet menu item.

void XMLMrkActionComponent::DoCompoundMediaObject (IActiveContextac)
protected

Encapsulates functionality for the CompoundMediaObject menu item.

void XMLMrkActionComponent::DoCompoundSection (IActiveContextac)
protected

Encapsulates functionality for the CompoundSection menu item.

void XMLMrkActionComponent::DoCompoundTable (IActiveContextac)
protected

Encapsulates functionality for the CompoundTable menu item.

IXMLMrkSuite * XMLMrkActionComponent::queryOurSuite (IActiveContextac)
protected

Helper method to discover if the active selection has our suite aggregated

Parameters
acIN The active context. From this, the selection is obtained.
Returns
reference-incremented interface ptr to our suite if it exists on the abstract selection, or nil otherwise