C++ default constructor.

Allocates an area of memory for a CListBoxView, and begins its initialisation.

Destructor.

Gets the background colour for this view.

The background colour.

Gets the index of the item at the bottom of this view.

Index of the item at the bottom of this view.

Recalculates the index of the bottom item in the list by using the top item index and the size of the display.

This function is called by the owning list box control when either the size of the list box or the number of items in its model changes.

Recalculates the data width of this list box view from the item width of its list item drawer. This method is called directly by CEikListBox when the list box s size changes or when data is added.

Calculates which item should be selected in order to make a particular item visible. Calling VScrollTo(CalcNewTopItemIndexSoItemIsVisible(idx)), for example, would make the item whose index is idx visible.

The item to be selected.

Clears this view s flags according to a bitmask.

These flags are defined by the nested enum TFlags (below).

Resets the selection state so that there is nothing selected.

panic

EEikPanicListBoxNoSelIndexArray Panics if selection indexes have not been defined for this class.

Resets the anchor index, the active end and the EAnchorExists flag.

By default Symbian 2nd phase constructor is private.

This function completes the initialisation of a default-constructed list box view. The item drawer s graphics context is created on aScreen, and the list item drawer s graphics context is set to this. See CListItemDrawer::SetGc().

Gets the current item s index.

Index number of the current item.

Gets the width of the widest item in the list in pixels.

Data width in pixels.

Deselects an item by index.

panic

EEikPanicListBoxNoSelIndexArray Panics if selection indexes have not been defined for this class.

Deselects range between given indexes.

Disables vertical line drawing.

Draws every visible item into the specified rectangle.

As implemented in CListBoxView, this function's argument is ignored and the internal viewing rectangle is used. See SetViewRect().

panic

EEikPanicListBoxNoModel Panics if the list box model for this class has not been defined.

Not implemented.

Draws the specified item via CListBoxDrawer::DrawItem() if it is visible.

Draws the match cursor in its current screen position if the matcher cursor flag has been set.

This is deprecated and broken and should not be used.

Gets an empty list box text.

Pointer the empty list box text.

Return text currently in the empty list text

Gets this view s flags.

These flags are defined by the nested enum TFlags (below).

List box's flags.

Gets a copy of the array of currently selected items.

panic

EEikPanicListBoxInvalidSelIndexArraySpecified Panics if the given selection index array is not valid.

panic

EEikPanicListBoxNoSelIndexArray Panics if selection indexes have not been defined for this class.

Scrolls horizontally by the specified number of pixels.

Gets the offset of the visible portion of the data from the left margin in pixels.

The horizontal scroll offset in pixels.

Hides the matcher cursor.

Tests if this view is visible.

ETrue if this view is visible. EFalse if this view is not visible or does not exist.

Gets the object used by this list box view to draw its items.

Pointer to the list box item drawer.

Returns item's height. All items have the same height.

Tests whether an item is partially visible. Note that this returns EFalse also when item is fully visible, i.e. the whole item area is inside the list view rectangle.

ETrue if the item is partially visible, EFalse if it's not visible or fully visible.

Tests whether an item is selected.

ETrue if the item is selected.

Tests whether an item is visible.

ETrue if the item is visible.

Gets view offset.

Gets the on-screen position of an item.

Position of the item.

Gets the on-screen size of an item.

As implemented in CListBoxView, all items report the same size. The size returned may be larger than the width of the list box view, but will not be smaller.

Size of the item.

Gets the match cursor s position.

Character position of the match cursor within the current item s string.

Moves the current item cursor in the specified direction. This function is called by CEikListBox in response to user input.

Gets the number of items that will fit into a given rectangle.

The number of items that will fit into the given rectangle.

Tests whether redraw is disabled.

ETrue if redraw is disabled.

Scrolls vertically to make a particular item visible.

ETrue if any scrolling was done, EFalse if no scrolling was necessary.

Selects an item by index.

This function leaves if memory could not be allocated for an extra item in the array of selected items.

panic

EEikPanicListBoxNoSelIndexArray Panics if selection indexes have not been defined for this class.

Selects items between given indexes.

Gets a pointer to the selection list of this view.

Pointer to an array describing the items in the list which are currently selected. The object pointed at is owned by the CListBoxView.

Sets the anchor to the specified item.

Sets the background colour.

Set the index of the current item. This function changes the current item, but does not redraw the list view or update the selection.

panic

EEikPanicListBoxInvalidCurrentItemIndexSpecified Panics if the given index is not valid.

Sets whether items will be drawn dimmed.

The function sets or resets the dim flag.

Disables or enables redraws.

If this flag is set to ETrue, all member functions which draw items will return immediately without drawing anything. Functions which update the internal state of the list box will still work, but nothing will be drawn or updated on the screen.

Sets whether or not items are drawn as emphasised.

The function sets or resets the emphasised flag.

Sets this view s flags according to a bitmask.

These flags are defined by the nested enum TFlags (below).

Sets the horizontal scroll offset in pixels.

Sets the item height.

Set item index directly. For CEikListBox.

Sets the offset for view.

Sets list box backroung text. This text is visible if the list box has no items.

Sets whether the matcher cursor flag to specify whether the match cursor is drawn.

Sets the match cursor s colour.

Sets the match cursor's position.

Sets the painted selection flag.

Sets scrolling state.

Sets the currently selected items of this view from a selection index array.

panic

EEikPanicListBoxInvalidSelIndexArraySpecified Panics if the given selection index array is not valid.

Sets the colour in which to display text.

Sets the item at the top of the view by its index in the list of all items. This function also invokes CalcBottomItemIndex().

panic

EEikPanicListBoxInvalidTopItemIndexSpecified Panics if the given index is not valid.

Sets the area within the list window in which the view can draw itself.

Sets the visibility observer.

Gets the colour in which text is to be displayed.

Current text colour.

Toggles the selection of an item.

panic

EEikPanicListBoxNoSelIndexArray Panics if selection indexes have not been defined for this class.

Gets the index of the item at the top of the view.

The item currently displayed at the top of this list box view.

Updates item selection.

Sets the index of the item to be the top item.

Sets the index of the item to be the top item.

This two argument version returns the area which needs redrawing via aMinRedrawRect&. This function does not perform the redraw.

Moves to the specified item, sets it as the current item and scrolls the display to make the item visible.

Gets the list box s view rectangle.

This list box s view rectangle.

Gets the visible width of the specified rectangle in pixels. This function is called by CListBoxView itself on its own viewing rectangle.

Visible width of aRect.

Converts a pixel position into an item index.

The function returns ETrue and sets aItemIndex to the index of the item whose bounding box contains aPosition. Returns EFalse if no such item exists.

ETrue if there was an item at aPosition.

Cursor movement flags. These describe the cursor movements recognised by MoveCursorL().

List box view flags.

These flags may be combined with a logical OR to get a combination of effects.

Modes for modifying the selection.

Changing the current item of a list box view may also affect which items are selected. The selection mode of such an action describes how (or if) the selection is altered by the action.

Each function of CListBoxView which affects the current item is passed an appropriate selection mode by the calling input handler method of CEikListBox. The mode is varied according to the keyboard modifiers held down by the user, or whether a pointer action was a tap or a sweep.

Note that the behaviour of list box views may vary with the target phone due to the wide range of possible input devices. The following description assumes a phone with a pointer and a keyboard.

The items which are selected within a list box list.