Collapse all Symbian^3 Product Developer Library

THuiCustomEventCommand Class Reference

class THuiCustomEventCommand : public THuiObjectCommand

THuiCustomEventCommand is a command that sends a custom event. The command can be sent to any individual MHuiEventHandler derived object or broadcasted to all CHuiControl derived objects.

Inherits from

THuiCustomEventCommand
- THuiObjectCommand
  - THuiCommand

Public Member Functions
	THuiCustomEventCommand(TInt, MHuiEventHandler *)
IMPORT_C void	ExecuteL(CHuiEnv &)
IMPORT_C TInt	Param()
IMPORT_C MHuiEventHandler *	Recipient()
IMPORT_C TInt	Size()

Protected Member Functions
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()
	THuiObjectCommand::Object()const
	THuiObjectCommand::ObjectCommand()const
	THuiObjectCommand::Operation()const
	THuiObjectCommand::THuiObjectCommand(THuiCommandType,TAny *,THuiOp)

Private Attributes
TInt	iEventParam
TInt	iSpare1
TInt	iSpare2

Constructor & Destructor Documentation

THuiCustomEventCommand(TInt, MHuiEventHandler *)

IMPORT_C	THuiCustomEventCommand	(	TInt	aEventParam,
			MHuiEventHandler *	aRecipient = NULL
		)

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

Parameters

TInt aEventParam	Parameter of the custom event.
MHuiEventHandler * aRecipient = NULL	Optional recipient of the event. If NULL then event is broadcasted.

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.

Param()

IMPORT_C TInt

Param

(

)

const

Determines the custom event parameter of the command.

Recipient()

IMPORT_C MHuiEventHandler *

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 iEventParam

TInt

iEventParam

[private]

Custom event parameter. Application cau use re_interpret_cast to send pointer as param

TInt iSpare1

TInt

iSpare1

[private]

TInt iSpare2

TInt

iSpare2

[private]