Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: eiktxlbx.h
Link against: eikcoctl.lib

Class CEikSnakingTextListBox

CEikSnakingTextListBox

Support

Supported from 6.0

Description

Horizontal snaking text list box.

This snaking list box is intended for displaying text. The list box lays its items out using the CEikSnakingListBox algorithms, and uses a CTextListItemDrawer to draw its items.

This class is not intended for user derivation.

Derivation

CBaseBase class for all classes to be instantiated on the heap
CCoeControlControl base class from which all other controls are derived
CEikBorderedControlA control which is drawn surrounded by a rectangular border
CEikListBoxBase class for an on-screen list box control from which one or more items can be selected
CEikSnakingListBoxSnaking list box
CEikSnakingTextListBoxHorizontal snaking text list box
MEikScrollBarObserverThis mixin is implemented by classes wishing to receive notification about scroll events from a scroll bar

Defined in CEikSnakingTextListBox:
CEikSnakingTextListBox(), ConstructL(), GetColorUseListL(), HandleResourceChange(), Model(), ~CEikSnakingTextListBox()

Inherited from CBase:
operator new()

Inherited from CCoeControl:
ActivateGc(), ActivateL(), BackedUpWindow(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), ConstructFromResourceL(), 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:
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(), HandleItemAdditionL(), HandleItemRemovalL(), HandlePointerEventL(), HandleScrollEventL(), HorizontalMargin(), InputCapabilities(), InterItemGap(), IsMatchBuffer(), ItemEditor(), ItemExists(), ItemHeight(), KEikListBoxInterItemGap, KEikMaxMatchingBufferLength, ListBoxMargins(), MatchBuffer(), MatchTypedCharL(), MinimumSize(), OfferKeyEventL(), ReasonForFocusLostL(), ReportListBoxEventL(), Reset(), ResetItemEditor(), RestoreCommonListBoxPropertiesL(), ScrollBarFrame(), ScrollToMakeItemVisible(), SelectionIndexes(), SetContainerWindowL(), SetCurrentItemIndex(), SetCurrentItemIndexAndDraw(), SetDimmed(), SetHorizontalMargin(), SetItemEditor(), SetItemHeightL(), SetLaunchingButton(), SetListBoxObserver(), SetReasonForFocusLostL(), SetSelectionIndexesL(), SetVerticalMargin(), SetViewRectFromClientRect(), SimulateArrowKeyEventL(), StopEditingL(), TFlags, TopItemIndex(), UndoLastChar(), UpdateCurrentItem(), UpdateItemDrawerColors(), UpdateScrollBarThumbs(), UpdateScrollBarsL(), UpdateViewColors(), VerticalInterItemGap(), VerticalMargin(), View(), ViewRectHeightAdjustment(), iItemDrawer, iItemHeight, iLaunchingButton, iListBoxFlags, iListBoxObserver, iModel, iRequiredHeightInNumOfItems, iSBFrame, iView

Inherited from CEikSnakingListBox:
AdjustRectHeightToWholeNumberOfItems(), AdjustTopItemIndex(), ColumnWidth(), HandleDragEventL(), HandleLeftArrowKeyL(), HandleRightArrowKeyL(), HandleViewRectSizeChangeL(), HorizScrollGranularityInPixels(), HorizontalNudgeValue(), MakeViewClassInstanceL(), MoveToNextOrPreviousItemL(), RestoreClientRectFromViewRect(), SetColumnWidth(), SetTopItemIndex(), SizeChanged()

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


Construction and destruction


CEikSnakingTextListBox()

CEikSnakingTextListBox();

Description

Default constructor.


ConstructL()

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

Description

Second-phase constructor.

Completes the construction of a default-constructed snaking text list box, initialising its heap-stored members from the supplied arguments. This function will leave if any of the pointer members being constructed leave.

Parameters

const CCoeControl* aParent

Parent control.

TInt aFlags = 0

Flags for the control (see CEikListBox::TFlags).


~CEikSnakingTextListBox()

~CEikSnakingTextListBox();

Description

Destructor.

[Top]


Public member functions


Model()

CTextListBoxModel* Model() const;

Description

Gets a pointer to the model used by this list box.

Return value

CTextListBoxModel*

This list box model.


GetColorUseListL()

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.

This function has an empty implementation.

Parameters

CArrayFix<TCoeColorUse>& aColorUseList

On return, a list of logical colours.


HandleResourceChange()

void HandleResourceChange(TInt aType);

Description

Handles a change in a resource.

The types (aType) of list box resources handled are those which are shared across the environment, for example, colours or fonts.

Parameters

TInt aType

The type of resource that has changed.