CEikListBox Class Reference

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Enumerator:

KEikMaxMatchingBufferLength

Construction flags.

Enumerator:

EMultipleSelection	Construction flag for a list box from which the user can select multiple items.
ENoExtendedSelection	Construction flag for disabling extended selection. If this is set the user cannot select multiple items by using SHIFT button.
EIncrementalMatching	Construction flag that sets the list box to match user’s keystrokes incrementally.
EPopout	Construction flag for setting the list box as a pop-out list box. Pop-out list boxes handle certain keystrokes and events differently.
ELeftDownInViewRect	Construction flag that enables the indication of pointer press inside the view of the list box.
EItemDoubleClicked	Construction flag for enabling CEiklist box item double click indication.
EKeepModel	Construction flag for removing the ownership of the supplied list box model from the CEikListBox so that the list box model will not be deleted with the CEikListBoxes destruction.
EScrollBarSizeExcluded	Construction flag for excluding the scroll bar. If the flag is set the scroll bas is drawn ouside the window that describes the scroll bars extent.
EStateChanged	Construction flag for enabling CEikListBox change indication.
ECreateOwnWindow	Construction flag that indicates that the list box should be created to its own window.
ENoFirstLetterMatching	Construction flag for disabling key matching.
EPaintedSelection	Construction flag for enabling painting of selected items.
ELoopScrolling	Construction flag for enabling loop scrolling in which the list box jumps from the last item to the first item.
EEnterMarks	Construction flag for enabling Avkon multiselection list.
EShiftEnterMarks	Construction flag for enabling Avkon markable list which enables the marking of several items from the list.
EViewerFlag	Construction flag that combines EPageAtOnceScrolling and EDisableHighlight flags.
EPageAtOnceScrolling	Construction flag for enabling scrolling at a page per time so that the whole list box page is scrolled to the next.
EDisableHighlight	Construction flag for disabling the highlighting of the selected item.
ES60StyleMultiselection	Construction flag for enabling S60 style selection of multiple items from the list box.
ES60StyleMarkable	Construction flag for enabling S60 style markable items.

Used for indicating the reason why the item lost focus.

Enumerator:

EFocusLostToExternalControl	Focus has been lost from the list box to an external control.
EFocusLostToInternalEditor	Focus has been moved from the list box to an internal editor.

Indicates who owns the scroll bar.

Enumerator:

ENotOwnedExternally	Indicates that the scrollbar is not owned by an external class.
EOwnedExternally	Indicates that the scrollbar is owned by an external class.

Destructor.

C++ default constructor.

From CCoeControl.

Sets the control as ready to be drawn.

The application should call this function on all controls that are not components in a compound control.

The purpose of this function is that controls are not always ready to be drawn as soon as they have been constructed. For example, it may not be possible to set the control's extent during construction, but its extent should always be set before it is drawn. Similarly, if a control is to be made invisible, this should be done before it is activated.

The default implementation sets a flag in the control to indicate it is ready to be drawn. If the control is a compound control, the default implementation also calls ActivateL() for all the control's components. To get the control's components it uses CountComponentControls() and ComponentControl(), which should be implemented by the compound control.

ActivateL() is typically called from the control's ConstructL() function.

Notes:

This function can be overridden. This is useful for doing late initialisation of the control, using information that was not available at the time the control was created. For example, a text editor might override ActivateL() and use it to enquire whether it is focused: if it is, it makes the cursor and any highlighting visible. At the time when the editor is created, it doesn't know whether or not it has keyboard focus.

If overriding ActivateL(), the implementation must include a base call to CCoeControl's ActivateL().

Adds an item change observer to the listbox.

Duplicates are not checked (i.e. adding the same observer multiple times is not prevented).

Parameters:

aObserver

Must be non-NULL.

Adds a selection (item marking) observer to the listbox.

Duplicates are not checked (i.e. adding the same observer multiple times is not prevented).

Parameters:

aObserver

Must be non-NULL.

Rounds down the height of the rectangle (if necessary) so that only a whole number of items can be displayed inside the list box.

Parameters:

aRect

The rectangle to be modified.

Returns:

The number of pixels reduced.

