TAknDesCArrayDecorator Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None


#include <akndescarraydecorator.h>

Public Member Functions

IMPORT_C  TAknDesCArrayDecorator ()
  Constructor.
IMPORT_C void  SetArray (const MDesCArray *aArray)
  Set pointer to descriptor array that will be decorated.
IMPORT_C void  SetDecorationText (const TDesC &aText)
  Set descriptor containing text that will be used as the extra entry in the descriptor array.
IMPORT_C void  SetActive (const TBool aActive)
  Set the decorator's activation state.
IMPORT_C TBool  DecoratedIndex (TInt &aIndex) const
  Reports whether the supplied index position corresponds to the decoration entry in the array.
virtual IMPORT_C TInt  MdcaCount () const
  Reports count of decorated array.
virtual IMPORT_C TPtrC  MdcaPoint (TInt aIndex) const
  Returns array element.

Constructor & Destructor Documentation

IMPORT_C TAknDesCArrayDecorator::TAknDesCArrayDecorator  ) 
 

Constructor.


Member Function Documentation

IMPORT_C TBool TAknDesCArrayDecorator::DecoratedIndex TInt &  aIndex  )  const
 

Reports whether the supplied index position corresponds to the decoration entry in the array.

Note that the client must call this method on each instance of TAknDesCArrayDecorator in the recursive containment (if it is not part of the MDesCArray interface).

Parameters:
aIndex  output parameter, contains index in array of the decorated position, only valid if return value is ETrue
Returns:
ETrue if there is a decorated position, EFalse otherwise
virtual IMPORT_C TInt TAknDesCArrayDecorator::MdcaCount  )  const [virtual]
 

Reports count of decorated array.

Returns:
count of decorated array
virtual IMPORT_C TPtrC TAknDesCArrayDecorator::MdcaPoint TInt  aIndex  )  const [virtual]
 

Returns array element.

Returns decoration text if the index is one off the end of the decorated array

Parameters:
index  of element to return
Returns:
descriptor representing array element
IMPORT_C void TAknDesCArrayDecorator::SetActive const TBool  aActive  ) 
 

Set the decorator's activation state.

If active, the decorator adds the decoration to the array, otherwise it does not.

Parameters:
aActive  ETrue = active; EFalse = inactive
IMPORT_C void TAknDesCArrayDecorator::SetArray const MDesCArray *  aArray  ) 
 

Set pointer to descriptor array that will be decorated.

Parameters:
aArray  pointer to descriptor array, ownership is not passed
IMPORT_C void TAknDesCArrayDecorator::SetDecorationText const TDesC &  aText  ) 
 

Set descriptor containing text that will be used as the extra entry in the descriptor array.

The client retains ownership of the descriptor containing the decoration text, and therefore can use the same descriptor text for multiple decorator instances. The client must maintain the descriptor for the lifetime of the decorator.

Parameters:
aText  descriptor, ownership is not passed

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

Copyright © Nokia Corporation 2001-2008
Back to top