CAknListBoxLayoutDecorator Class Reference

API published in: S60 1st Ed

Link against: avkon.lib eikctl.lib eikcoctl.lib

Capability Information

Required Capabilities

None

#include <aknlistboxlayoutdecorator.h>

Public Member Functions
IMPORT_C  ~CAknListBoxLayoutDecorator ()
  Destructor.
IMPORT_C const MDesCArray *  Array () const
  get the array
IMPORT_C void  SetArray (const MDesCArray *aArray)
  set the array
IMPORT_C void  SetLeadingDecorationTextL (const TDesC &aText)
  set the text that will be inserted before the text from the descriptor array entry
IMPORT_C void  SetTrailingDecorationTextL (const TDesC &aText)
  set the text that will be inserted after the text from the descriptor array entry
IMPORT_C void  SetActive (const TBool aActive)
  set the decoration to be active or inactive
virtual IMPORT_C TInt  MdcaCount () const
  Pass count through straight from contained descriptor array.
virtual IMPORT_C TPtrC  MdcaPoint (TInt aIndex) const
  Modify contents of descriptor to contain additional formatting for list box style.

Static Public Member Functions
static IMPORT_C CAknListBoxLayoutDecorator *  NewL ()
  Factory function.
static IMPORT_C CAknListBoxLayoutDecorator *  NewLC ()
  Factory function.

Protected Types
enum   { KSafeSizeOfDescriptor = 32 }

Protected Member Functions
  CAknListBoxLayoutDecorator ()
  Constructor, 1st phase of construction.
void  ConstructL ()
  ConstructL, 2nd phase of construction.

Member Enumeration Documentation

anonymous enum [protected]
 
Enumerator:
KSafeSizeOfDescriptor 

Constructor & Destructor Documentation

IMPORT_C CAknListBoxLayoutDecorator::~CAknListBoxLayoutDecorator (   ) 
 

Destructor.

CAknListBoxLayoutDecorator::CAknListBoxLayoutDecorator (   )  [protected]
 

Constructor, 1st phase of construction.

Member Function Documentation

IMPORT_C const MDesCArray* CAknListBoxLayoutDecorator::Array (   )  const
 

get the array

Returns:
pointer to array - ownership is not passed
void CAknListBoxLayoutDecorator::ConstructL (   )  [protected]
 

ConstructL, 2nd phase of construction.

virtual IMPORT_C TInt CAknListBoxLayoutDecorator::MdcaCount (   )  const [virtual]
 

Pass count through straight from contained descriptor array.

Returns:
number of items in array
virtual IMPORT_C TPtrC CAknListBoxLayoutDecorator::MdcaPoint (  TInt  aIndex  )  const [virtual]
 

Modify contents of descriptor to contain additional formatting for list box style.

Original string will be truncated in favour of formatting in low memory conditions.

Returns:
descriptor pointer containing modified string - WARNING contents of this return value will be replaced next time this method is called!
static IMPORT_C CAknListBoxLayoutDecorator* CAknListBoxLayoutDecorator::NewL (   )  [static]
 

Factory function.

static IMPORT_C CAknListBoxLayoutDecorator* CAknListBoxLayoutDecorator::NewLC (   )  [static]
 

Factory function.

IMPORT_C void CAknListBoxLayoutDecorator::SetActive (  const TBool  aActive  ) 
 

set the decoration to be active or inactive

Parameters:
aActive  if ETrue, decoration will be added; if EFalse, layout will be unchanged
IMPORT_C void CAknListBoxLayoutDecorator::SetArray (  const MDesCArray *  aArray  ) 
 

set the array

Parameters:
aArray  pointer to array - ownership is not passed
IMPORT_C void CAknListBoxLayoutDecorator::SetLeadingDecorationTextL (  const TDesC &  aText  ) 
 

set the text that will be inserted before the text from the descriptor array entry

Parameters:
aText  descriptor to insert before each entry
IMPORT_C void CAknListBoxLayoutDecorator::SetTrailingDecorationTextL (  const TDesC &  aText  ) 
 

set the text that will be inserted after the text from the descriptor array entry

Parameters:
aText  descriptor to append after each entry
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top