Symbian^3 Application Developer Library >

CAknsEffectCommand Class Reference

class CAknsEffectCommand : public CBase

Effect command data class. Effect command class encapsulates the information of a single effect command that is used with effect queue item data objects.

This is a public class with exported functions. The class is not intended for derivation outside the library.

AknSkins.lib

Since
2.8

Inherits from

Public Member Functions
~CAknsEffectCommand ()
IMPORT_C void AppendParameterL (const TAknsRlParameterData &)
IMPORT_C MAknsRlParameterIterator * CreateParameterIteratorL ()
IMPORT_C TUid EffectUid ()
IMPORT_C TAknsRlRenderOpParam LayerConf ()
IMPORT_C CAknsEffectCommand * NewL ()
IMPORT_C void SetEffectUid (const TUid )
IMPORT_C void SetLayerConf (const TAknsRlRenderOpParam )
Protected Member Functions
CAknsEffectCommand ()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Protected Attributes
TAknsRlRenderOpParam iLayerConf
RPointerArray < CAknsEffectParameter > iParameters
TUid iUid

Constructor & Destructor Documentation

CAknsEffectCommand()

CAknsEffectCommand ( ) [protected]

C++ protected constructor.

~CAknsEffectCommand()

~CAknsEffectCommand ( ) [virtual]

Destructor.

Member Functions Documentation

AppendParameterL(const TAknsRlParameterData &)

IMPORT_C void AppendParameterL ( const TAknsRlParameterData & aParameter )

Appends a paramater to this effect command.

Since
2.8

Parameters

const TAknsRlParameterData & aParameter Parameter to be appended. The given data is copied, and thus no ownership is transferred.

CreateParameterIteratorL()

IMPORT_C MAknsRlParameterIterator * CreateParameterIteratorL ( )

Creates and returns a new parameter iterator.

Since
2.8

EffectUid()

IMPORT_C TUid EffectUid ( ) const

Returns the effect UID.

Since
2.8

LayerConf()

IMPORT_C TAknsRlRenderOpParam LayerConf ( ) const

Returns the layer configuration.

Since
2.8

NewL()

IMPORT_C CAknsEffectCommand * NewL ( ) [static]

Two-phased constructor.

Exceptions:
If allocation fails, function leaves with a system-wide error code.

SetEffectUid(const TUid)

IMPORT_C void SetEffectUid ( const TUid aValue )

Sets the effect UID.

Since
2.8

Parameters

const TUid aValue New effect UID.

SetLayerConf(const TAknsRlRenderOpParam)

IMPORT_C void SetLayerConf ( const TAknsRlRenderOpParam aValue )

Sets the layer configuration.

Since
2.8

Parameters

const TAknsRlRenderOpParam aValue New layer configuration.

Member Data Documentation

TAknsRlRenderOpParam iLayerConf

TAknsRlRenderOpParam iLayerConf [protected]

RPointerArray< CAknsEffectParameter > iParameters

RPointerArray < CAknsEffectParameter > iParameters [protected]

TUid iUid

TUid iUid [protected]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.