UIQ Technology
 Developer Library

UIQ 3 SDK

UIQ developer portal

FEEDBACK 

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



Location: EIKLBV.H
Link against: eiklbx.lib

Class CListBoxView

Interface status: deprecated6.0

class CListBoxView : public CBase;

Description

List box view.

A list box view displays the list items which are currently visible in a list box. List box views draw each of the items for display using methods defined in their associated list box drawer. Together with its list item drawer, a CListBoxView encapsulates the on-screen appearance of data in a list box.List box views also encapsulate item selection, the current item, and the fundamentals of how the selection and the current item are updated according to user input. Input events themselves are handled by CEikListBox , which calls member functions of CListBoxView appropriately.This class is sufficient for plain list box views, and may be derived from in order to provide more complex list views. Uikon supplies and uses the classes CHierarchicalListBoxView and CSnakingListBoxView , which provide two kinds of indented list views.

Derivation

Members

Defined in CListBoxView:
AllowPartiallyVisibleItems(), AllowVariableHeightItems(), BackColor(), BottomItemIndex(), CListBoxView(), CListBoxView(), CSelectionIndexArray, CalcBottomItemIndex(), CalcDataWidth(), CalcNewTopItemIndexSoItemIsVisible(), ClearFlags(), ClearSelection(), ClearSelectionAnchorAndActiveIndex(), ConstructL(), CurrentItemIndex(), DataWidth(), DataWidthClippedToViewRect(), DeselectItem(), DeselectItem(), Draw(), DrawItem(), DrawMatcherCursor(), EAllowPartiallyVisibleItems, EAllowVariableHeightItems, EAnchorExists, EContiguousSelection, ECursorFirstItem, ECursorLastItem, ECursorNextColumn, ECursorNextItem, ECursorNextPage, ECursorPreviousColumn, ECursorPreviousItem, ECursorPreviousPage, EDataWidthClippedToViewRect, EDeSelect, EDimmed, EDisableRedraw, EDisjointSelection, EEmphasized, EHasMatcherCursor, ENoSelection, EPaintedSelection, ESingleSelection, Flags(), GetSelectionIndexesL(), HScroll(), HScrollOffset(), HideMatcherCursor(), IsVisible(), ItemDrawer(), ItemIsFullyVisible(), ItemIsPartiallyVisible(), ItemIsSelected(), ItemIsVisible(), ItemPos(), ItemSize(), MatcherCursorPos(), MoveCursorL(), NumberOfItemsThatFitInRect(), NumberOfPixelsAboveTopItem(), PixelOffsetBetweenItemTops(), RedrawDisabled(), ScrollToMakeItemVisible(), SelectItemL(), SelectItemL(), SelectRangeL(), SelectionIndexes(), SetAnchor(), SetBackColor(), SetCurrentItemIndex(), SetDataWidthClippedToViewRect(), SetDimmed(), SetDisableRedraw(), SetEmphasized(), SetFlags(), SetHScrollOffset(), SetItemHeight(), SetMatcherCursor(), SetMatcherCursorColor(), SetMatcherCursorPos(), SetPaintedSelection(), SetSelectionIndexesL(), SetTextColor(), SetTopItemIndex(), SetViewRect(), SupportsPartiallyVisibleItems(), SupportsVariableHeightItems(), TCursorMovement, TFlags, TInitialFlags, TSelectionMode, TextColor(), ToggleItemL(), TopItemIndex(), UpdateSelectionL(), VScrollTo(), VScrollTo(), VerticalMoveToItemL(), ViewRect(), VisibleWidth(), XYPosToItemIndex(), iBottomItemIndex, iCurrentItemIndex, iDataWidth, iFlags, iGc, iGroupWin, iHScrollOffset, iItemDrawer, iItemHeight, iModel, iTopItemIndex, iViewRect, iWin, ~CListBoxView()

Inherited from CBase:
Delete(), Extension_(), operator new()


Construction and destruction


CListBoxView()

Interface status: deprecatedInherited from: CListBoxView

protected: IMPORT_C CListBoxView(TUint aInitialFlags);

Description

Protected constructor allowing derived classes to pass TInitialFlags.

Parameters

TUint aInitialFlags


