BscShpActionComponent Class Reference

Inheritance diagram for BscShpActionComponent:

Public Member Functions
	BscShpActionComponent (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

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

BscShpActionComponent 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 * BscShpActionComponent::BscShpActionComponent

(

IPMUnknown *

boss

)

Constructor.

Parameters

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

Member Function Documentation

void BscShpActionComponent::DoAction ( IActiveContext *  ac, ActionID  actionID, GSysPoint  mousePoint = kInvalidMousePoint, IPMUnknown *  widget = nil  )

virtual

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

Parameters

ac	The IActiveContext, passed from Action Manager.
actionID	identifies which action this action component should perform
mousePoint	contains the global mouse location at time of event causing action (e.g. context menus). kInvalidMousePoint if not known or relevant.
widget	contains 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.