CFxCommand Class Reference

#include <FxCommand.h>

Inheritance diagram for CFxCommand:

Public Types
enum	{   kNoSelectionSetModifications = 0x04000000, kViewOperation = 0x08000000, kHidden = 0x10000000, kDisabledInRefedit = 0x20000000,   kApplicationContext = 0x40000000, kExecuteStartup = 0x80000000, kHiddenHistory = 0x00040000, kDisabledInActionRecording = 0x00001000,   kDimMoveEnabled = 0x00002000, kHiddenInAutoComplete = 0x00004000, kReadOnlyMode = 0x00008000, kNoCommandOutput = 0x00000100,   kUseHoverSelection = 0x00000200 }
Public Types inherited from OdEdCommand
enum	{   kModal = 0x00000000, kTransparent = 0x00000001, kUsePickset = 0x00000002, kRedraw = 0x00000004,   kNoPerspective = 0x00000008, kNoMultiple = 0x00000010, kNoTilemode = 0x00000020, kNoPaperspace = 0x00000040,   kPlotOnly = 0x00000080, kNoOEM = 0x00000100, kUndefined = 0x00000200, kInProgress = 0x00000400,   kDefun = 0x00000800, kNoNewStack = 0x00010000, kNoInternalLock = 0x00020000, kDocReadLock = 0x00080000,   kDocExclusiveLock = 0x00100000, kSession = 0x00200000, kInterruptible = 0x00400000, kNoHistory = 0x00800000,   kNoUndoMarker = 0x01000000, kNoBedit = 0x02000000 }

Public Member Functions
	~CFxCommand ()
const OdString	groupName () const override
virtual int	Execute (CFxCommandContext *pFxCmdCtx)=0
void	execute (OdEdCommandContext *pCmdCtx) override
void	undefine (bool undefIt) override
OdInt32	flags () const override
bool	HasFlag (OdInt32 flag) const
virtual void	Help () const
virtual unsigned int	GetHelpId () const
virtual const OdString	displayName () const
Public Member Functions inherited from OdEdCommand
	ODRX_DECLARE_MEMBERS (OdEdCommand)
	~OdEdCommand ()
virtual const OdString	globalName () const =0
virtual const OdString	localName () const
virtual const OdRxModule *	module () const
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

Static Public Member Functions
static CFxString	GetBuiltInGroupName ()
static CFxString	GetLISPGroupName (const CFxDocument *pDocument)
static void	OpenHelp ()
Static Public Member Functions inherited from OdEdCommand
static OdEdCommandPtr	createObject (const OdString &sGroupName, const OdString &sGlobalName, const OdString &sLocalName, OdUInt32 commandFlags, OdEdCommandFunction *pFunction, OdRxModule *pModule=0)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Member Functions
	CFxCommand ()
void	AddFlags (OdInt32 flags)
void	RemoveFlags (OdInt32 flags)
void	SetFlags (OdInt32 flags)
bool	HasFlag (OdInt32 flag)
Protected Member Functions inherited from OdEdCommand
	OdEdCommand ()

Protected Attributes
OdInt32	m_Flags

Detailed Description

Description: Represents the base class for all commands. Library: DDKERNEL

Definition at line 38 of file FxCommand.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Description:

Enumerator
kNoSelectionSetModifications
kViewOperation
kHidden
kDisabledInRefedit
kApplicationContext
kExecuteStartup
kHiddenHistory
kDisabledInActionRecording
kDimMoveEnabled
kHiddenInAutoComplete
kReadOnlyMode
kNoCommandOutput
kUseHoverSelection

Definition at line 45 of file FxCommand.h.

Constructor & Destructor Documentation

~CFxCommand()

CFxCommand::~CFxCommand

(

)

CFxCommand()

CFxCommand::CFxCommand ( )

protected

Member Function Documentation

AddFlags()

void CFxCommand::AddFlags ( OdInt32  flags )

protected

Description: Adds flags to command.

displayName()

virtual const OdString CFxCommand::displayName ( ) const

virtual

Description: Returns local (translated) display name in sentence case.

Execute()

virtual int CFxCommand::Execute ( CFxCommandContext *  pFxCmdCtx )

pure virtual

Description: Pure virtual method indicating a later implementation redefinition.

execute()

void CFxCommand::execute ( OdEdCommandContext *  pCmdCtx )

overridevirtual

Description: Reads type only keyword prompt Arguments:

Parameters

pCmdCtx

Input Return Value:

Implements OdEdCommand.

flags()

OdInt32 CFxCommand::flags ( ) const

overridevirtual

Description: Returns current flags.

Reimplemented from OdEdCommand.

GetBuiltInGroupName()

static CFxString CFxCommand::GetBuiltInGroupName ( )

static

Description: Returns *GLOBAL keyword.

GetHelpId()

virtual unsigned int CFxCommand::GetHelpId ( ) const

virtual

Description: Sets HelpID to zero.

GetLISPGroupName()

static CFxString CFxCommand::GetLISPGroupName ( const CFxDocument *  pDocument )

static

Description: Returns LISP group name.

groupName()

const OdString CFxCommand::groupName ( ) const

overridevirtual

Description: Returns global group name.

Implements OdEdCommand.

HasFlag() [1/2]

bool CFxCommand::HasFlag ( OdInt32  flag )

protected

Description: Checks if it has flags.

HasFlag() [2/2]

bool CFxCommand::HasFlag

(

OdInt32

flag

)

const

Description: Returns flag according to kModal value.

Help()

virtual void CFxCommand::Help ( ) const

virtual

Description: Displays Help according to Command context.

OpenHelp()

static void CFxCommand::OpenHelp ( )

static

Description: Displays Help initial page.

RemoveFlags()

void CFxCommand::RemoveFlags ( OdInt32  flags )

protected

Description: Removes flags from command.

SetFlags()

void CFxCommand::SetFlags ( OdInt32  flags )

protected

Description: Sets flags for command.

undefine()

void CFxCommand::undefine ( bool  undefIt )

overridevirtual

Description: Checks if undefined item can be added or removed to flags.

Reimplemented from OdEdCommand.

Member Data Documentation

m_Flags

OdInt32 CFxCommand::m_Flags

protected

Definition at line 147 of file FxCommand.h.

---

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

• FxCommand.h