Collapse all Symbian^3 Product Developer Library

THuiObjectCommand Class Reference

class THuiObjectCommand : public THuiCommand

THuiObjectCommand is the base class for commands that modify data owned by an object. If the object gets deleted and the scheduler is notified of this, the command will be automatically canceled.

Inherits from

THuiObjectCommand
- THuiCommand

Public Member Functions
IMPORT_C void	ExecuteL(CHuiEnv &)
IMPORT_C TAny *	Object()
IMPORT_C const THuiObjectCommand *	ObjectCommand()
IMPORT_C THuiOp	Operation()
IMPORT_C TInt	Size()

Protected Member Functions
	THuiObjectCommand(THuiCommandType, TAny *, THuiOp)
IMPORT_C void	CommandExtension(const TUid &, TAny **)

Inherited Functions
	THuiCommand::Sender()const
	THuiCommand::SenderControl()const
	THuiCommand::SenderControlGroup()const
	THuiCommand::SenderType()const
	THuiCommand::SenderVisual()const
	THuiCommand::SetSender(THuiCommandObjectType,TAny *)
	THuiCommand::THuiCommand(THuiCommandType)
	THuiCommand::Type()const
	THuiCommand::~THuiCommand()

Private Attributes
TAny *	iObject
THuiOp	iOperation

Constructor & Destructor Documentation

THuiObjectCommand(THuiCommandType, TAny *, THuiOp)

IMPORT_C	THuiObjectCommand	(	THuiCommandType	aType,
			TAny *	aDataOwnerObject,
			THuiOp	aOperation
		)	[protected]

Protected constructor.

Parameters

THuiCommandType aType	Type of the command.
TAny * aDataOwnerObject	Object that owns the data this command handles.
THuiOp aOperation	Operation being done on the object.

Member Functions Documentation

CommandExtension(const TUid &, TAny **)

IMPORT_C void	CommandExtension	(	const TUid &	aExtensionUid,
			TAny **	aExtensionParams
		)	[protected, virtual]

Parameters

const TUid & aExtensionUid
TAny ** aExtensionParams

ExecuteL(CHuiEnv &)

IMPORT_C void

ExecuteL

(

CHuiEnv &

aEnv

)

const [virtual]

Executes the command.

Parameters

CHuiEnv & aEnv

The environment in which the command is being executed.

Object()

IMPORT_C TAny *

Object

(

)

const

Returns the data owner object of the command.

ObjectCommand()

IMPORT_C const THuiObjectCommand *

ObjectCommand

(

)

const [virtual]

Returns a pointer to the command casted to THuiObjectCommand. If this is not possible (the command is not derived from THuiObjectCommand), returns NULL instead.

Operation()

IMPORT_C THuiOp

Operation

(

)

const

Returns the operation of the command.

Size()

IMPORT_C TInt

Size

(

)

const [virtual]

Returns the size of the command.

Member Data Documentation

TAny * iObject

TAny *

iObject

[private]

Object that owns the data this command handles.

THuiOp iOperation

THuiOp

iOperation

[private]

Operation being done on the object.