CFxCommandContext Class Reference

#include <FxCommandContext.h>

Inheritance diagram for CFxCommandContext:

Public Member Functions
	CFxCommandContext ()
	~CFxCommandContext () override
virtual CFxDocument *	GetFxDocument ()=0
virtual const CFxDocument *	GetFxDocument () const =0
virtual CFxSelectionSet *	GetFxMainSelectionSet ()=0
virtual CFxString	GetActiveCommandName () const =0
virtual const CFxString &	GetTopGroupName () const =0
virtual void	SetTopGroupName (const CFxString &)=0
virtual bool	IsQuiescent () const =0
virtual bool	IsSetVarActive () const =0
virtual bool	IsCommandActive () const =0
virtual bool	IsLISPActive () const =0
virtual bool	IsTransparentCommandActive () const =0
virtual bool	IsScriptActive () const =0
virtual bool	IsMultipleActive () const =0
virtual unsigned int	GetCommandStackDepth () const =0
virtual const CFxCommandToken *	GetActiveCommandToken () const =0
virtual const CFxCommandToken *	GetCommandToken (unsigned int iNumber) const =0
virtual int	GetInitdia () const =0
virtual void	SetExpressionToExecute (const OdResBufPtr &rbExpr)=0
Public Member Functions inherited from OdDbCommandContext
	ODRX_DECLARE_MEMBERS (OdDbCommandContext)
OdDbUserIO *	dbUserIO ()
Public Member Functions inherited from OdEdCommandContext
	ODRX_DECLARE_MEMBERS (OdEdCommandContext)
virtual OdEdUserIO *	userIO ()=0
virtual OdRxObject *	baseDatabase ()=0
virtual void	reset (class OdEdBaseIO *, OdRxObject *)
virtual OdEdBaseIO *	baseIO ()
virtual OdSmartPtr< OdEdCommandContext >	cloneObject (OdEdBaseIO *=NULL, OdRxObject *=NULL)
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

Protected Member Functions
OdDbDatabase *	database () override
virtual OdDbSelectionSet &	selectionSet ()
OdEdFunctionIO *	funcIO () override
void	setArbitraryData (const OdString &szPathName, OdRxObject *pDataObj) override
OdRxObjectPtr	arbitraryData (const OdString &szPathName) const override

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

Detailed Description

Description: Represents the context in which a given command was called. Library: DDKERNEL

Definition at line 38 of file FxCommandContext.h.

Constructor & Destructor Documentation

CFxCommandContext()

CFxCommandContext::CFxCommandContext

(

)

~CFxCommandContext()

CFxCommandContext::~CFxCommandContext ( )

override

Member Function Documentation

arbitraryData()

OdRxObjectPtr CFxCommandContext::arbitraryData ( const OdString &  szPathName ) const

overrideprotectedvirtual

Description: Arguments:

Parameters

szPathName

Input Return Value:

Implements OdEdCommandContext.

database()

OdDbDatabase* CFxCommandContext::database ( )

overrideprotectedvirtual

Description: Returns a pointer to a database, for use in a custom command.

Reimplemented from OdDbCommandContext.

funcIO()

OdEdFunctionIO* CFxCommandContext::funcIO ( )

overrideprotectedvirtual

Description: Return Value:

Implements OdEdCommandContext.

GetActiveCommandName()

virtual CFxString CFxCommandContext::GetActiveCommandName ( ) const

pure virtual

Description: Returns active command name.

GetActiveCommandToken()

virtual const CFxCommandToken* CFxCommandContext::GetActiveCommandToken ( ) const

pure virtual

Description: Returns active command token data.

GetCommandStackDepth()

virtual unsigned int CFxCommandContext::GetCommandStackDepth ( ) const

pure virtual

Description: Returns size of Commands Stack.

GetCommandToken()

virtual const CFxCommandToken* CFxCommandContext::GetCommandToken ( unsigned int  iNumber ) const

pure virtual

Description: Returns command token data.

GetFxDocument() [1/2]

virtual const CFxDocument* CFxCommandContext::GetFxDocument ( ) const

pure virtual

Description: Returns a pointer to a database, for use in a custom command.

GetFxDocument() [2/2]

virtual CFxDocument* CFxCommandContext::GetFxDocument ( )

pure virtual

Description: Returns a pointer to a database, for use in a custom command.

GetFxMainSelectionSet()

virtual CFxSelectionSet* CFxCommandContext::GetFxMainSelectionSet ( )

pure virtual

Description: Const method to returning current selection set

GetInitdia()

virtual int CFxCommandContext::GetInitdia ( ) const

pure virtual

Description: Return Value:

GetTopGroupName()

virtual const CFxString& CFxCommandContext::GetTopGroupName ( ) const

pure virtual

Description: Returns active command group name

IsCommandActive()

virtual bool CFxCommandContext::IsCommandActive ( ) const

pure virtual

Description: Returns true if command is active.

IsLISPActive()

virtual bool CFxCommandContext::IsLISPActive ( ) const

pure virtual

Description: Returns true if LISP is active.

IsMultipleActive()

virtual bool CFxCommandContext::IsMultipleActive ( ) const

pure virtual

Description: Returns true if REPEAT Command is active.

IsQuiescent()

virtual bool CFxCommandContext::IsQuiescent ( ) const

pure virtual

Description: Sets commands stack size to zero when quiescent(inactive).

IsScriptActive()

virtual bool CFxCommandContext::IsScriptActive ( ) const

pure virtual

Description: Returns true if SCRIPT Command is active.

IsSetVarActive()

virtual bool CFxCommandContext::IsSetVarActive ( ) const

pure virtual

Description: Returns true if command SETVAR is active.

IsTransparentCommandActive()

virtual bool CFxCommandContext::IsTransparentCommandActive ( ) const

pure virtual

Description: Returns true if TRANSPARENT Command is active.

selectionSet()

virtual OdDbSelectionSet& CFxCommandContext::selectionSet ( )

protectedvirtual

Description: Returns a pointer to a selection set object, for use in a custom command.

setArbitraryData()

void CFxCommandContext::setArbitraryData ( const OdString &  szPathName, OdRxObject *  pDataObj  )

overrideprotectedvirtual

Description: Arguments:

Parameters

szPathName	Input
pDataObj	Input

Implements OdEdCommandContext.

SetExpressionToExecute()

virtual void CFxCommandContext::SetExpressionToExecute ( const OdResBufPtr &  rbExpr )

pure virtual

Description: Arguments:

Parameters

rbExpr

Input

SetTopGroupName()

virtual void CFxCommandContext::SetTopGroupName ( const CFxString &  )

pure virtual

Description: Sets current top group name.

---

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

• FxCommandContext.h