~CListBoxView()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C ~CListBoxView();

Description

Destructor.

The destructor destroys this list box view, its item drawer, its graphics context and its selection list.


CListBoxView()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C CListBoxView();

Description

Default constructor.

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


ConstructL()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C void ConstructL(MListBoxModel *aListBoxModel, CListItemDrawer *aItemDrawer, CWsScreenDevice *aScreen, RWindowGroup *aGroupWin, RWindow *aWsWindow, const TRect &aDisplayArea, TInt aItemHeight);

Description

Second-phase constructor.

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

Parameters

MListBoxModel *aListBoxModel

CListItemDrawer *aItemDrawer

CWsScreenDevice *aScreen

RWindowGroup *aGroupWin

RWindow *aWsWindow

const TRect &aDisplayArea

TInt aItemHeight

[Top]


Member functions


AllowVariableHeightItems()

Interface status: deprecatedInherited from: CListBoxView

protected: IMPORT_C void AllowVariableHeightItems();

Description

Protected function for explicitly allowing variable-height items in "this" list-box.


AllowPartiallyVisibleItems()

Interface status: deprecatedInherited from: CListBoxView

protected: IMPORT_C void AllowPartiallyVisibleItems();

Description

Protected function for explicitly allowing showing partially visible items in "this" list-box.


ViewRect()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TRect ViewRect() const;

Description

Gets the list boxs view rectangle.

Return value

TRect

"TRect" This list box views viewing rectangle.


SetViewRect()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetViewRect(const TRect &aRect);

Description

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

Parameters

const TRect &aRect


NumberOfPixelsAboveTopItem()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TInt NumberOfPixelsAboveTopItem() const;

Description

Returns the number of pixels between the top of the ViewRect and the top of the top item.

Return value

TInt


PixelOffsetBetweenItemTops()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TInt PixelOffsetBetweenItemTops(TInt aItemIndex1, TInt aItemIndex2) const;

Description

Returns the number of pixels between the top of item aItemIndex1 and aItemIndex2. If aItemIndex1is greater than aItemIndex2 then the result returned will be negative. Neither aItemIndex1 nor aItemIndex2 need to be currently visible. Note that NumberOfItems (which is not actually a valid item index as it is one greater than the last item index) can be passed into either parameter.

Parameters

TInt aItemIndex1

TInt aItemIndex2

Return value

TInt


CurrentItemIndex()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TInt CurrentItemIndex() const;

Description

Gets the current items index.

Return value

TInt

"TInt" Index number of the current item.


SetCurrentItemIndex()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetCurrentItemIndex(TInt aItemIndex);

Description

Sets the item at the specified index to be the current item.

The function panics if the specified item index is not valid.

Parameters

TInt aItemIndex


TopItemIndex()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TInt TopItemIndex() const;

Description

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

Return value

TInt

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


SetTopItemIndex()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C void SetTopItemIndex(TInt aItemIndex);

Description

Sets the item at the top of the view by its index in the list of all items.

This function also invokes CalcBottomItemIndex() .

Parameters

TInt aItemIndex


BottomItemIndex()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TInt BottomItemIndex() const;

Description

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

Return value

TInt

"TInt" Index of the item at the bottom of this view.


CalcBottomItemIndex()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C void CalcBottomItemIndex();

Description

Recalculates the index of the bottom item in the list from 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.


SetItemHeight()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C void SetItemHeight(TInt aItemHeight);

Description

Sets the item height.

Parameters

TInt aItemHeight


SetMatcherCursorColor()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetMatcherCursorColor(TRgb aColor);

Description

Sets the match cursors colour.

Parameters

TRgb aColor


SetMatcherCursorPos()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetMatcherCursorPos(TInt aPosWithinCurrentItem);

Description

Sets the match cursors position.

Parameters

TInt aPosWithinCurrentItem


MatcherCursorPos()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TInt MatcherCursorPos() const;

Description

Gets the match cursors position.

Return value

TInt

"TInt" Character position of the match cursor within the current items string.


DrawMatcherCursor()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void DrawMatcherCursor();

Description

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


HideMatcherCursor()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void HideMatcherCursor();

Description

Hides the match cursor.


SetMatcherCursor()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetMatcherCursor(TBool aMatcherCursor);