Reimplemented in CAknGrid, CAknColumnListBox, CAknFormGraphicStyleListBox, CEikFormattedCellListBox, and CEikSnakingListBox.

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.

Reimplemented in CAknGrid, and CEikSnakingListBox.

Gets the background colour.

Returns:

The background colour.

Gets for the bottom items index.

Returns:

Index for the bottom item.

Gets the list box match buffer.

Returns:

The list box match buffer.

Gets the height of the list box in pixels based on the width of the list box in characters.

Returns the number of items times the height of the font in pixels.

Parameters:

aNumOfItems

The number of items.

Returns:

The height of the list box in pixels.

Gets the size of the list box in pixels based on the height of the list box in items and the length of the items in characters.

Returns TSize element consisting of two elements, the height and the width. Height is the number of items times the height of the font in pixels. Width is the number of characters in a single line times the width of the font in pixels.

Parameters:

	aWidthAsNumOfChars	Width of list box in characters.
	aHeightAsNumOfItems	Height of list box in characters.

Returns:

The size of the list box in pixels as TSize.

Gets the size of the rectangle required to display a pop out.

Parameters:

	aTargetItemIndex	The item from which the popout originates.
	aTargetYPos	Vertical position of the item from which the popout originates.
	aListBoxRect	The list box rectangle.
	aMinHeightInNumOfItems	The minimum number of items for the popout.

Gets the width of the list box in pixels based on the width of the list box in characters.

Returns the number of characters times the width of a character in pixels.

Parameters:

aNumOfChars

The number of characters.

Returns:

The width of the list box in pixels.

Gets the width of the list box in pixels based on the width of the list box text in pixels.

returns the width of the whole list box in pixels, which includes the text width and the width of elements in the list box that have an effect on the overall width.

Parameters:

aTextWidthInPixels

Width of list box text in pixels.

Returns:

Required width of whole list box in pixels.

This switches listbox into selection mode.

Basicly only changes MSK and informs selection observers about the change.

Parameters:

aEnable

ETrue when entering into selection mode, EFalse when leaving

Checks the list box match buffer exists.

If a buffer does not exist, one is created.

Checks for a list box extension.

Creates one if not present.

Returns:

ETrue if a list box extension already existed or if there was no previous extension and a new extension class was created successfully. EFalse if there was no previous extension and a new one could not be constructed.

Checks for a list box extension.

Attempts to create one if not present.

This function leaves if an extension cannot be created.

Clears the list box margins.

The list box is redrawn only if redraws are enabled for the list box view.

Empties the match buffer .

Clears the selection from the view.

Gets an indexed component of a compound control.

There are two ways to implement a compound control. One way is to override this function. The other way is to use the CCoeControlArray functionality (see the InitComponentArrayL method).

Note: Within a compound control each component control is identified by an index, where the index depends on the order the controls were added: the first is given an index of 0, the next an index of 1, and so on.

Parameters:

aIndex

The index of the control.

Returns:

The component control with an index of aIndex.

Reimplemented in AknListBoxLinesTemplate< CEikSettingsListBox >, AknListBoxLinesTemplate< CAknColumnListBox >, and AknListBoxLinesTemplate< CEikFormattedCellListBox >.

Second-phase constructor.

This protected form is overridden non-virtually by the second-phase constructors of each subclass, and should be invoked by them using CEikListBox::ConstructL().

Parameters:

	aParent	The parent control. May be NULL.
	aFlags	Construction flags.

Reimplemented in CAknGrid, CEikColumnListBox, CEikFormattedCellListBox, CEikTextListBox, and CEikSnakingTextListBox.

Handles 2nd phase construction.

Sets the border that is to be drawn outside the list box. Request another ConstructL to handle list box model, list item drawer, aParent and aFlags.

Parameters:

	aListBoxModel	List box model that is to be used with the list box.
	aListItemDrawer	List item drawer that is to be used with the list box.
	aParent	Host CoeControl for the list box.
	aBorder	Border to be drawn outside the list box.
	aFlags	Construction flags (TFlags) for the list box.

Handles 2nd phase construction.

Sets list box model and list item drawer. Request another ConstructL to handle aParent and aFlags.

