TAknDesCArrayDecorator Class Reference
#include
<mw/AknDesCArrayDecorator.h>
| class TAknDesCArrayDecorator |
Constructor & Destructor Documentation
TAknDesCArrayDecorator ( )
| IMPORT_C | TAknDesCArrayDecorator | ( | ) | |
Member Function Documentation
DecoratedIndex ( TInt & )
| IMPORT_C TBool | 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).
| Parameter | Description | | 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
MdcaCount ( )
| IMPORT_C TInt | MdcaCount | ( | ) | const [virtual] |
Reports count of decorated array
Returns: count of decorated array
MdcaPoint ( TInt )
| IMPORT_C TPtrC | MdcaPoint | ( | TInt | aIndex | ) | const [virtual] |
Returns array element. Returns decoration text if the index is one off the end of the decorated array
Returns: descriptor representing array element
SetActive ( const TBool )
| IMPORT_C void | SetActive | ( | const TBool | aActive | ) | |
Set the decorator's activation state. If active, the decorator adds the decoration to the array, otherwise it does not.
| Parameter | Description | | aActive | ETrue = active; EFalse = inactive |
SetArray ( const MDesCArray * )
| IMPORT_C void | SetArray | ( | const MDesCArray * | aArray | ) | |
Set pointer to descriptor array that will be decorated.
| Parameter | Description | | aArray | pointer to descriptor array, ownership is not passed |
SetDecorationText ( const TDesC & )
| IMPORT_C void | 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.
| Parameter | Description | | aText | descriptor, ownership is not passed |