Description

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

Parameters

TBool aMatcherCursor


SetEmphasized()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetEmphasized(TBool aEmphasized);

Description

Sets whether or not items are drawn emphasised.

The function sets or resets the emphasised flag.

Parameters

TBool aEmphasized


SetDimmed()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetDimmed(TBool aDimmed);

Description

Sets whether or not items will be drawn dimmed.

The function sets or resets the dim flag.

Parameters

TBool aDimmed


SetDisableRedraw()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetDisableRedraw(TBool aDisableRedraw);

Description

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.

Parameters

TBool aDisableRedraw


RedrawDisabled()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TBool RedrawDisabled() const;

Description

Tests whether redraw is disabled.

Return value

TBool

"TBool" ETrue if redraw is disabled.


SetPaintedSelection()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetPaintedSelection(TBool aPaintedSelection);

Description

Sets the painted selection flag.

Parameters

TBool aPaintedSelection


SelectionIndexes()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C const CSelectionIndexArray *SelectionIndexes() const;

Description

Gets a pointer to the selection list of this view.

Return value

const CSelectionIndexArray *

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


GetSelectionIndexesL()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void GetSelectionIndexesL(CSelectionIndexArray *aSelectionArray) const;

Description

Gets a copy of the array of currently selected items.

Parameters

CSelectionIndexArray *aSelectionArray


SetSelectionIndexesL()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetSelectionIndexesL(const CSelectionIndexArray *aSelectionIndexes);

Description

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

Parameters

const CSelectionIndexArray *aSelectionIndexes


ClearSelection()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void ClearSelection();

Description

Resets the selection state so that there is nothing selected.


UpdateSelectionL()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C void UpdateSelectionL(TSelectionMode aSelectionMode);

Description

Updates item selection.

Parameters

TSelectionMode aSelectionMode


ToggleItemL()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void ToggleItemL(TInt aItemIndex);

Description

Toggles the selection of an item.

Parameters

TInt aItemIndex


SelectItemL()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SelectItemL(TInt aItemIndex);

Description

Selects an item by index.

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

Parameters

TInt aItemIndex


SelectItemL()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SelectItemL(TInt aItemIndex, TBool aReportSelectionChanged);

Description

Selects an item by index.

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

Parameters

TInt aItemIndex

TBool aReportSelectionChanged


DeselectItem()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void DeselectItem(TInt aItemIndex);

Description

Deselects an item by index.

Parameters

TInt aItemIndex


DeselectItem()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void DeselectItem(TInt aItemIndex, TBool aReportSelectionChanged);

Description

Deselects an item by index.

Parameters

TInt aItemIndex

TBool aReportSelectionChanged


SetAnchor()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetAnchor(TInt aItemIndex);

Description

Sets the anchor to the specified item.

Parameters

TInt aItemIndex


ClearSelectionAnchorAndActiveIndex()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void ClearSelectionAnchorAndActiveIndex();

Description

Sets the anchor index and active end index to NULL , clears the EAnchorExists flag.


ScrollToMakeItemVisible()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C TBool ScrollToMakeItemVisible(TInt aItemIndex);

Description

Scrolls vertically to make a particular item visible.

Parameters

TInt aItemIndex

Return value

TBool

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


VScrollTo()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C void VScrollTo(TInt aNewTopItemIndex);

Description

Scroll vertically to the specified item.

Scrolls the contents of this list view so that the specified item is the top item, and redraws the view.

Parameters

TInt aNewTopItemIndex


VScrollTo()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C void VScrollTo(TInt aNewTopItemIndex, TRect &aMinRedrawRect);

Description

Scroll vertically to the specified item and get the minimum rectangle to redraw.

Scrolls the contents of this list view so that the specified item is the top item, and redraws the view.This two argument version returns the area which needs redrawing via aMinRedrawRect& .

Parameters

TInt aNewTopItemIndex

TRect &aMinRedrawRect


HScroll()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C void HScroll(TInt aHScrollAmount);

Description

Scrolls horizontally by the specified number of pixels.

Parameters

TInt aHScrollAmount


HScrollOffset()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TInt HScrollOffset() const;

Description

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

Return value

TInt

