#include <DbCommandContext.h>

Inheritance diagram for OdDbCommandContext:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbCommandContext)

virtual OdDbDatabase *	database ()

OdDbUserIO *	dbUserIO ()

virtual OdDbHostAppServices *	appServices () const

Public Member Functions inherited from OdEdCommandContext
	ODRX_DECLARE_MEMBERS (OdEdCommandContext)

virtual OdEdUserIO *	userIO ()=0

virtual OdEdFunctionIO *	funcIO ()=0

virtual OdRxObject *	baseDatabase ()=0

virtual void	setArbitraryData (const OdString &szPathName, OdRxObject *pDataObj)=0

virtual OdRxObjectPtr	arbitraryData (const OdString &szPathName) const =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

Static Public Member Functions
static OdResult	registerCommandContext (OdDbDatabase db, OdDbCommandContext dbctx)

static OdDbCommandContext *	registredCommandContext (OdDbDatabase *db)

Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

static void	rxInit ()

static void	rxUninit ()

Detailed Description

This class defines the interface for I/O and database access for custom commands during their execution.

Remarks: Client applications that invoke custom commands, should use an instance of this class (or a subclass) to pass to the OdEdCommandStack::executeCommand function. Using this class instead of a true instance of OdEdCommandContext provides custom commands with database access.

Definition at line 54 of file DbCommandContext.h.

Member Function Documentation

◆ appServices()

virtual OdDbHostAppServices * OdDbCommandContext::appServices ( ) const

virtual

Returns host application services (by default database()->appServices()). Override to return correct value when there is no database yet.

◆ database()

OdDbDatabase * OdDbCommandContext::database ( )

inlinevirtual

Returns a database, for use in a custom command.

Reimplemented in CFxCommandContext.

Definition at line 105 of file DbCommandContext.h.

◆ dbUserIO()

OdDbUserIO * OdDbCommandContext::dbUserIO ( )

inline

Definition at line 98 of file DbCommandContext.h.

◆ ODRX_DECLARE_MEMBERS()

OdDbCommandContext::ODRX_DECLARE_MEMBERS ( OdDbCommandContext )

◆ registerCommandContext()

static OdResult OdDbCommandContext::registerCommandContext	(	OdDbDatabase *	db,
		OdDbCommandContext *	dbctx )

static

This function is called by application to register command context object. Callback functions than can retrieve command context object for user interaction.

Parameters

db	[in] database command context object is related to.
dbctx	[in] command context object. When NULL context will be unregistered.

See also: registredCommandContext

◆ registredCommandContext()

static OdDbCommandContext * OdDbCommandContext::registredCommandContext ( OdDbDatabase * db )