CAknSettingItemArray Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknsettingitemlist.h>

Detailed Description

This class holds the setting items themselves and also manages the bitmap array.

Public Member Functions
IMPORT_C  CAknSettingItemArray (TInt aGranularity, TBool aIsNumbered, TInt aInitialOrdinal)
  CAknSettingItemArray is constructed as a numbered or unnumbered array.
virtual IMPORT_C  ~CAknSettingItemArray ()
  Destructor.
IMPORT_C TInt  MdcaCount () const
  Method by which the CAknSetStyleListBox accesses the number of items in the array.
IMPORT_C TPtrC16  MdcaPoint (TInt aIndex) const
  Method by which the setting item list accesses the text for the aIndex-th item in the array.
IMPORT_C TInt  ItemIndexFromVisibleIndex (TInt aVisibleIndex) const
  This method returns the true index in the array given the index as would be calculated by looking at the visible items.
virtual IMPORT_C void  RecalculateVisibleIndicesL ()
  Update date the mapping of visible indices.
IMPORT_C void  SetInitialOrdinal (TInt aInitialOrdinal)
  This is used to update the initial setting number for the top index.
IMPORT_C void  SetFlags (TInt aFlags)

Protected Member Functions
IMPORT_C void  SetVisibleCount (TInt aCount)
  Set the number of visible items.
IMPORT_C TInt  VisibleCount () const
  Returns the number of visible items.

Constructor & Destructor Documentation

IMPORT_C CAknSettingItemArray::CAknSettingItemArray (  TInt  aGranularity,
TBool  aIsNumbered,
TInt  aInitialOrdinal
) 
 

CAknSettingItemArray is constructed as a numbered or unnumbered array.

Parameters:
aGranularity  - number of items to extend when the aarray needs extention
aIsNumbered  - flags the array as numbered or not
aInitialOrdinal  - value to start the numbering at
virtual IMPORT_C CAknSettingItemArray::~CAknSettingItemArray (   )  [virtual]
 

Destructor.

Member Function Documentation

IMPORT_C TInt CAknSettingItemArray::ItemIndexFromVisibleIndex (  TInt  aVisibleIndex  )  const
 

This method returns the true index in the array given the index as would be calculated by looking at the visible items.

Parameters:
aVisibleIndex  - index among the visible items
Returns:
the corresponding "true" index in the array
IMPORT_C TInt CAknSettingItemArray::MdcaCount (   )  const
 

Method by which the CAknSetStyleListBox accesses the number of items in the array.

Returns:
number of items in the array
IMPORT_C TPtrC16 CAknSettingItemArray::MdcaPoint (  TInt  aIndex  )  const
 

Method by which the setting item list accesses the text for the aIndex-th item in the array.

Parameters:
aIndex  index at which to access the listbox text
Returns:
Descriptor for this item to be used by the listbox.
virtual IMPORT_C void CAknSettingItemArray::RecalculateVisibleIndicesL (   )  [virtual]
 

Update date the mapping of visible indices.

To be called when an item is made visible or invisible.

IMPORT_C void CAknSettingItemArray::SetFlags (  TInt  aFlags  ) 
 
IMPORT_C void CAknSettingItemArray::SetInitialOrdinal (  TInt  aInitialOrdinal  ) 
 

This is used to update the initial setting number for the top index.

The number set is the for the 0-th "true" or data index. That is, this numbered item may not show up

IMPORT_C void CAknSettingItemArray::SetVisibleCount (  TInt  aCount  )  [protected]
 

Set the number of visible items.

Parameters:
aCount  number of items that are visible.
IMPORT_C TInt CAknSettingItemArray::VisibleCount (   )  const [protected]
 

Returns the number of visible items.

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