Collapse all Symbian^3 Product Developer Library

THuiValueCommand Class Reference

class THuiValueCommand : public THuiObjectCommand

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

Inherits from

THuiValueCommand
- THuiObjectCommand
  - THuiCommand

Public Member Functions
	THuiValueCommand(TAny *, THuiTimedValue &, TReal32, TInt)
	THuiValueCommand(TAny *, THuiTimedValue &, THuiOp, TReal32, TReal32)
IMPORT_C void	ExecuteL(CHuiEnv &)
IMPORT_C TInt	Size()
IMPORT_C TReal32	Speed()
IMPORT_C TReal32	Target()
IMPORT_C THuiTimedValue &	TimedValue()
IMPORT_C TInt	TransitionTime()

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	iSpare1
TInt	iSpare2
TReal32	iSpeed
TReal32	iTarget
THuiTimedValue &	iTimedValue
TInt	iTransitionTime

Constructor & Destructor Documentation

THuiValueCommand(TAny *, THuiTimedValue &, TReal32, TInt)

IMPORT_C	THuiValueCommand	(	TAny *	aOwner,
			THuiTimedValue &	aValue,
			TReal32	aTarget,
			TInt	aTransitionTime = 0
		)

Constructs a new value command.

Parameters

TAny * aOwner	Owner of the timed value. Allowed to be NULL.
THuiTimedValue & aValue	Timed value to modify (owned by aOwner).
TReal32 aTarget	Target value
TInt aTransitionTime = 0	Time (in milliseconds) for the transition to occur.

THuiValueCommand(TAny *, THuiTimedValue &, THuiOp, TReal32, TReal32)

IMPORT_C	THuiValueCommand	(	TAny *	aOwner,
			THuiTimedValue &	aValue,
			THuiOp	aOperation = EHuiOpSet,
			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 * aOwner	Owner of the timed value. Allowed to be NULL.
THuiTimedValue & aValue	Timed value to modify (owned by aOwner).
THuiOp aOperation = EHuiOpSet	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(CHuiEnv &)

IMPORT_C void

ExecuteL

(

CHuiEnv &

aEnv

)

const [virtual]

Executes the command.

Parameters

CHuiEnv & 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 THuiTimedValue &

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.

THuiTimedValue & iTimedValue

THuiTimedValue &

iTimedValue

[private]

Timed value being operated on.

TInt iTransitionTime

TInt

iTransitionTime

[private]

Transition time in milliseconds.