Collapse all Symbian^3 Product Developer Library

TAlfCommand Class Reference

class TAlfCommand

TAlfCommand is the base class of all commands. A command is an instruction to some class that can be set to occur some time in the future. Each command stores information about an operation. Each command is also responsible for the execution of the command. Commands are processed by the class's OfferEventL() method.

Public Member Functions
	~TAlfCommand()
void	ExecuteL(CAlfEnv &)
IMPORT_C const TAlfObjectCommand *	ObjectCommand()
TInt	Size()
IMPORT_C TAlfCommandType	Type()

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

Private Attributes
TInt	iSpare1
TInt	iSpare2
TAlfCommandType	iType

Constructor & Destructor Documentation

TAlfCommand(TAlfCommandType)

IMPORT_C

TAlfCommand

(

TAlfCommandType

aType

)

[protected]

Protected constructor.

Parameters

TAlfCommandType aType

Type of the command.

~TAlfCommand()

IMPORT_C

~TAlfCommand

(

)

[virtual]

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 &)

void

ExecuteL

(

CAlfEnv &

aEnv

)

const [pure virtual]

Executes the command.

Parameters

CAlfEnv & aEnv

The environment in which the command is being executed.

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.

Size()

TInt

Size

(

)

const [pure virtual]

Returns the size of the command.

Type()

IMPORT_C TAlfCommandType

Type

(

)

const

Member Data Documentation

TInt iSpare1

TInt

iSpare1

[private]

TInt iSpare2

TInt

iSpare2

[private]

TAlfCommandType iType

TAlfCommandType

iType

[private]

Type of the command. Depends on the command class.