Collapse all Symbian^3 Product Developer Library

TAlfObjectCommand Class Reference

class TAlfObjectCommand : public TAlfCommand

TAlfObjectCommand 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.

Deriving class needs to override Clone() and Execute() functions from the Command base class and NOT to call the base class implementation.

Inherits from

TAlfObjectCommand
- TAlfCommand

Public Member Functions
IMPORT_C void	ExecuteL(CAlfEnv &)
IMPORT_C TAny *	Object()
IMPORT_C const TAlfObjectCommand *	ObjectCommand()
IMPORT_C TAlfOp	Operation()
IMPORT_C TInt	Size()

Protected Member Functions
	TAlfObjectCommand(TAlfCommandType, TAny *, TAlfOp)
IMPORT_C void	CommandExtension(const TUid &, TAny **)

Inherited Functions
	TAlfCommand::TAlfCommand(TAlfCommandType)
	TAlfCommand::Type()const
	TAlfCommand::~TAlfCommand()

Private Attributes
TAny *	iObject
TAlfOp	iOperation
TInt	iSpare1
TInt	iSpare2

Constructor & Destructor Documentation

TAlfObjectCommand(TAlfCommandType, TAny *, TAlfOp)

IMPORT_C	TAlfObjectCommand	(	TAlfCommandType	aType,
			TAny *	aDataOwnerObject,
			TAlfOp	aOperation
		)	[protected]

Protected constructor.

Parameters

TAlfCommandType aType	Type of the command.
TAny * aDataOwnerObject	Object that owns the data this command handles.
TAlfOp 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(CAlfEnv &)

IMPORT_C void

ExecuteL

(

CAlfEnv &

aEnv

)

const [virtual]

Executes the command.

Parameters

CAlfEnv & 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 TAlfObjectCommand *

ObjectCommand

(

)

const [virtual]

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

Operation()

IMPORT_C TAlfOp

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.

TAlfOp iOperation

TAlfOp

iOperation

[private]

Operation being done on the object.

TInt iSpare1

TInt

iSpare1

[private]

TInt iSpare2

TInt

iSpare2

[private]