CActionComponent Class Reference

#include <CActionComponent.h>

Inheritance diagram for CActionComponent:

Public Member Functions
	CActionComponent (IPMUnknown *boss)
virtual	~CActionComponent ()
virtual void	UpdateActionStates (IActiveContext *ac, IActionStateList *listToUpdate, GSysPoint mousePoint, IPMUnknown *widget)
Public Member Functions inherited from IActionComponent
virtual void	DoAction (IActiveContext *ac, ActionID actionID, GSysPoint mousePoint=kInvalidMousePoint, IPMUnknown *widget=nil)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Additional Inherited Members
Public Types inherited from IActionComponent
enum	{ kDefaultIID = IID_IACTIONCOMPONENT }

Detailed Description

Helper class providing partial implementation of IActionComponent.

Constructor & Destructor Documentation

CActionComponent::CActionComponent

(

IPMUnknown *

boss

)

Constructor.

Parameters

boss	object on which the interface being implemented is aggregated

virtual CActionComponent::~CActionComponent ( )

virtual

Destructor

Member Function Documentation

virtual void CActionComponent::UpdateActionStates ( IActiveContext *  ac, IActionStateList *  listToUpdate, GSysPoint  mousePoint, IPMUnknown *  widget  )

virtual

Called when the action component is asked to update a list of actions to the proper state. This method is required to be overridden by subclasses only if there are action components with kCustomEnabling specified. The list of actions is intially disabled and unselected, so it only has to be changed if this state is not correct. Note that action components are never asked to update actions that don't belong to them, or actions they have not specified kCustomEnabling for.

Parameters

listToUpdate	contains the items that client code should update the state for
mousePoint	contains the global mouse location at time of event causing action (e.g. context menus). kInvalidMousePoint if not 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. NB: Don't assume it's a widget from your panel (menu scripting may access any menu at any time).

Implements IActionComponent.

Reimplemented in DynMnuActionComponent, CusDtLnkUIActionComponent, PstLstUIActionComponent, DataUpdaterUIActionComponent, FrmLblUIActionComponent, CdlChtUIActionComponent, CstAFltActionComponent, DCLSizActionComponent, DocWchActionComponent, SuppUIActionComponent, BPIActionComponent, TblBscActionComponent, BscMnuActionComponent, DynPnMgrActionComponent, HidTxtEdActionComponent, WLBCmpActionComponent, CustomHttpLinkUIActionComponent, CusCondTxtActionComponent, PrnSelActionComponent, SnipRunActionComponent, and INXErrLogUIActionComponent.