CAknsEffectCommand Class Reference

#include <mw/AknsItemData.h>

Link against: AknSkins.lib

class CAknsEffectCommand : public CBase

Inherits from

  • CAknsEffectCommand
    Protected Attributes
    TAknsRlRenderOpParam iLayerConf
    RPointerArray< CAknsEffectParameter >iParameters
    TUid iUid
    Public Member Functions
    virtual ~CAknsEffectCommand()
    IMPORT_C voidAppendParameterL(const TAknsRlParameterData &)
    IMPORT_C MAknsRlParameterIterator *CreateParameterIteratorL()
    IMPORT_C TUidEffectUid()
    IMPORT_C TAknsRlRenderOpParamLayerConf()
    IMPORT_C CAknsEffectCommand *NewL()
    IMPORT_C voidSetEffectUid(const TUid)
    IMPORT_C voidSetLayerConf(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()

    Detailed Description

    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.

    Since
    2.8

    Member Attribute Documentation

    iLayerConf

    TAknsRlRenderOpParam iLayerConf[protected]

    Layer configuration.

    iParameters

    RPointerArray< CAknsEffectParameter >iParameters[protected]

    Parameters array.

    iUid

    TUid iUid[protected]

    Effect UID.

    Constructor & Destructor Documentation

    CAknsEffectCommand ( )

    CAknsEffectCommand()[protected]

    C++ protected constructor.

    ~CAknsEffectCommand ( )

    ~CAknsEffectCommand()[virtual]

    Destructor.

    Member Function Documentation

    AppendParameterL ( const TAknsRlParameterData & )

    IMPORT_C voidAppendParameterL(const TAknsRlParameterData &aParameter)

    Appends a paramater to this effect command.

    Since
    2.8
    ParameterDescription
    aParameterParameter 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

    Returns: A new parameter iterator. Multiple iterators can be created. The ownership of the iterator is transferred to the caller, and the caller must ensure that the lifetime of the iterator does not exceed the lifetime of this object.

    EffectUid ( )

    IMPORT_C TUidEffectUid()const

    Returns the effect UID.

    Since
    2.8

    Returns: Effect UID.

    LayerConf ( )

    IMPORT_C TAknsRlRenderOpParamLayerConf()const

    Returns the layer configuration.

    Since
    2.8

    Returns: Layer configuration.

    NewL ( )

    IMPORT_C CAknsEffectCommand *NewL()[static]

    Two-phased constructor.

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

    Returns: Newly constructed object.

    SetEffectUid ( const TUid )

    IMPORT_C voidSetEffectUid(const TUidaValue)

    Sets the effect UID.

    Since
    2.8
    ParameterDescription
    aValueNew effect UID.

    SetLayerConf ( const TAknsRlRenderOpParam )

    IMPORT_C voidSetLayerConf(const TAknsRlRenderOpParamaValue)

    Sets the layer configuration.

    Since
    2.8
    ParameterDescription
    aValueNew layer configuration.
    © Nokia 2011.