class CEikSnakingListBox : public CEikListBox |
This is a list box that scrolls horizontally, displaying its items in as many vertical columns as needed. Columns are arranged across the control from left to right; within columns, items are arranged from top to bottom. The flow of items or text ?snakes? across the face of the control.
This is a flexible control class that makes good use of short, wide display areas; for instance, subclasses of CEikSnakingListBox could be used for file lists or for a control panel. A standard user subclass, CEikSnakingTextListBox, also exists.
Public Member Functions | |
---|---|
CEikSnakingListBox() | |
~CEikSnakingListBox() | |
IMPORT_C TInt | ColumnWidth() |
IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
IMPORT_C CListBoxView * | MakeViewClassInstanceL() |
IMPORT_C void | SetColumnWidth(TInt) |
IMPORT_C void | SetTopItemIndex(TInt) |
Protected Member Functions | |
---|---|
IMPORT_C TInt | AdjustRectHeightToWholeNumberOfItems(TRect &) |
IMPORT_C void | AdjustTopItemIndex() |
IMPORT_C void | GetColorUseListL(CArrayFix< TCoeColorUse > &) |
IMPORT_C void | HandleDragEventL(TPoint) |
IMPORT_C void | HandleLeftArrowKeyL(CListBoxView::TSelectionMode) |
IMPORT_C void | HandleResourceChange(TInt) |
IMPORT_C void | HandleRightArrowKeyL(CListBoxView::TSelectionMode) |
IMPORT_C void | HandleViewRectSizeChangeL() |
IMPORT_C TInt | HorizScrollGranularityInPixels() |
IMPORT_C TInt | HorizontalNudgeValue() |
IMPORT_C void | MoveToNextOrPreviousItemL(TPoint) |
IMPORT_C void | RestoreClientRectFromViewRect(TRect &) |
IMPORT_C void | SizeChanged() |
Private Member Functions | |
---|---|
IMPORT_C void | CEikListBox_Reserved() |
IMPORT_C void * | ExtensionInterface(TUid) |
IMPORT_C void | Reserved_1() |
IMPORT_C void | Reserved_2() |
Inherited Enumerations | |
---|---|
CCoeControl:TZoomType | |
CEikListBox:@162 | |
CEikListBox:TFlags | |
CEikListBox:TReasonForFocusLost | |
CEikListBox:TScrollBarOwnerShip |
IMPORT_C TInt | AdjustRectHeightToWholeNumberOfItems | ( | TRect & | aRect | ) | const [protected, virtual] |
Rounds down the height of the rectangle (if necessary) so that only a whole number of items can be displayed inside the list box.
TRect & aRect | The rectangle to be modified. |
IMPORT_C void | AdjustTopItemIndex | ( | ) | const [protected, virtual] |
Called by various functions of this class to ensure that the top item index is always a sane value. The implementation in CEikListBox tries to ensure the minimum amount of white space at the bottom of the list box. Note that this function does not affect the current item index.
IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
From CAknControl
TUid aInterface |
IMPORT_C void | GetColorUseListL | ( | CArrayFix< TCoeColorUse > & | aColorUseList | ) | const [protected, virtual] |
From CCoeControl
Gets the list of logical colours employed in the drawing of the control, paired with an explanation of how they are used. Appends the list to aColorUseList.
Gets the list of logical colors employed in the drawing of the control, paired with an explanation of how they are used. Appends the list to aColorUseList.
CArrayFix< TCoeColorUse > & aColorUseList | List of logical colours. |
IMPORT_C void | HandleDragEventL | ( | TPoint | aPointerPos | ) | [protected, virtual] |
Handles drag events.
This function is called by HandlePointerEventL() to handle pointer drag events appropriately.
TPoint aPointerPos | The position of the TPointerEvent for which this handler is invoked. |
IMPORT_C void | HandleLeftArrowKeyL | ( | CListBoxView::TSelectionMode | aSelectionMode | ) | [protected, virtual] |
Handles a left arrow key event.
Moves the cursor into the correct column and clears any matcher buffer that may have been built up.
CListBoxView::TSelectionMode aSelectionMode | Not used. |
IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
From CCoeControl.
Handles pointer events.
const TPointerEvent & aPointerEvent | The pointer event. |
IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [protected, virtual] |
From CCoeControl.
Handles a change to the list box?s resources of type aType which are shared across the environment, colours or fonts for example.
Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.
TInt aType | The type of resources that have changed. |
IMPORT_C void | HandleRightArrowKeyL | ( | CListBoxView::TSelectionMode | aSelectionMode | ) | [protected, virtual] |
Handles a right arrow key event.
Moves the cursor into the correct column and clears any matcher buffer that may have been built up.
CListBoxView::TSelectionMode aSelectionMode | Not used. |
IMPORT_C void | HandleViewRectSizeChangeL | ( | ) | [protected, virtual] |
Handles a change in size of the viewing rectangle.
This function is called by framework functions to update the content, view, and scroll bars of this list box after the viewing rectangle has changed size. This implementation ensures that the current item is visible after a resize.
IMPORT_C TInt | HorizScrollGranularityInPixels | ( | ) | const [protected, virtual] |
Gets the granularity for horizontal scrolls.
The granularity is the minimum size of a horizontal move of the client area.
IMPORT_C TInt | HorizontalNudgeValue | ( | ) | const [protected, virtual] |
Gets the number of grains to move horizontally when a nudge button is tapped.
For simple list boxes, this value is a fraction of the width of the client area.
IMPORT_C CListBoxView * | MakeViewClassInstanceL | ( | ) | [virtual] |
Creates an instance of the view class.
This function is called during construction to create (but not second-phase construct) an instance of the correct view class for this list box control. In the case of the snaking list box, a CSnakingListBoxView is returned.
This function overrides CEikListBox::MakeViewClassInstanceL().
IMPORT_C void | MoveToNextOrPreviousItemL | ( | TPoint | aPoint | ) | [protected] |
Move to next or previous item according to the given parameter.
TPoint aPoint | Position which defines the moving direction. |
IMPORT_C void | RestoreClientRectFromViewRect | ( | TRect & | aClientRect | ) | const [protected, virtual] |
Calculates the client area.
This method is called by various functions of this class to recalculate the extent of the client area from iViewRect. This implementation takes into account any rounding of the viewing rectangle made to fit a whole number of items.
TRect & aClientRect | On return contains a size for the client area in pixels. |
IMPORT_C void | SetColumnWidth | ( | TInt | aColumnWidth | ) |
Sets the width of all columns in the list box.
TInt aColumnWidth | New column width. |
IMPORT_C void | SetTopItemIndex | ( | TInt | aItemIndex | ) | const [virtual] |
Sets the top item?s index.
TInt aItemIndex | Index of the item to set as the top item. |
IMPORT_C void | SizeChanged | ( | ) | [protected, virtual] |
From CCoeControl
Updates the viewing rectangle of this control appropriately. The function updates the viewing rectangle, and invokes HandleViewRectSizeChangeL().
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.