Parameters:

	aListBoxModel	List box model that is to be used with the list box.
	aListItemDrawer	List item drawer that is to be used with the list box.
	aParent	Host CoeControl for the list box.
	aFlags	Construction flags (TFlags) for the list box.

Gets the number of controls contained in a compound control.

There are two ways to implement a compound control. One way is to override this function. The other way is to use the CCoeControlArray functionality (see the InitComponentArrayL method).

Returns:

The number of component controls contained by this control.

Reimplemented in CAknGrid, AknListBoxLinesTemplate< CEikSettingsListBox >, AknListBoxLinesTemplate< CAknColumnListBox >, and AknListBoxLinesTemplate< CEikFormattedCellListBox >.

Creates a buffer for checking how well two strings match up.

Creates a scrollbar for the listbox.

The caller may choose if the scrollbar is requested remotely via the mop chain from parent control

Parameters:

	aPreAlloc	Is the scrollbar created immediately or when taking in to use
	aRemote	If True, the scrollbar is obtained via mop-chain from parent control. If used, the listbox only sets the scrollbar values. The scrollbar position and size must set in the parent control's code.
	aWindowOwning	Does the created scrollbar create own window or is it compound control. The listbox uses a window owning scrollbar by default.

Returns:

CEikScrollBarFrame* pointer to scrollbar frame object

Creates a scrollbar for the listbox.

The caller may choose if the scrollbar is requested remotely via the mop chain from parent control

Parameters:

	aPreAlloc	Is the scrollbar created immediately or when taking in to use
	aRemote	If True, the scrollbar is obtained via mop-chain from parent control. If used, the listbox only sets the scrollbar values. The scrollbar position and size must set in the parent control's code.

Returns:

CEikScrollBarFrame* pointer to scrollbar frame object

Creates a scrollbar frame.

Parameters:

aPreAlloc

Boolean defining if there should be initial memory allocations.

Returns:

The new scroll bar frame.

Creates a scroll bar frame layout according to aLayout.

Parameters:

aLayout

Defines the layout.

Completes the list box view’s construction.

This function is called by ConstructL() to complete construction of the resource view, calling its ConstructL() with appropriate arguments and assigning it to iView. Also prepares the view for use.

Gets the index number of the selected item.

Returns:

Index of the selected item.

Called from MSK observer when shift+MSK have been pressed.

Since:

S60 3.1

Redraws the specified area of this list box into the specified rectangle.

Parameters:

aRect

Rectangle to be redrawn. Specified relative to the origin of this control.

Reimplemented from CEikBorderedControl.

Reimplemented in CAknGMSStyleGrid, CAknSetStyleListBox, AknListBoxLinesTemplate< CEikSettingsListBox >, AknListBoxLinesTemplate< CAknColumnListBox >, and AknListBoxLinesTemplate< CEikFormattedCellListBox >.

Draws a list box item, first scrolling the list to make it visible if it is not already.

DrawItem() panics if there is no list box view currently set.

Parameters:

aItemIndex

Index of the item to reveal.

Draws the matcher cursor in the correct location for the current match.

If there is no match buffer, this function returns immediately; otherwise the cursor is drawn on the current item using CListBoxView::DrawMatcherCursor() after scrolling to make the current item visible.

A list box control’s matcher cursor is an on-screen cursor which is drawn to indicate to the user the location of the current text. Whether the cursor is drawn is dependent on the CListBoxView::TFlags::EHasMatcherCursor flag, which may be set on the list box’s view.

Note, that CListBoxView::DrawMatcherCursor() is not implemented in S60.

Creates an item editor and starts editing the current item.

The editor can edit the current item up to a maximum length of aMaxLength characters. Also reports an EEventEditingStarted event to any list box observer by default.

The function only creates a new editor if one does not already exist.

Parameters:

aMaxLength

Maximum length of characters to edit.

By default markable listbox has middle softkey observer, which handles Mark / Unmark functionality.

By this method, the caller may disable default observer.

Parameters:

aEnable

If EFalse, disables default middle softkey observer for markable lists. ETrue enables observer again.

Returns:

Event modifiers for the CEikListBox.

Notifies item change observers about item change.

Subclasses must call this method if they have implemented item handling functions (e.g. HandleItemAdditionL or HandleItemRemovalL).

