Collapse all Symbian^3 Application Developer Library

TAlfCustomEventCommand Class Reference

class TAlfCustomEventCommand : public TAlfObjectCommand

TAlfCustomEventCommand is a command that sends a custom event. The command can be sent to any individual MAlfEventHandler derived object or broadcasted to all Control derived objects.

Usage

        //Create custom Event command, as iControl implements, MAlfEventHandler,
  // it will recieve custom event
  TAlfCustomEventCommand command( KCustomCommandIdDefault, iControl );
 
 //Send command
  iEnv->Send( command, 1 );

Inherits from

TAlfCustomEventCommand
- TAlfObjectCommand
  - TAlfCommand

Public Member Functions
	TAlfCustomEventCommand ( TInt , MAlfEventHandler *, TInt )
IMPORT_C TInt	EventData ()
IMPORT_C void	ExecuteL (CAlfEnv &)
IMPORT_C TInt	Param ()
IMPORT_C MAlfEventHandler *	Recipient ()
IMPORT_C TInt	Size ()

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

Inherited Functions
	TAlfCommand::TAlfCommand(TAlfCommandType)
	TAlfCommand::Type()const
	TAlfCommand::~TAlfCommand()
	TAlfObjectCommand::Object()const
	TAlfObjectCommand::ObjectCommand()const
	TAlfObjectCommand::Operation()const
	TAlfObjectCommand::TAlfObjectCommand(TAlfCommandType,TAny *,TAlfOp)

Private Attributes
TInt	iEventData
TInt	iEventParam
TInt	iSpare1
TInt	iSpare2

Constructor & Destructor Documentation

TAlfCustomEventCommand(TInt, MAlfEventHandler *, TInt)

IMPORT_C	TAlfCustomEventCommand	(	TInt	aEventParam,
			MAlfEventHandler *	aRecipient = NULL,
			TInt	aEventData = 0
		)

Constructs a new custom event command.

TodoIt would be good to be able to specify more information to be sent with the custom event, e.g., a pointer. Also check out TAlfEvent.

Parameters

TInt aEventParam	Parameter of the custom event.
MAlfEventHandler * aRecipient = NULL	Optional recipient of the event.
TInt aEventData = 0	Optional event data identifier.

Member Functions Documentation

CommandExtension(const TUid &, TAny **)

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

Parameters

const TUid & aExtensionUid
TAny ** aExtensionParams

EventData()

IMPORT_C TInt

EventData

(

)

const

Returns the event data of the command.

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.

Param()

IMPORT_C TInt

Param

(

)

const

Determines the custom event parameter of the command.

Recipient()

IMPORT_C MAlfEventHandler *

Recipient

(

)

const

Returns the recipient of the event, or NULL if none defined.

Size()

IMPORT_C TInt

Size

(

)

const [virtual]

Returns the size of the command.

Member Data Documentation

TInt iEventData

TInt

iEventData

[private]

Event data.

TInt iEventParam

TInt

iEventParam

[private]

Custom event parameter. TodoCould be a pointer as well?

TInt iSpare1

TInt

iSpare1

[private]

TInt iSpare2

TInt

iSpare2

[private]