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

Public Member Functions

 BscTAActionComponent (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)
 

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. These actions allows this plug-in's custom text attribute, kBscTAAttrBoss, to be applied or removed from text. This attribute controls the adornment, BscTAAdornment.

The implemention uses the API's ITextAttributeSuite interface to manipulate the text attribute.

Constructor & Destructor Documentation

BscTAActionComponent::BscTAActionComponent (IPMUnknownboss)
inline

Constructor.

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

Member Function Documentation

Binds the C implementation class onto its ImplementationID making the C code callable by the application *void BscTAActionComponent::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.

See Also
CActionComponent::DoAction

Implements IActionComponent.