Collapse all Symbian^3 Application Developer Library

TAlfValueCommand Class Reference

class TAlfValueCommand : public TAlfObjectCommand

TAlfValueCommand is a command that operates on a single timed value.

        //Create timed value command to set visualopacity of a visual
  TAlfValueCommand command( visual, EAlfValueCommandVisualSetOpacity, 0.2, 15 );
  
  //Send command , visualopacity will be set
   iEnv->Send( command, 1 );

Inherits from

TAlfValueCommand
- TAlfObjectCommand
  - TAlfCommand

Public Member Functions
	TAlfValueCommand ( TAny *, TAlfValueCommandTarget , TReal32 , TInt )
	TAlfValueCommand ( TAny *, TAlfValueCommandTarget , TAlfOp , TReal32 , TReal32 )
IMPORT_C void	ExecuteL (CAlfEnv &)
IMPORT_C TInt	Size ()
IMPORT_C TReal32	Speed ()
IMPORT_C TReal32	Target ()
IMPORT_C TAlfValueCommandTarget	TimedValue ()
IMPORT_C TInt	TransitionTime ()

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
TReal32	iSpeed
TReal32	iTarget
TAlfValueCommandTarget	iTimedValue
TInt	iTransitionTime

Constructor & Destructor Documentation

TAlfValueCommand(TAny *, TAlfValueCommandTarget, TReal32, TInt)

IMPORT_C	TAlfValueCommand	(	TAny *	aObject,
			TAlfValueCommandTarget	aObjectType,
			TReal32	aTarget,
			TInt	aTransitionTime = 0
		)

Constructs a new value command.

Parameters

TAny * aObject	Object. Needs to match with aObjectType
TAlfValueCommandTarget aObjectType	Timed value to modify.
TReal32 aTarget	Target value
TInt aTransitionTime = 0	Time (in milliseconds) for the transition to occur.

TAlfValueCommand(TAny *, TAlfValueCommandTarget, TAlfOp, TReal32, TReal32)

IMPORT_C	TAlfValueCommand	(	TAny *	aObject,
			TAlfValueCommandTarget	aObjectType,
			TAlfOp	aOperation = EAlfOpSet,
			TReal32	aTarget = 0.0,
			TReal32	aTiming = 0.0
		)

Constructs a new value command. This constructor takes an operation parameter in addition to the target and timing values.

Parameters

TAny * aObject	Object. Needs to match with aObjectType
TAlfValueCommandTarget aObjectType	Timed value to modify.
TAlfOp aOperation = EAlfOpSet	Operation to perform.
TReal32 aTarget = 0.0	Target value
TReal32 aTiming = 0.0	Time (in milliseconds) for the transition to occur.

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.

Speed()

IMPORT_C TReal32

Speed

(

)

const

Returns the transition speed. Zero, if not set.

Target()

IMPORT_C TReal32

Target

(

)

const

Returns the target value.

TimedValue()

IMPORT_C TAlfValueCommandTarget

TimedValue

(

)

const

Returns the visual that the command operates on.

TransitionTime()

IMPORT_C TInt

TransitionTime

(

)

const

Returns the transition time.

Member Data Documentation

TInt iSpare1

TInt

iSpare1

[private]

TInt iSpare2

TInt

iSpare2

[private]

TReal32 iSpeed

TReal32

iSpeed

[private]

Optionally, transition speed in units/second.

TReal32 iTarget

TReal32

iTarget

[private]

Target value.

TAlfValueCommandTarget iTimedValue

TAlfValueCommandTarget

iTimedValue

[private]

Timed value being operated on.

TInt iTransitionTime

TInt

iTransitionTime

[private]

Transition time in milliseconds.