CAknsEffectCommand Class Reference

API published in: S60 2nd Ed

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

Capability Information

Required Capabilities

None

#include <aknsitemdata.h>

Inherited by CAknsAnimationCommand.

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.


Public Member Functions
virtual  ~CAknsEffectCommand ()
  Destructor.
IMPORT_C void  SetEffectUid (const TUid aValue)
  Sets the effect UID.
IMPORT_C TUid  EffectUid () const
  Returns the effect UID.
IMPORT_C void  SetLayerConf (const TAknsRlRenderOpParam aValue)
  Sets the layer configuration.
IMPORT_C TAknsRlRenderOpParam  LayerConf () const
  Returns the layer configuration.
IMPORT_C void  AppendParameterL (const TAknsRlParameterData &aParameter)
  Appends a paramater to this effect command.
IMPORT_C MAknsRlParameterIterator *  CreateParameterIteratorL ()
  Creates and returns a new parameter iterator.

Static Public Member Functions
static IMPORT_C CAknsEffectCommand *  NewL ()
  Two-phased constructor.

Protected Member Functions
  CAknsEffectCommand ()
  C++ protected constructor.

Protected Attributes
TUid  iUid
  Effect UID.
TAknsRlRenderOpParam  iLayerConf
  Layer configuration.
RPointerArray< CAknsEffectParameter >  iParameters
  Parameters array.

Constructor & Destructor Documentation

virtual CAknsEffectCommand::~CAknsEffectCommand (   )  [virtual]
 

Destructor.

CAknsEffectCommand::CAknsEffectCommand (   )  [protected]
 

C++ protected constructor.

Member Function Documentation

IMPORT_C void CAknsEffectCommand::AppendParameterL (  const TAknsRlParameterData &  aParameter  ) 
 

Appends a paramater to this effect command.

Parameters:
aParameter  Parameter to be appended. The given data is copied, and thus no ownership is transferred.
IMPORT_C MAknsRlParameterIterator* CAknsEffectCommand::CreateParameterIteratorL (   ) 
 

Creates and returns a new parameter iterator.

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.
IMPORT_C TUid CAknsEffectCommand::EffectUid (   )  const
 

Returns the effect UID.

Returns:
Effect UID.
IMPORT_C TAknsRlRenderOpParam CAknsEffectCommand::LayerConf (   )  const
 

Returns the layer configuration.

Returns:
Layer configuration.
static IMPORT_C CAknsEffectCommand* CAknsEffectCommand::NewL (   )  [static]
 

Two-phased constructor.

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

Reimplemented in CAknsAnimationCommand.

IMPORT_C void CAknsEffectCommand::SetEffectUid (  const TUid  aValue  ) 
 

Sets the effect UID.

Parameters:
aValue  New effect UID.
IMPORT_C void CAknsEffectCommand::SetLayerConf (  const TAknsRlRenderOpParam  aValue  ) 
 

Sets the layer configuration.

Parameters:
aValue  New layer configuration.

Field Documentation

TAknsRlRenderOpParam CAknsEffectCommand::iLayerConf [protected]
 

Layer configuration.

RPointerArray<CAknsEffectParameter> CAknsEffectCommand::iParameters [protected]
 

Parameters array.

TUid CAknsEffectCommand::iUid [protected]
 

Effect UID.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top