"TInt" The horizontal scroll offset in pixels.


SetHScrollOffset()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetHScrollOffset(TInt aHorizontalOffset);

Description

Sets the horizontal scroll offset in pixels.

Parameters

TInt aHorizontalOffset


DataWidth()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TInt DataWidth() const;

Description

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

Return value

TInt

"TInt" Data width in pixels.


CalcDataWidth()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C void CalcDataWidth();

Description

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 boxs size changes or when data is added.


VisibleWidth()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C TInt VisibleWidth(const TRect &aRect) const;

Description

Gets the visible width of the specified rectangle in pixels.

This function is called by CListBoxView itself on its own viewing rectangle.

Parameters

const TRect &aRect

Return value

TInt

"TInt" Visible width of aRect .


CalcNewTopItemIndexSoItemIsVisible()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C TInt CalcNewTopItemIndexSoItemIsVisible(TInt aItemIndex) const;

Description

Calculates which item should be scrolled to in order to make a particular item visible.

Calling VScrollTo(CalcNewTopItemIndexSoItemIsVisible(idx)) , for example, would make the item whose index is idx visible.

Parameters

TInt aItemIndex

Return value

TInt

"TInt" The item to scroll to.


Draw()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C void Draw(const TRect *aClipRect=0) const;

Description

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() .

Parameters

const TRect *aClipRect


DrawItem()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C void DrawItem(TInt aItemIndex) const;

Description

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

Parameters

TInt aItemIndex


ItemIsSelected()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TBool ItemIsSelected(TInt aItemIndex) const;

Description

Tests whether an item is selected.

Parameters

TInt aItemIndex

Return value

TBool

"TBool" ETrue if the item is selected.


ItemIsVisible()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TBool ItemIsVisible(TInt aItemIndex) const;

Description

Tests whether an item is visible.

Parameters

TInt aItemIndex

Return value

TBool

"TBool" ETrue if the item is visible.


ItemIsFullyVisible()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TBool ItemIsFullyVisible(TInt aItemIndex) const;

Description

Returns whether an item is fully visible or not.

Parameters

TInt aItemIndex

Return value

TBool


ItemIsPartiallyVisible()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TBool ItemIsPartiallyVisible(TInt aItemIndex) const;

Description

Returns whether an item is partially visible or not. (Note, this returns "false" if the item at aItemIndex is fully visible.)

Parameters

TInt aItemIndex

Return value

TBool


ItemPos()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C TPoint ItemPos(TInt aItemIndex) const;

Description

Gets the on-screen position of an item.

Parameters

TInt aItemIndex

Return value

TPoint

"TPoint" Position of the item.


ItemSize()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C TSize ItemSize(TInt aItemIndex=0) const;

Description

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.

Parameters

TInt aItemIndex

Return value

TSize

"TSize" Size of the item.


SetTextColor()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetTextColor(TRgb aColor);

Description

Sets the colour in which to display text.

Parameters

TRgb aColor


SetBackColor()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetBackColor(TRgb aColor);

Description

Sets the background colour.

Parameters

TRgb aColor


TextColor()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TRgb TextColor() const;

Description

Gets the colour in which text is to be displayed.

Return value

TRgb

"TRgb" Current text colour.


BackColor()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TRgb BackColor() const;

Description

Gets the background colour for this view.

Return value

TRgb

"TRgb" The background colour.


MoveCursorL()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C void MoveCursorL(TCursorMovement aCursorMovement, TSelectionMode aSelectionMode);

Description

Moves the current item cursor in the specified direction.

This function is called by CEikListBox in response to user input.

Parameters

TCursorMovement aCursorMovement

TSelectionMode aSelectionMode


VerticalMoveToItemL()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C void VerticalMoveToItemL(TInt aTargetItemIndex, TSelectionMode aSelectionMode);

Description

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

Parameters

TInt aTargetItemIndex

TSelectionMode aSelectionMode


XYPosToItemIndex()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C TBool XYPosToItemIndex(TPoint aPosition, TInt &aItemIndex) const;

Description

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.

Parameters

TPoint aPosition

TInt &aItemIndex

Return value

TBool

"TBool" Whether there was an item at aPosition .


NumberOfItemsThatFitInRect()

