API published in: S60 1st Ed
Link against: avkon.lib eikctl.lib eikcoctl.lib
Required Capabilities
None
#include <eikfrlb.h>
Inherits CEikTextListBox.
Inherited by AknListBoxLinesTemplate< CEikFormattedCellListBox >, AknPopupListEmpty< CEikFormattedCellListBox >, and CEikSettingsListBox.
ListBox <>--> View ---> ItemDrawer ---> Model ListBox <>--> ItemDrawer <>---> Data ListBox <>--> Model <>---> MDesCArray <--- Array <>---> Engine
Content for list items are tab-separated strings.
See concrete classes derived from CEikFormattedCellListBox
for details.
Starting from 3.0 listbox uses highlight animations. Starting and stopping animation is connected to focus events. To support highlight animations properly you have to make sure that the list has focus when it has 'visual focus'. Common issues:
void CContainer::FocusChanged( TDrawNow aDrawNow ) { ... some code ... if( iListBox ) iListBox->SetFocus( IsFocused(), aDrawNow ); }
CCoeControl::HandleResourceChange
, which informs child components about resource change.
See methods CEikListBox::ConstructL()
CEikTextListBox::SetItemTextArray()
CEikFormattedCellListBoxData::SetIconArray()
Related flags for dialogs (avkon.hrh
) EAknDialogSelectionList
EAknDialogMenuList
EAknDialogMultiselectionList
Check also: CAknSelectionListDialog
(aknselectionlist.h
) CAknMarkableListDialog
(aknselectionlist.h
) CAknPopupList
(aknpopup.h
) CAknListQueryDialog
(aknquerydialog.h
) CAknColumnListBox
(aknlists.h
)
Public Member Functions |
|
IMPORT_C | CEikFormattedCellListBox () |
C++ default constructor. |
|
IMPORT_C void | ConstructFromResourceL (TResourceReader &aReader) |
Constructs list box from resource file. |
|
IMPORT_C void | ConstructL (const CCoeControl *aParent, TInt aFlags) |
By default Symbian 2nd phase constructor is private. |
|
IMPORT_C CTextListBoxModel * | Model () const |
Gets model class of the list box. |
|
IMPORT_C CFormattedCellListBoxItemDrawer * | ItemDrawer () const |
Gets list box item drawer. |
|
void | SetIconSizes () |
Sets icon sizes for visible list box items. |
|
IMPORT_C void | UseLogicalToVisualConversion (TBool aUseConversion) |
Enable or disable logical to visual reordering in listbox data text drawing. |
|
IMPORT_C void | EnableExtendedDrawingL () |
This method needs to be called to enable extended drawing features such as skinning, pictograph drawing and marquee text in
the listbox draw routine. |
|
IMPORT_C void | EnableStretching (const TBool aEnabled) |
Enables/disables list stretching. |
|
IMPORT_C void | HideSecondRow (const TBool aHide) |
Hides the second row of a double style listbox. |
|
IMPORT_C CListBoxView * | MakeViewClassInstanceL () |
From CEikListBox . |
|
IMPORT_C void | FocusChanged (TDrawNow aDrawNow) |
From CEikListBox . |
|
IMPORT_C void | GetColorUseListL (CArrayFix< TCoeColorUse > &aColorUseList) const |
From CCoeControl . |
|
IMPORT_C void | HandleResourceChange (TInt aType) |
From CCoeControl . |
|
IMPORT_C void | HandlePointerEventL (const TPointerEvent &aPointerEvent) |
From CCoeControl . |
|
Protected Member Functions |
|
virtual IMPORT_C void | CreateItemDrawerL () |
Creates item draver for the listbox. |
|
virtual IMPORT_C TInt | AdjustRectHeightToWholeNumberOfItems (TRect &aRect) const |
From CEikListBox . |
|
virtual IMPORT_C TTypeUid::Ptr | MopSupplyObject (TTypeUid aId) |
From MObjectProvider . |
|
C++ default constructor. |
|
From Rounds down the height of the rectangle (if necessary) so that only a whole number of items can be displayed inside the list box.
Reimplemented from CEikListBox. Reimplemented in CAknFormGraphicStyleListBox. |
|
Constructs list box from resource file.
See
Flags:
Reimplemented from CEikTextListBox. Reimplemented in CAknPopupSettingList. |
|
By default Symbian 2nd phase constructor is private. Must be called if resource data is not used.
Reimplemented from CEikTextListBox. |
|
|
This method needs to be called to enable extended drawing features such as skinning, pictograph drawing and marquee text in the listbox draw routine.
Methods This method can be safely called more than once. Item drawer must be created before calling this method, or a panic is raised.
|
|
Enables/disables list stretching. When a list is stretched its second line is moved after the first line. This is intented for devices with a large screen. This feature might be set as default by a product specific flag. Item drawer must be created before calling this method.
|
|
From Handles focus changes. The function emphasizes or de-emphasizes the view as needed, and shows or hides the matcher cursor.
Reimplemented from CEikListBox. |
|
From Gets the list of logical colors used to draw the control.
Reimplemented from CEikTextListBox. |
|
From Handles pointer events.
Reimplemented from CEikTextListBox. Reimplemented in CAknDoubleNumberStyleListBox, CAknDoubleTimeStyleListBox, CAknDouble2GraphicStyleListBox, CAknDouble2LargeStyleListBox, CAknSettingStyleListBox, CAknSinglePopupMenuStyleListBox, CAknSingleGraphicPopupMenuStyleListBox, CAknSingleGraphicBtPopupMenuStyleListBox, CAknSingleHeadingPopupMenuStyleListBox, CAknSingleGraphicHeadingPopupMenuStyleListBox, CAknDoublePopupMenuStyleListBox, CAknSinglePopupSubmenuStyleListBox, CAknDoubleLargeGraphicPopupMenuStyleListBox, CAknDouble2PopupMenuStyleListBox, CAknSingle2GraphicPopupMenuStyleListBox, CAknDoubleGraphicPopupMenuStyleListBox, CAknSetStyleListBox, CAknFormGraphicStyleListBox, CAknFormGraphicWideStyleListBox, CAknPopupSettingList, and CEikSettingsListBox. |
|
From Handles a change to the control's resources.
Reimplemented from CEikTextListBox. Reimplemented in CAknPopupSettingList. |
|
Hides the second row of a double style listbox. This feature is disabled by default.
|
|
Gets list box item drawer.
Reimplemented in CEikSettingsListBox. |
|
From Creates the list box view.
Reimplemented from CEikListBox. Reimplemented in CAknSetStyleListBox, and CEikSettingsListBox. |
|
Gets model class of the list box.
Reimplemented from CEikTextListBox. |
|
From Retrieves an object of the same type as that encapsulated in aId. This function is used to allow controls to ask their owners for access to other objects that they own.
Reimplemented in CAknSetStyleListBox. |
|
Sets icon sizes for visible list box items. |
|
Enable or disable logical to visual reordering in listbox data text drawing. By default, it is enabled. This has any effect only when bidirectional text is rendered.
If you convert text to visual order prior to passing it to the listbox (for example by wrapping text to lines with methods
in
|