S60 3rd Edition API Reference: AknListBoxUtils Class Reference

AknListBoxUtils Class Reference

API published in: S60 1st Ed

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

Capability Information

Required Capabilities

None


#include <aknlists.h>

Detailed Description

General utilities relating to listboxes.

Static Public Member Functions

static IMPORT_C void HandleItemRemovalAndPositionHighlightL (CEikListBox *aListBox, TInt aValueOfCurrentItemIndexBeforeRemoval, TBool aCurrentItemWasRemoved)
 This function is similar to HandleItemRemovalL().
static IMPORT_C void HandleItemRemovalAndPositionHighlightL (CEikListBox *aListBox, TInt aValueOfCurrentItemIndexBeforeRemoval, CArrayFix< TInt > &aIndexesToRemovedItems)
 This function should be called after one or more items have been removed.
static IMPORT_C TBool ListBoxLinesShown (MAknsSkinInstance *aInstance, MAknsControlContext *aCc)
 Check whether listbox lines need to be shown.

Member Function Documentation

static IMPORT_C void AknListBoxUtils::HandleItemRemovalAndPositionHighlightL CEikListBox aListBox,
TInt  aValueOfCurrentItemIndexBeforeRemoval,
CArrayFix< TInt > &  aIndexesToRemovedItems
[static]
 

This function should be called after one or more items have been removed.

If a leave occurs the framework generates a Symbian Leave code.

Parameters:
aListBox A pointer to CEikListBox object.
aValueOfCurrentItemIndexBeforeRemoval A current item index value before removal.
aIndexesToRemovedItems A thin templated base class for arrays of fixed length objects.
static IMPORT_C void AknListBoxUtils::HandleItemRemovalAndPositionHighlightL CEikListBox aListBox,
TInt  aValueOfCurrentItemIndexBeforeRemoval,
TBool  aCurrentItemWasRemoved
[static]
 

This function is similar to HandleItemRemovalL().

This function has to call when the items should be removed. If a leave occurs the framework generates a Symbian Leave code.

Parameters:
aListBox A pointer to CEikListBox object.
aValueOfCurrentItemIndexBeforeRemoval A current item index value before removal.
aCurrentItemWasRemoved ETrue if removed EFalse if not.
static IMPORT_C TBool AknListBoxUtils::ListBoxLinesShown MAknsSkinInstance aInstance,
MAknsControlContext aCc
[static]
 

Check whether listbox lines need to be shown.

While skin instance can be used directly by client code, it is often easier to use utility methods provided in AknsUtils and AknsDrawUtils.

Parameters:
aInstance A pointer to interface for skin instance.
aCc Interface that provides context specific skin parameters.
Returns:
ETrue if shown EFalse if not.

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

Copyright © Nokia Corporation 2001-2007
Back to top