Responds to a change in focus.

This is called whenever the control gains or loses focus, as a result of a call to SetFocus(). A typical use of FocusChanged() is to change the appearance of the control, for example by drawing a focus rectangle around it.

The default implementation is empty, and should be overridden by the CCoeControl-derived class.

Parameters:

aDrawNow

Contains the value that was passed to it by SetFocus().

Reimplemented in CAknGrid, CEikColumnListBox, and CEikFormattedCellListBox.

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.

Parameters:

aColorUseList

List of logical colours.

Reimplemented from CEikBorderedControl.

Reimplemented in CEikColumnListBox, CEikFormattedCellListBox, CEikSnakingListBox, CEikTextListBox, and CEikSnakingTextListBox.

Handles drag events.

This function is called by HandlePointerEventL() to handle pointer drag events appropriately.

Parameters:

aPointerPos

The position of the TPointerEvent for which this handler is invoked.

Reimplemented in CAknGrid, and CEikSnakingListBox.

Handles the addition of new items to the list box and updates selection indexes array.

NOTE. This algorithm can not handle position of the list highlight nor can it update the top item index correctly.

Parameters:

aArrayOfNewIndexesAfterAddition

Array of new indexes to be added.

Handles the addition of item to the list box.

Reimplemented in CAknGrid.

Handles the removal of items to the list box and updates selection indexes array.

NOTE. This algorithm cannot handle position of the list highlight nor can it update the top item index correctly.

Parameters:

aArrayOfOldIndexesBeforeRemoval

Array of indexes to be removed.

Handles the removal of an item from the list box.

Reimplemented in CAknGrid.

Handles a left arrow key event.

The method used to handle the event depends on the selection mode, e.g. whether the user has pressed the SHIFT or CONTROL key.

Parameters:

aSelectionMode

Not used

Reimplemented in CEikSnakingListBox.

Handling of pointer event within the CEikListBox.

Used for e.g. selecting an item from the list box.

Parameters:

aPointerEvent

Details of the pointer event that is being handled.

Reimplemented from CEikBorderedControl.

Reimplemented in CAknGMSStyleGrid, CAknGrid, CAknColumnListBox, CAknSingleStyleListBox, CAknSingleGraphicStyleListBox, CAknSingleGraphicHeadingStyleListBox, CAknSingleLargeStyleListBox, CAknDoubleNumberStyleListBox, CAknDoubleTimeStyleListBox, CAknDouble2GraphicStyleListBox, CAknDouble2LargeStyleListBox, CAknSettingStyleListBox, CAknSinglePopupMenuStyleListBox, CAknSingleGraphicPopupMenuStyleListBox, CAknSingleGraphicBtPopupMenuStyleListBox, CAknSingleHeadingPopupMenuStyleListBox, CAknSingleGraphicHeadingPopupMenuStyleListBox, CAknDoublePopupMenuStyleListBox, CAknSinglePopupSubmenuStyleListBox, CAknDoubleLargeGraphicPopupMenuStyleListBox, CAknDouble2PopupMenuStyleListBox, CAknSingle2GraphicPopupMenuStyleListBox, CAknDoubleGraphicPopupMenuStyleListBox, CAknSetStyleListBox, CAknFormGraphicStyleListBox, CAknFormGraphicWideStyleListBox, CAknPinbStyleGrid, CAknQdialStyleGrid, CAknCaleMonthStyleGrid, CAknPopupSettingList, CEikColumnListBox, CEikFormattedCellListBox, CEikSnakingListBox, CEikSettingsListBox, CEikTextListBox, and CEikSnakingTextListBox.

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.

Parameters:

aType

The type of resources that have changed.

Reimplemented from CEikBorderedControl.

Reimplemented in CAknGrid, CAknPopupSettingList, CEikColumnListBox, CEikFormattedCellListBox, CEikSnakingListBox, CEikTextListBox, and CEikSnakingTextListBox.

Handles a right arrow key event.

The method used to handle the event depends on the selection mode, e.g. whether the user has pressed the SHIFT or CONTROL key.

Parameters:

aSelectionMode

Not used.

Reimplemented in CEikSnakingListBox.

Used for scrolling through the items in the list box.

Parameters:

	aScrollBar	Scroll bar for the list box.
	aEventType	Type of the event that occured.

Implements MEikScrollBarObserver.

Reimplemented in CAknGrid.

Handles the change in case that the size of the view rectangle for the list box changes.

Reimplemented in CAknGrid, and CEikSnakingListBox.

Gets the position and the size of the list box.

Returns:

A rectangle with the correct position data as well as size data for the list box.

This function gets the horizontal margin.

Use CEikListBox::ListBoxMargins() instead, as this provides a more accurate value due to the bit shifting involved.

Deprecated:

Use CEikListBox::ListBoxMargins()

Returns:

The horizontal margin in pixels.

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.

Returns:

Number of grains to move left or right on each nudge

Reimplemented in CAknGrid, and CEikSnakingListBox.

Get horizontal scroll granularity in pixels.

The granularity is the minimum size of a horizontal move of the client area.

Returns:

Grain size for horizontal scrolling in pixels.

Reimplemented in CAknGrid, and CEikSnakingListBox.

This method is only called by CEikButtonGroupContainer when MSK observer is enabled and CEikButtonGroupContainer is deleted.

Since:

S60 3.1

From CCoeControl.

Gets the input capabilities of the control and all its components.

Returns:

The input capabilities of the control.

Gets the vertical gap between elements in the list box.

Returns:

The vertical gap between elements in the list box.

Tests whether the list box match buffer exists.

Returns:

ETrue if the list box match buffer exists. EFalse if the list box match buffer does not exist.

Gets item editor for the current class.

Returns:

The item editor used by the list box class.

Tests whether an item exists.

Parameters:

aItemIndex

Index to test.

Returns:

ETrue if the specified item exists, EFalse otherwise.

Gets height of the item.

Returns:

Height of the item.

Checks if the last character matched with the string.

Returns:

ETrue if a match was found from the buffer with the character.

Gets list box margins.

Returns:

The list box margins in pixels.

Creates the list box view.

The function is called by ConstructL() to create an instance of the appropriate list box view class for this list box. The returned instance is owned by this object, and does not have to have its second-phase constructor run. This function is called by CreateViewL().

Returns:

Pointer to a newly constructed list box view for this object.

Reimplemented in CAknGMSStyleGrid, CAknGrid, CAknColumnListBox, CAknSingleGraphicHeadingStyleListBox, CAknSetStyleListBox, CEikColumnListBox, CEikFormattedCellListBox, CEikSnakingListBox, and CEikSettingsListBox.

Gets a pointer to the match buffer.

Returns NULL if the match buffer does not exist.

Returns:

Pointer to the match buffer.

Checks matching for the given character.

Parameters:

aCode

Character code.

Checks the minimum size needed for the list box.

Returns:

The two dimensional minimum size for the list box.

Reimplemented in CAknGMSStyleGrid, CAknSingleStyleListBox, CAknSingleGraphicStyleListBox, CAknSingleGraphicHeadingStyleListBox, CAknSingleLargeStyleListBox, CAknDoubleNumberStyleListBox, CAknDoubleTimeStyleListBox, CAknDouble2GraphicStyleListBox, CAknDouble2LargeStyleListBox, CAknSettingStyleListBox, CAknSinglePopupMenuStyleListBox, CAknSingleGraphicPopupMenuStyleListBox, CAknSingleHeadingPopupMenuStyleListBox, CAknSingleGraphicHeadingPopupMenuStyleListBox, CAknDoublePopupMenuStyleListBox, CAknSinglePopupSubmenuStyleListBox, CAknDoubleLargeGraphicPopupMenuStyleListBox, CAknDouble2PopupMenuStyleListBox, CAknSingle2GraphicPopupMenuStyleListBox, CAknDoubleGraphicPopupMenuStyleListBox, CAknSetStyleListBox, CAknFormGraphicStyleListBox, CAknFormGraphicWideStyleListBox, CAknPinbStyleGrid, CAknQdialStyleGrid, and CAknCaleMonthStyleGrid.

Gets the list box data model.

Returns:

Interface to the list box data model.

Reimplemented in CAknGrid, CEikColumnListBox, CEikFormattedCellListBox, CEikTextListBox, and CEikSnakingTextListBox.

Informs the CEikListbox of a key press.

Parameters:

	aKeyEvent	Details of the key event that is being handled.
	aType	Defines what kind of key event is being handled e.g. EEventKeyUp.

Returns:

EKeyWasConsumed if the key was handled by the method. EKeyWasNotConsumed if the key was not handled.

Reimplemented in CAknGMSStyleGrid, and CAknGrid.

Gets the reason for the list box’s loss of focus.

Returns:

The reason for the loss of focus.

Redraws list item.

Parameters:

aItemIndex

index of item to be redrawn.

Removes an item change observer from the listbox.

Parameters:

aObserver

The observer to be removed.

Returns:

ETrue if removal ok, EFalse if observer was not removed (not found from the list of observers).

Removes a selection (item marking) observer from the listbox.

Parameters:

aObserver

The observer to be removed.

Reports a list box event to any observer of this list box.

This function returns immediately if no observer is set.

Parameters:

aEvent

The event to report.

Deletes the item editor.

Resets the list boxes item editor.

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.

Parameters:

aClientRect

On return contains a size for the client area in pixels.

Reimplemented in CAknGrid, and CEikSnakingListBox.

Restores the list box properties shared by all subclasses from a resource reader.

This function is not called within CEikListBox itself, but is used by subclasses which support construction from resources.

Parameters:

aReader

A resource reader.

Gets pointer for the scroll bar frame.

Returns:

Pointer to the scroll bar frame.

Makes an item visible in the list, scrolling it if necessary.

Parameters:

aItemIndex

Index of the item to reveal.

Gets for list boxes selection indexes.

Returns:

Pointer to the list boxes in array of selection indexes.

Creates an own window for the list box or draws the list box to an old window defined by the aContainer.

Parameters:

aContainer

Defines the container where the list box will be drawn.

Changes the current item index to the selected item index.

Does not redraw the list. If the item was not previously visible it is set to the top item in the view.

Parameters:

aItemIndex

Defines the index of the selected item.

Changes the current item index to the selected item index and redraws the view.

Parameters:

aItemIndex

Defines the index of the selected item.

This function sets a flag within the control which indicates whether or not the control is dimmed (greyed out).

Parameters:

aDimmed

ETrue dimmed. EFalse not dimmed.

Sets the horizontal margin.

Parameters:

aMargin

The required horizontal margin.

Selects an item editor for the list box.

Parameters:

aEditor

The editor that has been selected for usage.

Sets the height of the item to the selected value.

Parameters:

aHeight

New height for the item.

Reimplemented in CAknGrid.

Provides a call back mechanism to the button which just launched a popout menu.

Parameters:

aButton

The button which just launched a popout menu.

Sets the observer for the list box.

Parameters:

aObserver

Wanted observer for the list box.

Sets the reason for the list box’s loss of focus.

This is required so the list box can determine whether loss of focus is due to an external control or an internal component.

Parameters:

aReasonForFocusLost

The reason for the loss of focus.

Sets the given scroll bar frame for the list box with the given ownership leve.

Parameters:

	aScrollBarFrame	The new frame that is going to be used.
	aOwnerShip	Ownership level of the scroll bar frame.

Assigns a array of selection indexes for the list box.

Parameters:

aArrayOfSelectionIndexes

The index array that is to be assigned to the list Box.

No Implementation.

Parameters:

aValue

Not Used.

Sets the selected item to be the top item.

Parameters:

aItemIndex

Index for the item to be set as the top item.

Reimplemented in CAknGrid, and CEikSnakingListBox.

Sets the vertical margin.

Parameters:

aMargin

The required vertical margin.

Sets the view rectangle from the client rectangle making sure a whole number of items is displayed.

Parameters:

aClientRect

The client rectangle

Sets the view rectangle height adjustment.

Parameters:

aAdjustment

New adjustment.

No Implementation.

Returns:

Always returns 0.

Simulates an arrow key event.

If the list box flags include EMultipleSelection, this has the effect of pressing SHIFT with the arrow key represented by aKeyCode. Calls CEikListBox::OfferKeyEventL() with aKeyCode translated into a key event.

Parameters:

aKeyCode

A key code.

Responds to changes to the size and position of the contents of this control.

For a simple control this might include text or graphics. For a compound control it sets the size and position of the components. It has an empty default implementation and should be implemented by the CCoeControl-derived class.

The function is called whenever SetExtent(), SetSize(), SetRect(), SetCornerAndSize(), or SetExtentToWholeScreen() are called on the control. Note that the window server does not generate size-changed events: SizeChanged() gets called only as a result of calling the functions listed above. Therefore, if a resize of one control affects the size of other controls, it is up to the application to ensure that it handles the re-sizing of all affected controls.

Reimplemented in CAknGMSStyleGrid, CAknGrid, CAknSingleStyleListBox, CAknSingleGraphicStyleListBox, CAknSingleGraphicHeadingStyleListBox, CAknSingleLargeStyleListBox, CAknDoubleNumberStyleListBox, CAknDoubleTimeStyleListBox, CAknDouble2GraphicStyleListBox, CAknDouble2LargeStyleListBox, CAknSettingStyleListBox, CAknSinglePopupMenuStyleListBox, CAknSingleGraphicPopupMenuStyleListBox, CAknSingleGraphicBtPopupMenuStyleListBox, CAknSingleHeadingPopupMenuStyleListBox, CAknSingleGraphicHeadingPopupMenuStyleListBox, CAknDoublePopupMenuStyleListBox, CAknSinglePopupSubmenuStyleListBox, CAknDoubleLargeGraphicPopupMenuStyleListBox, CAknDouble2PopupMenuStyleListBox, CAknSingle2GraphicPopupMenuStyleListBox, CAknDoubleGraphicPopupMenuStyleListBox, CAknSetStyleListBox, CAknFormGraphicStyleListBox, CAknFormGraphicWideStyleListBox, CAknPinbStyleGrid, CAknQdialStyleGrid, CAknCaleMonthStyleGrid, CEikSnakingListBox, AknListBoxLinesTemplate< CEikSettingsListBox >, AknListBoxLinesTemplate< CAknColumnListBox >, and AknListBoxLinesTemplate< CEikFormattedCellListBox >.

Stops editing and deletes the item editor.

The function reports an EEventEditingStopped event to any list box observer, and updates the list box model if aUpdateModel is ETrue.

Parameters:

aUpdateModel

If ETrue the list box model is updated.

Gets the index number of the top item.

Returns:

Index number for the top item.

Undoes changes from the match buffer that have been caused by the last match with a character.

Sets an item as the current item, even if it is not currently visible.

Redraws the list box to reflect the change. This should not be called from within another Draw function.

Parameters:

aItemIndex

The index of the list box item to update.

Updates the item drawer colours in line with the colours in effect for the Uikon environment.

Has no effect if there is no item drawer.

If MiddleSoftKey is either Mark or Unmark, this method sets MSK according to the current item selection state.

Updates all scroll bars.

Reimplemented in CAknGrid.

Updates the position of this list box’s scroll bars’ thumbs to reflect the horizontal and vertical position of the list view within the list.

Reimplemented in CAknGrid.

Updates the view colours in line with the colours in effect for the Uikon environment.

Has no effect if there is no view.

Gets the size of the vertical gap between items.

This space is used by the view to allow a box to be drawn around each item.

Returns:

Size of the vertical gap in pixels.

This function gets the vertical margin.

This function is deprecated, use CEikListBox::ListBoxMargins() instead, this provides a more accurate value due to the bit shifting involved.

Deprecated:

Use CEikListBox::ListBoxMargins()

Returns:

The vertical margin in pixels.

Gets the list box view.

Returns:

Interface to the list box view.

Gets the view rectangle height adjustment.

These are the adjustments that were made to the view rectangle when the SetViewRectFromClientRect() function was called.

Returns:

Height adjustment.

Item drawer for this list box.

Height of each item in the list.

Defines which button launched the popout.

Flags for this list box.

The button which just launched a popout menu.

Data model for this list box.

The required height of this list box expressed in terms of a number of items.

The scroll bar used by this control.

Identifies if the scroll bar is owned by this list.

This List box's view.