Symbian^3 Product Developer Library >

CAknsEffectQueueItemData Class Reference

class CAknsEffectQueueItemData : public CAknsItemData

Effect queue item data. Effect queue item data contains (in addition to base class members), the information required to render a single effect queue based skin element.

Item type for effect queue item data objects is always EAknsITEffectQueue.

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
~CAknsEffectQueueItemData()
IMPORT_C voidAppendCommandL(const CAknsEffectCommand *)
IMPORT_C MAknsRlCommandIterator *CreateCommandIteratorL()
IMPORT_C TIntInputLayer()
IMPORT_C TIntInputLayerMode()
IMPORT_C CAknsEffectQueueItemData *NewL()
IMPORT_C TIntOutputLayer()
IMPORT_C TIntOutputLayerMode()
IMPORT_C TAknsItemIDRefItem()
IMPORT_C voidSetInputLayer(const TInt)
IMPORT_C voidSetInputLayerMode(const TInt)
IMPORT_C voidSetOutputLayer(const TInt)
IMPORT_C voidSetOutputLayerMode(const TInt)
IMPORT_C voidSetRefItem(const TAknsItemID)
Protected Member Functions
CAknsEffectQueueItemData(const TAknsItemType)
Inherited Functions
CAknsItemData::CAknsItemData(const TAknsItemType)
CAknsItemData::SetType(const TAknsItemType)
CAknsItemData::Type()const
CAknsItemData::~CAknsItemData()
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
RPointerArray< CAknsEffectCommand >iCommands
TInt iInputLayer
TInt iInputLayerMode
TInt iOutputLayer
TInt iOutputLayerMode
TAknsItemID iRefId
Inherited Attributes
CAknsItemData::iType

Constructor & Destructor Documentation

CAknsEffectQueueItemData(const TAknsItemType)

CAknsEffectQueueItemData(const TAknsItemTypeaType)[protected]

C++ protected constructor. Constructs a new CAknsEffectQueueItemData.

Parameters

const TAknsItemType aTypeItem type of the new item data object. While this is always EAknsITEffectQueue for instances of this class, derived classes may specify another value.

~CAknsEffectQueueItemData()

~CAknsEffectQueueItemData()[virtual]

Destructor.

Member Functions Documentation

AppendCommandL(const CAknsEffectCommand *)

IMPORT_C voidAppendCommandL(const CAknsEffectCommand *aCommand)

Appends a command to this effect queue.

Since
2.8

Parameters

const CAknsEffectCommand * aCommandCommand to be appended. The ownership of the given instance is transferred to this object, even if the method leaves.

CreateCommandIteratorL()

IMPORT_C MAknsRlCommandIterator *CreateCommandIteratorL()

Creates and returns a new command iterator.

Since
2.8

InputLayer()

IMPORT_C TIntInputLayer()const

Returns the input layer index value.

Since
2.8

InputLayerMode()

IMPORT_C TIntInputLayerMode()const

Returns the input layer mode value.

Since
2.8

NewL()

IMPORT_C CAknsEffectQueueItemData *NewL()[static]

Two-phased constructor. Constructs a new CAknsEffectQueueItemData object.

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

OutputLayer()

IMPORT_C TIntOutputLayer()const

Returns the output layer index value.

Since
2.8

OutputLayerMode()

IMPORT_C TIntOutputLayerMode()const

Returns the output layer mode value.

Since
2.8

RefItem()

IMPORT_C TAknsItemIDRefItem()const

Returns the referenced item ID.

Since
2.8

SetInputLayer(const TInt)

IMPORT_C voidSetInputLayer(const TIntaValue)

Sets the input layer index value.

Since
2.8

Parameters

const TInt aValue

SetInputLayerMode(const TInt)

IMPORT_C voidSetInputLayerMode(const TIntaValue)

Sets the input layer mode value.

Since
2.8

Parameters

const TInt aValue

SetOutputLayer(const TInt)

IMPORT_C voidSetOutputLayer(const TIntaValue)

Sets the output layer index value.

Since
2.8

Parameters

const TInt aValue

SetOutputLayerMode(const TInt)

IMPORT_C voidSetOutputLayerMode(const TIntaValue)

Sets the output layer mode value.

Since
2.8

Parameters

const TInt aValue

SetRefItem(const TAknsItemID)

IMPORT_C voidSetRefItem(const TAknsItemIDaValue)

Sets the referenced item ID.

Since
2.8

Parameters

const TAknsItemID aValue

Member Data Documentation

RPointerArray< CAknsEffectCommand > iCommands

RPointerArray< CAknsEffectCommand >iCommands[protected]

TInt iInputLayer

TInt iInputLayer[protected]

TInt iInputLayerMode

TInt iInputLayerMode[protected]

TInt iOutputLayer

TInt iOutputLayer[protected]

TInt iOutputLayerMode

TInt iOutputLayerMode[protected]

TAknsItemID iRefId

TAknsItemID iRefId[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.