Collapse all Symbian^3 Product Developer Library

TAlfTextCommand Class Reference

class TAlfTextCommand : public TAlfObjectCommand

TAlfTextCommand is a command that operaters on a text visual.

Usage:

  //Create text command to set text in textvisual
   TAlfTextCommand command( *textVisual, _L( "Text" ) );
  
  //Send command , text will be set to textvisual
   iEnv->Send( command, 1 );

Inherits from

TAlfTextCommand
- TAlfObjectCommand
  - TAlfCommand

Public Member Functions
	TAlfTextCommand(CAlfTextVisual &, const TDesC &, TAlfOp)
IMPORT_C void	ExecuteL(CAlfEnv &)
IMPORT_C TInt	Size()
IMPORT_C const TDesC &	Text()
IMPORT_C CAlfTextVisual &	TextVisual()

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	iSpare1
TInt	iSpare2
const TDesC &	iText

Constructor & Destructor Documentation

TAlfTextCommand(CAlfTextVisual &, const TDesC &, TAlfOp)

IMPORT_C	TAlfTextCommand	(	CAlfTextVisual &	aTextVisual,
			const TDesC &	aText,
			TAlfOp	aOperation = EAlfOpSetText
		)

Constructs a new text command.

Parameters

CAlfTextVisual & aTextVisual	Text visual.
const TDesC & aText	Text.
TAlfOp aOperation = EAlfOpSetText	Operation to perform.

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.

Size()

IMPORT_C TInt

Size

(

)

const [virtual]

Returns the size of the command.

Text()

IMPORT_C const TDesC &

Text

(

)

const

Returns a reference to the text of the visual.

TextVisual()

IMPORT_C CAlfTextVisual &

TextVisual

(

)

const

Returns the visual that the command operates on.

Member Data Documentation

TInt iSpare1

TInt

iSpare1

[private]

TInt iSpare2

TInt

iSpare2

[private]

const TDesC & iText

const TDesC &

iText

[private]

Text of the command.