OdEdCommandStackReactor Class Reference

#include <EdCommandStack.h>

Inheritance diagram for OdEdCommandStackReactor:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdEdCommandStackReactor)
virtual void	commandAdded (OdEdCommand *pCommand)
virtual void	commandWillBeRemoved (OdEdCommand *pCommand)
virtual void	commandWillStart (OdEdCommand *pCommand, OdEdCommandContext *pCmdCtx)
virtual void	commandEnded (OdEdCommand *pCommand, OdEdCommandContext *pCmdCtx)
virtual void	commandCancelled (OdEdCommand *pCommand, OdEdCommandContext *pCmdCtx)
virtual void	commandFailed (OdEdCommand *pCommand, OdEdCommandContext *pCmdCtx)
virtual OdEdCommandPtr	unknownCommand (const OdString &commandName, OdEdCommandContext *pCmdCtx)
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class is the base class for custom classes that receive notification of OdEdCommandStack events.

Remarks

Events consist of the addition and deletion, starting and ending, cancellation and failure, and non-recognition of registered commands.

The command stack consists of groups which contain their respective commands. Adding a command adds it to its group. If the group does not exist, the group is first created and pushed onto the top of the stack.

Remarks

The default implementations of all methods in this class do nothing but return.

Corresponding C++ library: TD_Root

<group OdEd_Classes>

Definition at line 193 of file EdCommandStack.h.

Member Function Documentation

commandAdded()

virtual void OdEdCommandStackReactor::commandAdded ( OdEdCommand *  pCommand )

virtual

Notification function called whenevever a command has been added to the global command stack.

Parameters

pCommand

[in] Pointer to the command object. \remarks This function is called after the operation.

commandCancelled()

virtual void OdEdCommandStackReactor::commandCancelled ( OdEdCommand *  pCommand, OdEdCommandContext *  pCmdCtx  )

virtual

Notification function called whenevever the execution of a command has been canceled.

Parameters

pCommand

[in] Pointer to the command object. \remarks This function is called after the operation.

commandEnded()

virtual void OdEdCommandStackReactor::commandEnded ( OdEdCommand *  pCommand, OdEdCommandContext *  pCmdCtx  )

virtual

Notification function called whenevever the execution of a command has ended.

Parameters

pCommand

[in] Pointer to the command object. \remarks This function is called after the operation.

commandFailed()

virtual void OdEdCommandStackReactor::commandFailed ( OdEdCommand *  pCommand, OdEdCommandContext *  pCmdCtx  )

virtual

Notification function called whenevever the execution of a command has failed.

Parameters

pCommand

[in] Pointer to the command object. \remarks This function is called after the operation.

commandWillBeRemoved()

virtual void OdEdCommandStackReactor::commandWillBeRemoved ( OdEdCommand *  pCommand )

virtual

Notification function called whenevever a command will be removed from the global command stack

Parameters

pCommand

[in] Pointer to the command object. \remarks This function is called after the operation.

commandWillStart()

virtual void OdEdCommandStackReactor::commandWillStart ( OdEdCommand *  pCommand, OdEdCommandContext *  pCmdCtx  )

virtual

Notification function called whenevever the execution of a command will start.

Parameters

pCommand

[in] Pointer to the command object. \remarks This function is called before the operation.

ODRX_DECLARE_MEMBERS()

OdEdCommandStackReactor::ODRX_DECLARE_MEMBERS

(

OdEdCommandStackReactor

)

unknownCommand()

virtual OdEdCommandPtr OdEdCommandStackReactor::unknownCommand ( const OdString &  commandName, OdEdCommandContext *  pCmdCtx  )

virtual

Notification function called whenevever the execution of an unknown command has been attempted.

Parameters

commandName

[in] name of unknown command. \remarks This function is called after the operation.

---

The documentation for this class was generated from the following file:

• EdCommandStack.h