UIQ Technology
Symbian OS Library

UIQ 3.1 SDK        UIQ developer portal

[Index] [Spacer] [Previous] [Next]



Listbox


CQikListBox

Primary API for access to the graphical listbox control. All data is transparently stored in a model, hiding the complexity for simple usage of the listbox. More advanced users with great amounts of data will have to create their own model since the basic standard model is optimized for small amounts of data. A custom model must inherit from MQikListBoxModel. The listbox uses two standard views to draw the listbox content in a row listbox or grid listbox, it is designed to allow custom implementations of any type of view as well. Runtime view switching is supported but the listbox can only have one view at the time, the application needs to implement it's own list of views if needed. Each data entry is presented as an item in the view, each item can have two different layouts attached, that draws the item differently depending on if it is highlighted or not. I.e. fisheye. In the common case all items will use the same layouts but it is possible to set different layouts for each item as well. An ornament can be used for adding additional graphical effects for each layout. The user of a listbox might want to have a different string for the select command, such as view, choose, or edit.

Control

How to guide

Class reference

Resource reference

Introductionary guide

Features guide

Custom Layouts guide

Standard Layouts listing

CQikListBox

QIK_LISTBOX

QIK_LISTBOX_LAYOUT

Standard Layouts listing

EQikListBoxLine

Standard Layouts listing

EQikListBoxIconLine

Standard Layouts listing

EQikListBoxLineIcon

Standard Layouts listing

EQikListBoxIconLineIcon

Standard Layouts listing

EQikListBoxIconIconLine

Standard Layouts listing

EQikListBoxLineIconIcon

Standard Layouts listing

EQikListBoxLineIconIcon

Standard Layouts listing

EQikListBoxIconHalfLineHalfLine

Standard Layouts listing

EQikListBoxIconHalfLineHalfLineLine

Standard Layouts listing

EQikListBoxCheckLineSwappingLine

Standard Layouts listing

EQikListBoxIconIconTwoLines

Standard Layouts listing

EQikListBoxTwoLines

Standard Layouts listing

EQikListBoxIconTwoLines

Standard Layouts listing

EQikListBoxMediumThumbTwoLines

Standard Layouts listing

EQikListBoxMediumIconTwoLines

[Top]


CQikListBoxColumn

Representation of a column in a CQikListBox.

Class reference

CQikListBoxColumn

[Top]


CQikListBoxData

A concrete implementation of CQikListBoxDataBase, acting as a container for list box data. Data can be one or more texts and/or images. Added data is assigned to slots that specify where in a layout the data should be shown. The data objects themselves are not displayed in the list box view. Instead the list box uses an item (CQikListBoxItem ) as visual representation of a data object.

Class reference

CQikListBoxData

[Top]


CQikListBoxDataBase

This is a concrete implementation of MQikListBoxData, acting as a container class for list box data.

Class reference

CQikListBoxDataBase

[Top]


CQikListBoxGridView

Grid ListBox specific view. The view is created internally by the listbox but can also be created externally. The grid view structures items in a grid of equally sized cells. The number of column and rows can be set to change the grid size. If there are more items that fit in a single view frame a scrollbar can be used. This view support either vertical or horizontal scrollbar. Horizontal scrollbar allows for horizontal scrolling of the view, i.e the view is scrolled sideways something that might be useful in landscape UI mode. Layouts used should not be row aware but instead be dynamic in filling both width and height of the cell, this way a change in cell size (change in grid size) will allow for automatic recalculation of the items size to fit the new cell size.

Class reference

CQikListBoxGridView

[Top]


CQikListBoxItem

A ListBox item is a visual representaion of a data object. Container for a listbox item.

Class reference

CQikListBoxItem

[Top]


CQikListBoxItemArray

Support class for the listbox views. Takes care of the items, the item cache, and a number of indexes.

Class reference

CQikListBoxItemArray

[Top]


CQikListBoxLayout

Support class for the listbox views. Takes care of the items, the item cache, and a number of indexes.

Class reference

CQikListBoxLayout

[Top]


CQikListBoxLayoutElement

Base class for CQikListBoxColumn and CQikListBoxRow.

Class reference

CQikListBoxLayoutElement

[Top]


CQikListBoxLayoutPair

Creator and/or container for one or two CQikListBoxLayout s. A pair contains of at least one layout, a normal layout and an optional highlight layout. The CQikListBoxLayout can either be supplied upon construction or read from a resource file.

Class reference

CQikListBoxLayoutPair

[Top]


CQikListBoxModel

Creator and/or container for one or two CQikListBoxLayout´s. A pair contains of at least one layout, a normal layout and an optional highlight layout. The CQikListBoxLayout´s can either be supplied upon construction or read from a resource file.

Class reference

CQikListBoxModel

[Top]


CQikListBoxRow

Representation of a row in a CQikListBox.

Class reference

CQikListBoxRow

[Top]


CQikListBoxRowView

Row based ListBox specific view. The items get their layout by the CQikListBoxLayoutPairs. The view is created internally by the listbox but can also be created externally.

Class reference

CQikListBoxRowView

[Top]


CQikListBoxViewBase

This is the base class for CQikListBoxRowView and CQikListBoxGridView . It handles generic view functionality common for both views. Custom views must inherit from this class.

Class reference

CQikListBoxViewBase

[Top]


CQikPopoutListBox

This class owns a CQikListBox and can be used where a listbox should float in a popup over an application.

Class reference

CQikPopoutListBox

[Top]


MQikListBoxData

A concrete implementation of CQikListBoxDataBase , acting as a container for list box data. Data can be one or more texts and/or images. Added data is assigned to slots that specify where in a layout the data should be shown. The data objects themselves are not displayed in the list box view. Instead the list box uses an item (CQikListBoxItem ) as visual representation of a data object.

Class reference

MQikListBoxData

[Top]


MQikListBoxLayoutRects

Interface used for queries of the rect sizes of the slots of a List Box item. The interface provided by the MQikListBoxLayoutRects class is to be used by the class implementing the MQikListBoxLayoutOrnament interface. The MQikListBoxLayoutRects inteface is implemented by the CQikListBoxLayout class. This inteface is provided by the CQikListBoxLayout class when it calls the methods MQikListBoxLayoutOrnament::DrawBehind() and MQikListBoxLayoutOrnament::DrawOnTop() of the added List Box item ornament. In this way the ornament can get the rect size of the specific slot being drawn.

Class reference

MQikListBoxLayoutRects

[Top]


MQikListBoxModel

Interface used for queries of the rect sizes of the slots of a List Box item. The interface provided by the MQikListBoxLayoutRects class is to be used by the class implementing the MQikListBoxLayoutOrnament interface. The MQikListBoxLayoutRects inteface is implemented by the CQikListBoxLayout class. This inteface is provided by the CQikListBoxLayout class when it calls the methods MQikListBoxLayoutOrnament::DrawBehind() and MQikListBoxLayoutOrnament::DrawOnTop() of the added List Box item ornament. In this way the ornament can get the rect size of the specific slot being drawn.

Class reference

MQikListBoxModel

[Top]


MQikListBoxModelObserver

The MQikListBoxModelObserver class is used by MQikListBoxModel for notifying about changes in the data in order to update the selection array.

Class reference

MQikListBoxModelObserver

[Top]


MQikListBoxObserver

List box observer interface. Each list box observer may be registered with a number of list boxes; each of these send events to the list box observer through its HandeListBoxEventL() method.

Class reference

MQikListBoxObserver