Class CEikTextListBox

CEikTextListBox

Support

Supported from 6.0

Description

List box for displaying text.

Text list boxes use the standard list box view, CListBoxView, and a customised item drawer and list box model.

Writing derived classes:

This class can be either used as-is, or derived from to provide further functionality. There are three classes supplied in Uikon which are derived from this class:

• CEikChoiceListPopoutListBox

• CEikColumnListBox

• CEikFileSelectorListBox

Derivation

CBase Base class for all classes to be instantiated on the heap CCoeControl Control base class from which all other controls are derived CEikBorderedControl A control which is drawn surrounded by a rectangular border CEikListBox Base class for an on-screen list box control from which one or more items can be selected CEikTextListBox List box for displaying text MEikScrollBarObserver This mixin is implemented by classes wishing to receive notification about scroll events from a scroll bar

Defined in CEikTextListBox:
CEikTextListBox(), ConstructFromResourceL(), ConstructL(), CreateItemDrawerL(), GetColorUseListL(), HandleResourceChange(), Model(), iRequiredCellCharWidth, ~CEikTextListBox()

Inherited from CBase:
operator new()

Inherited from CCoeControl:
ActivateGc(), ActivateL(), BackedUpWindow(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawDeferred(), DrawNow(), DrawableWindow(), EnableDragEvents(), GetColor(), GetHelpContext(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandlePointerBufferReadyL(), HandleRedrawEvent(), IgnoreEventsUntilNextPointerUp(), Index(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), MakeVisible(), Observer(), OverrideColorL(), OwnsWindow(), Position(), PositionChanged(), PositionRelativeToScreen(), PrepareForFocusGainL(), PrepareForFocusLossL(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), ResetGc(), SetAllowStrayPointers(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetContainerWindow(), SetControlContext(), SetCornerAndSize(), SetCornerAndSizeL(), SetExtent(), SetExtentL(), SetExtentToWholeScreen(), SetExtentToWholeScreenL(), SetFocus(), SetFocusing(), SetGloballyCapturing(), SetNeighbor(), SetNonFocusing(), SetObserver(), SetPointerCapture(), SetPosition(), SetRect(), SetRectL(), SetSize(), SetSizeL(), SetSizeWithoutNotification(), SetSizeWithoutNotificationL(), Size(), SizeChangedL(), SystemGc(), Window()

Inherited from CEikBorderedControl:
Border(), HasBorder(), SetAdjacent(), SetBorder(), iBorder

Inherited from CEikListBox:
AdjustRectHeightToWholeNumberOfItems(), AdjustTopItemIndex(), Anonymous, BackColor(), BottomItemIndex(), Buffer(), CalcHeightBasedOnNumOfItems(), CalcSizeInPixels(), CalcWidthBasedOnNumOfChars(), CalcWidthBasedOnRequiredItemWidth(), CalculatePopoutRect(), CheckCreateBufferL(), CheckCreateExtension(), CheckCreateExtensionL(), ClearMargins(), ClearMatchBuffer(), ClearSelection(), ComponentControl(), CountComponentControls(), CreateMatchBufferL(), CreateScrollBarFrameL(), CreateViewL(), CurrentItemIndex(), Draw(), DrawItem(), DrawMatcherCursor(), ECreateOwnWindow, EIncrementalMatching, EItemDoubleClicked, EKeepModel, ELeftDownInViewRect, EMultipleSelection, ENoExtendedSelection, ENoFirstLetterMatching, EPaintedSelection, EPopout, EScrollBarSizeExcluded, EStateChanged, EditItemL(), FocusChanged(), HandleDragEventL(), HandleItemAdditionL(), HandleItemRemovalL(), HandleLeftArrowKeyL(), HandlePointerEventL(), HandleRightArrowKeyL(), HandleScrollEventL(), HandleViewRectSizeChangeL(), HorizScrollGranularityInPixels(), HorizontalMargin(), HorizontalNudgeValue(), InputCapabilities(), InterItemGap(), IsMatchBuffer(), ItemEditor(), ItemExists(), ItemHeight(), KEikListBoxInterItemGap, KEikMaxMatchingBufferLength, ListBoxMargins(), MakeViewClassInstanceL(), MatchBuffer(), MatchTypedCharL(), MinimumSize(), OfferKeyEventL(), ReasonForFocusLostL(), ReportListBoxEventL(), Reset(), ResetItemEditor(), RestoreClientRectFromViewRect(), RestoreCommonListBoxPropertiesL(), ScrollBarFrame(), ScrollToMakeItemVisible(), SelectionIndexes(), SetContainerWindowL(), SetCurrentItemIndex(), SetCurrentItemIndexAndDraw(), SetDimmed(), SetHorizontalMargin(), SetItemEditor(), SetItemHeightL(), SetLaunchingButton(), SetListBoxObserver(), SetReasonForFocusLostL(), SetSelectionIndexesL(), SetTopItemIndex(), SetVerticalMargin(), SetViewRectFromClientRect(), SimulateArrowKeyEventL(), SizeChanged(), StopEditingL(), TFlags, TopItemIndex(), UndoLastChar(), UpdateCurrentItem(), UpdateItemDrawerColors(), UpdateScrollBarThumbs(), UpdateScrollBarsL(), UpdateViewColors(), VerticalInterItemGap(), VerticalMargin(), View(), ViewRectHeightAdjustment(), iItemDrawer, iItemHeight, iLaunchingButton, iListBoxFlags, iListBoxObserver, iModel, iRequiredHeightInNumOfItems, iSBFrame, iView

Inherited from MEikScrollBarObserver:
EEikScrollBottom, EEikScrollDown, EEikScrollEnd, EEikScrollHome, EEikScrollLeft, EEikScrollPageDown, EEikScrollPageLeft, EEikScrollPageRight, EEikScrollPageUp, EEikScrollRight, EEikScrollThumbDragHoriz, EEikScrollThumbDragVert, EEikScrollThumbReleaseHoriz, EEikScrollThumbReleaseVert, EEikScrollTop, EEikScrollUp, TEikScrollEvent

See also:

• CTextListBoxModel
• CTextListItemDrawer

CEikTextListBox();

Description

Default constructor.

void ConstructL(const CCoeControl* aParent,TInt aFlags = 0);

Description

Second-phase constructor.

This initialises the C-classes of a newly-created CEikTextListBox from the arguments supplied. This function fully constructs the associated list box model and item drawer for this list box, and then invokes CEikListBox::ConstructL();

Parameters

const CCoeControl* aParent Parent control for this control. TInt aFlags = 0 Flags for the list box.

See also:

• CTextListBoxModel
• CTextListItemDrawer

virtual void ConstructFromResourceL(TResourceReader& aReader);

Description

Second phase construction from a resource.

This constructor initialises the list box model, flags, required dimensions etc. from a resource. The function fully constructs the associated list box model and item drawer for this list box.

Parameters

TResourceReader& aReader A resource reader initialised to point at a LISTBOX resource.

protected: virtual void CreateItemDrawerL();

Description

Creates the item drawer.

Constructs, but does not initialise or second-phase construct iItemDrawer using the normal Uikon environment font, iEikonEnv->NormalFont(). This function is called by ConstructFromResourceL() or ConstructL().

See also:

• CListItemDrawer::CListItemDrawer()
• Model()

~CEikTextListBox();

Description

Destructor

Deletes all resources owned by this text list box.

CTextListBoxModel* Model() const;

Description

Gets the text list box model.

Return value

CTextListBoxModel* The text list box model used by this list box.

void GetColorUseListL(CArrayFix<TCoeColorUse>& aColorUseList) const;

Description

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

CArrayFix<TCoeColorUse>& aColorUseList List of logical colours.

void HandleResourceChange(TInt aType);

Description

Handles a change to the control's resources. These resources are of type aType, which are shared across the environment, for example colours or fonts.

Parameters

TInt aType The type of resource that has changed.

TInt iRequiredCellCharWidth

Description

The required width of a cell in characters.