CAknsEffectQueueItemData Class Reference

API published in: S60 2nd Ed

Link against: aknskins.lib aknskinsrv.lib aknswallpaperutils.lib

Capability Information

Required Capabilities

None

#include <aknsitemdata.h>

Inherits CAknsItemData.

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.


Public Member Functions
virtual	~CAknsEffectQueueItemData ()
	Destructor.
IMPORT_C void	SetRefItem (const TAknsItemID aValue)
	Sets the referenced item ID.
IMPORT_C TAknsItemID	RefItem () const
	Returns the referenced item ID.
IMPORT_C void	SetInputLayer (const TInt aValue)
	Sets the input layer index value.
IMPORT_C TInt	InputLayer () const
	Returns the input layer index value.
IMPORT_C void	SetInputLayerMode (const TInt aValue)
	Sets the input layer mode value.
IMPORT_C TInt	InputLayerMode () const
	Returns the input layer mode value.
IMPORT_C void	SetOutputLayer (const TInt aValue)
	Sets the output layer index value.
IMPORT_C TInt	OutputLayer () const
	Returns the output layer index value.
IMPORT_C void	SetOutputLayerMode (const TInt aValue)
	Sets the output layer mode value.
IMPORT_C TInt	OutputLayerMode () const
	Returns the output layer mode value.
IMPORT_C void	AppendCommandL (const CAknsEffectCommand *aCommand)
	Appends a command to this effect queue.
IMPORT_C MAknsRlCommandIterator *	CreateCommandIteratorL ()
	Creates and returns a new command iterator.
Static Public Member Functions
static IMPORT_C CAknsEffectQueueItemData *	NewL ()
	Two-phased constructor.
Protected Member Functions
	CAknsEffectQueueItemData (const TAknsItemType aType)
	C++ protected constructor.
Protected Attributes
TAknsItemID	iRefId
	Referenced item ID.
TInt	iInputLayer
	Input layer value.
TInt	iInputLayerMode
	Input layer mode value.
TInt	iOutputLayer
	Output layer value.
TInt	iOutputLayerMode
	Output layer mode value.
RPointerArray< CAknsEffectCommand >	iCommands
	Commands array.

Constructor & Destructor Documentation

virtual CAknsEffectQueueItemData::~CAknsEffectQueueItemData ( ) [virtual]

Destructor.

CAknsEffectQueueItemData::CAknsEffectQueueItemData ( const TAknsItemType aType ) [protected]

C++ protected constructor.

Constructs a new CAknsEffectQueueItemData.

Parameters:

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.

Member Function Documentation

IMPORT_C void CAknsEffectQueueItemData::AppendCommandL

(

const CAknsEffectCommand *

aCommand

)

Appends a command to this effect queue.

Parameters:

aCommand

Command to be appended. The ownership of the given instance is transferred to this object, even if the method leaves.

IMPORT_C MAknsRlCommandIterator* CAknsEffectQueueItemData::CreateCommandIteratorL

(

)

Creates and returns a new command iterator.

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.

IMPORT_C TInt CAknsEffectQueueItemData::InputLayer

(

)

const

Returns the input layer index value.

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

IMPORT_C TInt CAknsEffectQueueItemData::InputLayerMode

(

)

const

Returns the input layer mode value.

Returns:: Input layer mode.

static IMPORT_C CAknsEffectQueueItemData* CAknsEffectQueueItemData::NewL ( ) [static]

Two-phased constructor.

Constructs a new CAknsEffectQueueItemData object.

Returns:: Newly constructed CAknsEffectQueueItemData object.

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

IMPORT_C TInt CAknsEffectQueueItemData::OutputLayer

(

)

const

Returns the output layer index value.

Returns:: Output layer index.

IMPORT_C TInt CAknsEffectQueueItemData::OutputLayerMode

(

)

const

Returns the output layer mode value.

Returns:: Output layer mode.

IMPORT_C TAknsItemID CAknsEffectQueueItemData::RefItem

(

)

const

Returns the referenced item ID.

Returns:: Referenced item ID, or KAknsIIDDefault if none.

IMPORT_C void CAknsEffectQueueItemData::SetInputLayer

(

const TInt

aValue

)

Sets the input layer index value.

Parameters:

aValue

IMPORT_C void CAknsEffectQueueItemData::SetInputLayerMode

(

const TInt

aValue

)

Sets the input layer mode value.

Parameters:

aValue

IMPORT_C void CAknsEffectQueueItemData::SetOutputLayer

(

const TInt

aValue

)

Sets the output layer index value.

Parameters:

aValue

IMPORT_C void CAknsEffectQueueItemData::SetOutputLayerMode

(

const TInt

aValue

)

Sets the output layer mode value.

Parameters:

aValue

IMPORT_C void CAknsEffectQueueItemData::SetRefItem

(

const TAknsItemID

aValue

)

Sets the referenced item ID.

Parameters:

aValue

Field Documentation

RPointerArray<CAknsEffectCommand> CAknsEffectQueueItemData::iCommands [protected]

Commands array.

TInt CAknsEffectQueueItemData::iInputLayer [protected]

Input layer value.

TInt CAknsEffectQueueItemData::iInputLayerMode [protected]

Input layer mode value.

TInt CAknsEffectQueueItemData::iOutputLayer [protected]

Output layer value.

TInt CAknsEffectQueueItemData::iOutputLayerMode [protected]

Output layer mode value.

TAknsItemID CAknsEffectQueueItemData::iRefId [protected]

Referenced item ID.

The documentation for this class was generated from the following file:

aknsitemdata.h

CAknsEffectQueueItemData Class Reference

Capability Information

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation