C++ default constructor.

Destructor.

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

Adds a selection (item marking) observer to the listbox. Duplicates are not checked (i.e. adding the same observer multiple times is not prevented).

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

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.

Gets the background colour.

Checks whether background drawing is suppressed on item level i.e. each list item doesn't draw its background.

Gets for the bottom items index.

Gets 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.

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.

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.

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.

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

This switches listbox into selection mode. Basicly only changes MSK and informs selection observers about the change.

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.

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.

Handles 2nd phase construction.

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

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.

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

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

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

Creates a scrollbar frame.

Creates a scrollbar for the listbox. The caller may choose if the scrollbar is requested remotely via the mop chain from parent control

Creates a scrollbar for the listbox. The caller may choose if the scrollbar is requested remotely via the mop chain from parent control

Creates a scroll bar frame layout according to aLayout.

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.

Disables item specific menu from the list. This has the same effect as construction time flag EAknListBoxItemSpecificMenuDisabled and calling this method also turns that flag on.

Disables the kinetic scrolling functionality in the list. By default the feature is enabled.

Disables the single click functionality in the list. By default the feature is enabled.

Called from MSK observer when shift+MSK have been pressed

S60 3.1

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

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.

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.

Creates an item editor, if one does not already exist, and starts editing the current item up to a maximum length of aMaxLength characters. Also reports an EEventEditingStarted event to any list box observer by default.

By default markable listbox has middle softkey observer, which handles Mark / Unmark functionality. By this method, the caller may disable default observer.

From CAknControl

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.

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.

Handles drag events.

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

Handles the addition of item to the list box.

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.

Handles the removal of an item from the list box.

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.

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.

Handles pointer events if physics are enabled.

Scrolls the view by the given amount of pixels while keeping the physics parameters up-to-date. This should be called when scrolling the list box view except for when it is done by list dragging (e.g. scrolling with scroll bar).

Handling of pointer event within the CEikListBox. Used for e.g. selecting an item from the list box.

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.

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.

Used for scrolling through the items in the list box.

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

Gets the position and the size of the list box.

Get horizontal scroll granularity in pixels. The granularity is the minimum size of a horizontal move of the client area.

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

Use CEikListBox::ListBoxMargins() @ deprecated Use CEikListBox::ListBoxMargins() instead, to get more accurate values, as use of this method may cause a single pixel error if the laf is being used, due to the bit shifting involved

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.

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

S60 3.1

From CCoeControl.

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

Gets the vertical gap between elements in the list box.

Checks if highlight drawing is enabled. If single click is enabled highlight drawing is by default disabled, but highlight comes visible with hardware keys.

Tests whether the list box match buffer exists.

Gets item editor for the current class.

Returns a pointer to the item editor. Does not imply transfer of ownership.

Tests whether an item exists.

Gets height of the item.

Gets the number of list items in one line. This is more than one for grids only.

Checks if the last character matched with the string.

Gets list box margins.

@ since uikon_1.2 A method which returns a TMargins object for the list box. The TMargins object has 4 values, one for each side of the list box. Depending on use of the Laf, the DFRD can program 2, 3 or 4 margins ... ... but although the application developer can see up to 4 different margins ... ... they can only set 2 (ie. iHorizontalMargin and iVerticalMargin)

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

Sets this control as visible or invisible.

Checks whether marking mode is on or off.

Returns the marking mode observer.

Gets a pointer to the match buffer. Returns NULL if the match buffer does not exist.

Checks matching for the given character.

Checks the minimum size needed for the list box.

Gets the list box data model.

Informs the CEikListbox of a key press.

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

Removes an item change observer from the listbox.

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

Reports a list box event to any observer of this list box. This function returns immediately if no observer is set.

Deletes the item editor

Resets the list boxes item editor.

Deletes and NULLs the 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.

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.

Gets pointer for the scroll bar frame.

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

Scrolls the view by the given amount of pixels.

Checks if the kinetic scrolling is currently enabled in the list.

Gets for list boxes selection indexes.

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

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.

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

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

Sets the horizontal margin.

Selects an item editor for the list box.

Sets the item editor to aEditor and transfers ownership.

Sets the height of the item to the selected value.

Sets the number of list items that form one grid line.

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

Sets the observer for the list box.

Turns the marking mode on / off.

Sets the marking mode observer.

Removes pointer event filtering for list items.

When there are two pointer up events on the same item at short interval, listbox will only get the first one and drop the second one. This method forces listbox to handle all pointer up events.

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.

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

Assigns a array of selection indexes for the list box.

No Implementation.

Sets the selected item to be the top item.

Sets the vertical margin.

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

Sets the view rectangle height adjustment.

No Implementation.

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.

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.

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.

Stops editing and deletes the item editor, reporting an EEventEditingStopped event to any list box observer. Updates the list box model if aUpdateModel is ETrue.

Suspends transitions effects.

Gets the index number of 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.

Selects an item and draws highlight to it.

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 the position of this list box?s scroll bars? thumbs to reflect the horizontal and vertical position of the list view within the list.

Updates all scroll bars.

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.

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.

Use CEikListBox::ListBoxMargins() @ deprecated Use CEikListBox::ListBoxMargins() instead, to get more accurate values, as use of this method may cause a single pixel error if the laf is being used, due to the bit shifting involved

Gets 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.

Construction flags.

Used for indicating the reason why the item lost focus.

Indicates who owns the scroll bar.

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