CAknsEffectQueueItemData Class Reference

#include <mw/AknsItemData.h>

Link against: AknSkins.lib

class CAknsEffectQueueItemData : public CAknsItemData

Inherits from

CAknsEffectQueueItemData
- CAknsItemData

Protected Attributes
RPointerArray< CAknsEffectCommand >	iCommands
TInt	iInputLayer
TInt	iInputLayerMode
TInt	iOutputLayer
TInt	iOutputLayerMode
TAknsItemID	iRefId

Public Member Functions
virtual	~CAknsEffectQueueItemData()
IMPORT_C void	AppendCommandL(const CAknsEffectCommand *)
IMPORT_C MAknsRlCommandIterator *	CreateCommandIteratorL()
IMPORT_C TInt	InputLayer()
IMPORT_C TInt	InputLayerMode()
IMPORT_C CAknsEffectQueueItemData *	NewL()
IMPORT_C TInt	OutputLayer()
IMPORT_C TInt	OutputLayerMode()
IMPORT_C TAknsItemID	RefItem()
IMPORT_C void	SetInputLayer(const TInt)
IMPORT_C void	SetInputLayerMode(const TInt)
IMPORT_C void	SetOutputLayer(const TInt)
IMPORT_C void	SetOutputLayerMode(const TInt)
IMPORT_C void	SetRefItem(const TAknsItemID)

Protected Member Functions
	CAknsEffectQueueItemData(const TAknsItemType)

Inherited Attributes
	CAknsItemData::iType

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()

Detailed Description

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.

Since: 2.8

Member Attribute Documentation

iCommands

RPointerArray< CAknsEffectCommand >

iCommands

[protected]

Commands array.

iInputLayer

TInt

iInputLayer

[protected]

Input layer value.

iInputLayerMode

TInt

iInputLayerMode

[protected]

Input layer mode value.

iOutputLayer

TInt

iOutputLayer

[protected]

Output layer value.

iOutputLayerMode

TInt

iOutputLayerMode

[protected]

Output layer mode value.

iRefId

TAknsItemID

iRefId

[protected]

Referenced item ID.

Constructor & Destructor Documentation

CAknsEffectQueueItemData ( const TAknsItemType )

CAknsEffectQueueItemData

(

const TAknsItemType

aType

)

[protected]

C++ protected constructor. Constructs a new CAknsEffectQueueItemData.

Parameter	Description
aType	Item 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 Function Documentation

AppendCommandL ( const CAknsEffectCommand * )

IMPORT_C void

AppendCommandL

(

const CAknsEffectCommand *

aCommand

)

Appends a command to this effect queue.

Since: 2.8

Parameter	Description
aCommand	Command 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

Returns: A new command 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.

InputLayer ( )

IMPORT_C TInt

InputLayer

(

)

const

Returns the input layer index value.

Since: 2.8

Returns: Input layer index, or -1 if not used.

InputLayerMode ( )

IMPORT_C TInt

InputLayerMode

(

)

const

Returns the input layer mode value.

Since: 2.8

Returns: Input layer mode.

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.

Returns: Newly constructed CAknsEffectQueueItemData object.

OutputLayer ( )

IMPORT_C TInt

OutputLayer

(

)

const

Returns the output layer index value.

Since: 2.8

Returns: Output layer index.

OutputLayerMode ( )

IMPORT_C TInt

OutputLayerMode

(

)

const

Returns the output layer mode value.

Since: 2.8

Returns: Output layer mode.

RefItem ( )

IMPORT_C TAknsItemID

RefItem

(

)

const

Returns the referenced item ID.

Since: 2.8

Returns: Referenced item ID, or KAknsIIDDefault if none.

SetInputLayer ( const TInt )

IMPORT_C void

SetInputLayer

(

const TInt

aValue

)

Sets the input layer index value.

Since: 2.8

SetInputLayerMode ( const TInt )

IMPORT_C void

SetInputLayerMode

(

const TInt

aValue

)

Sets the input layer mode value.

Since: 2.8

SetOutputLayer ( const TInt )

IMPORT_C void

SetOutputLayer

(

const TInt

aValue

)

Sets the output layer index value.

Since: 2.8

SetOutputLayerMode ( const TInt )

IMPORT_C void

SetOutputLayerMode

(

const TInt

aValue

)

Sets the output layer mode value.

Since: 2.8

SetRefItem ( const TAknsItemID )

IMPORT_C void

SetRefItem

(

const TAknsItemID

aValue

)

Sets the referenced item ID.

Since: 2.8