Interface status: deprecatedInherited from: CListBoxView

virtual IMPORT_C TInt NumberOfItemsThatFitInRect(const TRect &aRect) const;

Description

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

Parameters

const TRect &aRect

Return value

TInt

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


IsVisible()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TBool IsVisible() const;

Description

Tests if this view is visible.

Return value

TBool

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


ItemDrawer()

Interface status: deprecatedInherited from: CListBoxView

inline CListItemDrawer *ItemDrawer() const;

Description

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

Return value

CListItemDrawer *

"CListItemDrawer*" Pointer to the list box viewer.


SupportsVariableHeightItems()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TBool SupportsVariableHeightItems() const;

Description

Returns whether variable-height items have been explicitly allowed on this "list"-box.

Return value

TBool


SupportsPartiallyVisibleItems()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TBool SupportsPartiallyVisibleItems() const;

Description

Returns whether showing partially visible items has been explicitly allowed on this "list"-box.

Return value

TBool


SetDataWidthClippedToViewRect()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C void SetDataWidthClippedToViewRect(TBool aIsClipped);

Description

Sets flag which allows the view to handle the fact that it's text may have been truncated to fit within the bounds of the view rect.

Parameters

TBool aIsClipped


DataWidthClippedToViewRect()

Interface status: deprecatedInherited from: CListBoxView

IMPORT_C TBool DataWidthClippedToViewRect() const;

Description

Returns boolean informing client whether or not the text has been truncated to fit within the bounds of the list's view rect, so as special handling can be done (for example the addition of an ellipsis).

Return value

TBool


Flags()

Interface status: deprecatedInherited from: CListBoxView

protected: inline TInt Flags() const;

Description

Gets this views flags.

Return value

TInt

"TInt" An OR-ed combination of TFlags .


SetFlags()

Interface status: deprecatedInherited from: CListBoxView

protected: inline void SetFlags(TInt aMask);

Description

Sets this views flags according to a bitmask.

Parameters

TInt aMask


ClearFlags()

Interface status: deprecatedInherited from: CListBoxView

protected: inline void ClearFlags(TInt aMask);

Description

Clears this views flags according to a bitmask.

Parameters

TInt aMask


SelectRangeL()

Interface status: deprecatedInherited from: CListBoxView

protected: IMPORT_C void SelectRangeL(TInt aItemIndex1, TInt aItemIndex2);

Description

Selects all items in the list between the two specified indices, inclusively.

Parameters

TInt aItemIndex1

TInt aItemIndex2

[Top]


Member enumerations


Enum TCursorMovement

Interface status: deprecatedInherited from: CListBoxView

TCursorMovement

Description

Cursor movement flags.

These describe the cursor movements recognised by MoveCursorL() .

ECursorNextItem

ECursorPreviousItem

Next item.

ECursorNextColumn

Previous item.

ECursorPreviousColumn

Next column.

ECursorPreviousPage

Previous. column.

ECursorNextPage

Previous page.

ECursorFirstItem

Next page.

ECursorLastItem

To the last item.


Enum TFlags

Interface status: deprecatedInherited from: CListBoxView

TFlags

Description

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

EAnchorExists

EEmphasized

A selection anchor exists.

EDimmed

The view is emphasised.

EHasMatcherCursor

The view is dimmed.

EDisableRedraw

List box view has a cursor for incremental matching.

EPaintedSelection

Redraw is disabled.

EDataWidthClippedToViewRect


Enum TSelectionMode

Interface status: deprecatedInherited from: CListBoxView

TSelectionMode

Description

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 platform due to the wide range of possible input devices. The following description assumes a device with a pointer and a keyboard.

ENoSelection

The selection is not changed by actions while this is in effect, holding CTRL while pressing cursor up or down for example.

ESingleSelection

Only a single item in the list is allowed to be selected by an action; when selecting individual items with the pointer, or moving using the cursor keys without any modifiers for example.

EContiguousSelection

A single continuous run of items can be added to the selection array by an action, when keyboard-selecting with the shift key held down, or when sweeping a selection with the pointer for example.

EDisjointSelection

Any single item in the list may be added to the selection by an action, when selecting or drag-selecting with the pointer when the CTRL key is held down for example.