Collapse all Symbian^3 Application Developer Library

CEikSnakingTextListBox Class Reference

class CEikSnakingTextListBox : public CEikSnakingListBox

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.

Since: Symbian 5.0

Inherits from

CEikSnakingTextListBox
- CEikSnakingListBox
  - CEikListBox
    - CEikBorderedControl
      - CAknControl
        
        CCoeControl
        
        CBase

Public Member Functions
	CEikSnakingTextListBox ()
	~CEikSnakingTextListBox ()
IMPORT_C void	ConstructL (const CCoeControl *, TInt )
IMPORT_C void	GetColorUseListL ( CArrayFix < TCoeColorUse > &)
IMPORT_C void	HandlePointerEventL (const TPointerEvent &)
IMPORT_C void	HandleResourceChange ( TInt )
IMPORT_C CTextListBoxModel *	Model ()

Private Member Functions
IMPORT_C void *	ExtensionInterface ( TUid )

Inherited Functions
	CAknControl::CAknControl()
	CAknControl::~CAknControl()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CCoeControl::AccumulatedZoom()const
	CCoeControl::ActivateGc()const
	CCoeControl::BackedUpWindow()const
	CCoeControl::Background()const
	CCoeControl::CCoeControl()
	CCoeControl::CCoeControl(CCoeEnv *)
	CCoeControl::CCoeControl(const CCoeControl &)
	CCoeControl::CapturesPointer()const
	CCoeControl::ClaimPointerGrab(TBool)
	CCoeControl::ClaimPointerGrab(TInt,TBool)
	CCoeControl::CloseWindow()
	CCoeControl::ComponentArrayExists()const
	CCoeControl::Components()
	CCoeControl::Components()const
	CCoeControl::ConstructFromResourceL(TResourceReader &)
	CCoeControl::ControlContext()const
	CCoeControl::ControlEnv()const
	CCoeControl::CopyControlContextFrom(const CCoeControl *)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
	CCoeControl::CreateWindowL()
	CCoeControl::CreateWindowL(RWindowGroup *)
	CCoeControl::CreateWindowL(RWindowTreeNode &)
	CCoeControl::CreateWindowL(const CCoeControl *)
	CCoeControl::CustomGc()const
	CCoeControl::DeactivateGc()const
	CCoeControl::DrawBackground(const TRect &)const
	CCoeControl::DrawDeferred()const
	CCoeControl::DrawForeground(const TRect &)const
	CCoeControl::DrawNow()const
	CCoeControl::DrawNow(const TRect &)const
	CCoeControl::DrawableWindow()const
	CCoeControl::EnableDragEvents()
	CCoeControl::EnableReportControlStateChange(TBool)
	CCoeControl::EnableWindowTransparency()
	CCoeControl::FindBackground()const
	CCoeControl::FindFontProvider()const
	CCoeControl::GetColor(TInt,TRgb &)const
	CCoeControl::GetGc()const
	CCoeControl::GetHelpContext(TCoeHelpContext &)const
	CCoeControl::GrabbingComponent()const
	CCoeControl::GrabbingComponent(TInt)const
	CCoeControl::HandleComponentControlsResourceChange(TInt)
	CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray ,CCoeControl ,TInt)
	CCoeControl::HandlePointerBufferReadyL()
	CCoeControl::HandleRedrawEvent(const TRect &)const
	CCoeControl::HitTest()const
	CCoeControl::IgnoreEventsUntilNextPointerUp()
	CCoeControl::Index(const CCoeControl *)const
	CCoeControl::InitComponentArrayL()
	CCoeControl::IsActivated()const
	CCoeControl::IsBackedUp()const
	CCoeControl::IsBeingDestroyed()const
	CCoeControl::IsBlank()const
	CCoeControl::IsDimmed()const
	CCoeControl::IsFocused()const
	CCoeControl::IsNonFocusing()const
	CCoeControl::IsReadyToDraw()const
	CCoeControl::IsVisible()const
	CCoeControl::LayoutManager()const
	CCoeControl::MaximumWidth()const
	CCoeControl::MopSupplyObject(TTypeUid)
	CCoeControl::NotifyFontChange(const CCoeFontProvider *)
	CCoeControl::Observer()const
	CCoeControl::OverrideColorL(TInt,TRgb)
	CCoeControl::OwnsWindow()const
	CCoeControl::Parent()
	CCoeControl::Parent()const
	CCoeControl::Position()const
	CCoeControl::PositionChanged()
	CCoeControl::PositionRelativeToScreen()const
	CCoeControl::PrepareForFocusGainL()
	CCoeControl::PrepareForFocusLossL()
	CCoeControl::ProcessPointerBufferReadyL()
	CCoeControl::ProcessPointerEventL(const TPointerEvent &)
	CCoeControl::Rect()const
	CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
	CCoeControl::RecursivelyMergedInputCapabilities()const
	CCoeControl::RefetchPixelMappingL()
	CCoeControl::RemoveFromParent()
	CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
	CCoeControl::RequestRelayout(const CCoeControl *)
	CCoeControl::ResetGc()const
	CCoeControl::ScreenFont(const TCoeFont &)const
	CCoeControl::SetAllowStrayPointers()
	CCoeControl::SetBackground(const MCoeControlBackground *)
	CCoeControl::SetBlank()
	CCoeControl::SetCanDrawOutsideRect()
	CCoeControl::SetComponentsToInheritVisibility(TBool)
	CCoeControl::SetContainerWindowL(RBackedUpWindow &)
	CCoeControl::SetContainerWindowL(RWindow &)
	CCoeControl::SetControlContext(MCoeControlContext *)
	CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
	CCoeControl::SetCustomGc(CWindowGc *)
	CCoeControl::SetExtent(const TPoint &,const TSize &)
	CCoeControl::SetExtentToWholeScreen()
	CCoeControl::SetFocus(TBool,TDrawNow)
	CCoeControl::SetFocusing(TBool)
	CCoeControl::SetFontProviderL(const CCoeFontProvider &)
	CCoeControl::SetGc(CWindowGc *)const
	CCoeControl::SetGloballyCapturing(TBool)
	CCoeControl::SetHitTest(const MCoeControlHitTest *)
	CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
	CCoeControl::SetMaximumWidth(TInt)
	CCoeControl::SetMopParent(MObjectProvider *)
	CCoeControl::SetNeighbor(CCoeControl *)
	CCoeControl::SetNonFocusing()
	CCoeControl::SetObserver(MCoeControlObserver *)
	CCoeControl::SetParent(CCoeControl *)
	CCoeControl::SetPointerCapture(TBool)
	CCoeControl::SetPosition(const TPoint &)
	CCoeControl::SetRect(const TRect &)
	CCoeControl::SetSize(const TSize &)
	CCoeControl::SetSizeWithoutNotification(const TSize &)
	CCoeControl::SetTextBaselineSpacing(TInt)
	CCoeControl::SetUniqueHandle(TInt)
	CCoeControl::SetZoomFactorL(TInt,TZoomType)
	CCoeControl::Size()const
	CCoeControl::SystemGc()const
	CCoeControl::TextBaselineOffset(const TSize &)const
	CCoeControl::TextDrawer(TInt)const
	CCoeControl::UniqueHandle()const
	CCoeControl::Window()const
	CCoeControl::WriteInternalStateNowL(RWriteStream &)const
	CCoeControl::ZoomWithType()const
	CCoeControl::operator=(const CCoeControl &)
	CCoeControl::~CCoeControl()
	CEikBorderedControl::Border()const
	CEikBorderedControl::CEikBorderedControl()
	CEikBorderedControl::CEikBorderedControl(const TGulBorder &)
	CEikBorderedControl::HasBorder()const
	CEikBorderedControl::SetAdjacent(TInt)
	CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
	CEikBorderedControl::SetBorder(TInt)
	CEikBorderedControl::WriteInternalStateL(RWriteStream &)const
	CEikListBox::ActivateL()
	CEikListBox::AddItemChangeObserverL(MListBoxItemChangeObserver *)
	CEikListBox::AddSelectionObserverL(MListBoxSelectionObserver *)
	CEikListBox::BackColor()const
	CEikListBox::BackgroundDrawingSuppressed()const
	CEikListBox::BottomItemIndex()const
	CEikListBox::Buffer()const
	CEikListBox::CEikListBox()
	CEikListBox::CalcHeightBasedOnNumOfItems(TInt)const
	CEikListBox::CalcSizeInPixels(TInt,TInt)const
	CEikListBox::CalcWidthBasedOnNumOfChars(TInt)const
	CEikListBox::CalcWidthBasedOnRequiredItemWidth(TInt)const
	CEikListBox::CalculatePopoutRect(TInt,TInt,TRect &,TInt)
	CEikListBox::ChangeSelectionMode(TBool)
	CEikListBox::CheckCreateBufferL()
	CEikListBox::CheckCreateExtension()
	CEikListBox::CheckCreateExtensionL()
	CEikListBox::ClearMargins()const
	CEikListBox::ClearMatchBuffer()const
	CEikListBox::ClearSelection()
	CEikListBox::ComponentControl(TInt)const
	CEikListBox::ConstructL(MListBoxModel ,CListItemDrawer ,const CCoeControl *,TGulBorder,TInt)
	CEikListBox::ConstructL(MListBoxModel ,CListItemDrawer ,const CCoeControl *,TInt)
	CEikListBox::CountComponentControls()const
	CEikListBox::CreateMatchBufferL()
	CEikListBox::CreateScrollBarFrameL(TBool)
	CEikListBox::CreateScrollBarFrameL(TBool,TBool)
	CEikListBox::CreateScrollBarFrameL(TBool,TBool,TBool)
	CEikListBox::CreateScrollBarFrameLayout(TEikScrollBarFrameLayout &)const
	CEikListBox::CreateViewL()
	CEikListBox::CurrentItemIndex()const
	CEikListBox::DisableItemSpecificMenu()
	CEikListBox::DisableScrolling(TBool)
	CEikListBox::DisableSingleClick(TBool)
	CEikListBox::DoShiftMSKMarkingL()
	CEikListBox::Draw(const TRect &)const
	CEikListBox::DrawItem(TInt)const
	CEikListBox::DrawMatcherCursor()const
	CEikListBox::EditItemL(TInt)
	CEikListBox::EnableMSKObserver(TBool)
	CEikListBox::EventModifiers()
	CEikListBox::FireItemChange()
	CEikListBox::FocusChanged(TDrawNow)
	CEikListBox::HandleItemAdditionL()
	CEikListBox::HandleItemAdditionL(CArrayFix< TInt > &)
	CEikListBox::HandleItemRemovalL()
	CEikListBox::HandleItemRemovalL(CArrayFix< TInt > &)
	CEikListBox::HandlePhysicsScrollEventL(TInt)
	CEikListBox::HandleScrollEventL(CEikScrollBar *,TEikScrollEvent)
	CEikListBox::HighlightRect()const
	CEikListBox::HorizontalMargin()const
	CEikListBox::InformMSKButtonGroupDeletion()
	CEikListBox::InputCapabilities()const
	CEikListBox::InterItemGap()
	CEikListBox::IsHighlightEnabled()
	CEikListBox::IsMatchBuffer()const
	CEikListBox::IsMultiselection()
	CEikListBox::ItemEditor()
	CEikListBox::ItemExists(TInt)const
	CEikListBox::ItemHeight()const
	CEikListBox::ItemsInSingleLine()const
	CEikListBox::LastCharMatched()const
	CEikListBox::ListBoxMargins()const
	CEikListBox::MakeVisible(TBool)
	CEikListBox::MatchBuffer()const
	CEikListBox::MatchTypedCharL(TUint)
	CEikListBox::MinimumSize()
	CEikListBox::OfferKeyEventL(const TKeyEvent &,TEventCode)
	CEikListBox::ReasonForFocusLostL()
	CEikListBox::RedrawItem(TInt)
	CEikListBox::RemoveItemChangeObserver(MListBoxItemChangeObserver *)
	CEikListBox::RemoveSelectionObserver(MListBoxSelectionObserver *)
	CEikListBox::ReportListBoxEventL(MEikListBoxObserver::TListBoxEvent)
	CEikListBox::Reset()
	CEikListBox::ResetItemEditor()
	CEikListBox::RestoreCommonListBoxPropertiesL(TResourceReader &)
	CEikListBox::ScrollBarFrame()
	CEikListBox::ScrollToMakeItemVisible(TInt)const
	CEikListBox::ScrollingDisabled()
	CEikListBox::SelectionIndexes()const
	CEikListBox::SetContainerWindowL(const CCoeControl &)
	CEikListBox::SetCurrentItemIndex(TInt)const
	CEikListBox::SetCurrentItemIndexAndDraw(TInt)const
	CEikListBox::SetDimmed(TBool)
	CEikListBox::SetHorizontalMargin(TInt)
	CEikListBox::SetItemEditor(MEikListBoxEditor *)
	CEikListBox::SetItemHeightL(TInt)
	CEikListBox::SetItemsInSingleLine(TInt)
	CEikListBox::SetLaunchingButton(CEikButtonBase *)
	CEikListBox::SetListBoxObserver(MEikListBoxObserver *)
	CEikListBox::SetMarkingMode(TBool)
	CEikListBox::SetMarkingModeObserver(MAknMarkingModeObserver *)
	CEikListBox::SetPointerEventFilterDisabledL(const CArrayFix< TInt > &)
	CEikListBox::SetReasonForFocusLostL(TReasonForFocusLost)
	CEikListBox::SetScrollBarFrame(CEikScrollBarFrame *,TScrollBarOwnerShip)
	CEikListBox::SetSelectionIndexesL(CListBoxView::CSelectionIndexArray *)
	CEikListBox::SetShortcutValueFromPrevList(TInt)
	CEikListBox::SetVerticalMargin(TInt)
	CEikListBox::SetViewRectFromClientRect(const TRect &)
	CEikListBox::SetViewRectHeightAdjustment(TInt)
	CEikListBox::ShortcutValueForNextList()
	CEikListBox::SimulateArrowKeyEventL(TKeyCode)
	CEikListBox::StopEditingL(TBool)
	CEikListBox::SuspendEffects(TBool)
	CEikListBox::TopItemIndex()const
	CEikListBox::UndoLastChar()
	CEikListBox::UpdateCurrentItem(TInt)const
	CEikListBox::UpdateItemDrawerColors()
	CEikListBox::UpdateMarkUnmarkMSKL()const
	CEikListBox::UpdateScrollBarThumbs()const
	CEikListBox::UpdateScrollBarsL()
	CEikListBox::UpdateViewColors()
	CEikListBox::VerticalInterItemGap()const
	CEikListBox::VerticalMargin()const
	CEikListBox::View()const
	CEikListBox::ViewRectHeightAdjustment()const
	CEikListBox::~CEikListBox()
	CEikSnakingListBox::AdjustRectHeightToWholeNumberOfItems(TRect &)const
	CEikSnakingListBox::AdjustTopItemIndex()const
	CEikSnakingListBox::CEikSnakingListBox()
	CEikSnakingListBox::ColumnWidth()const
	CEikSnakingListBox::HandleDragEventL(TPoint)
	CEikSnakingListBox::HandleLeftArrowKeyL(CListBoxView::TSelectionMode)
	CEikSnakingListBox::HandleRightArrowKeyL(CListBoxView::TSelectionMode)
	CEikSnakingListBox::HandleViewRectSizeChangeL()
	CEikSnakingListBox::HorizScrollGranularityInPixels()const
	CEikSnakingListBox::HorizontalNudgeValue()const
	CEikSnakingListBox::MakeViewClassInstanceL()
	CEikSnakingListBox::MoveToNextOrPreviousItemL(TPoint)
	CEikSnakingListBox::RestoreClientRectFromViewRect(TRect &)const
	CEikSnakingListBox::SetColumnWidth(TInt)
	CEikSnakingListBox::SetTopItemIndex(TInt)const
	CEikSnakingListBox::SizeChanged()
	CEikSnakingListBox::~CEikSnakingListBox()

Inherited Enumerations
	CCoeControl:TZoomType
	CEikListBox:@162
	CEikListBox:TFlags
	CEikListBox:TReasonForFocusLost
	CEikListBox:TScrollBarOwnerShip

Inherited Attributes
	CCoeControl::iCoeEnv
	CCoeControl::iContext
	CCoeControl::iPosition
	CCoeControl::iSize
	CEikBorderedControl::iBorder
	CEikListBox::iItemDrawer
	CEikListBox::iItemHeight
	CEikListBox::iLaunchingButton
	CEikListBox::iListBoxFlags
	CEikListBox::iListBoxObserver
	CEikListBox::iModel
	CEikListBox::iRequiredHeightInNumOfItems
	CEikListBox::iSBFrame
	CEikListBox::iSBFrameOwned
	CEikListBox::iView

Constructor & Destructor Documentation

CEikSnakingTextListBox()

IMPORT_C

CEikSnakingTextListBox

(

)

C++ default constructor.

~CEikSnakingTextListBox()

IMPORT_C

~CEikSnakingTextListBox

(

)

Destructor.

Member Functions Documentation

ConstructL(const CCoeControl *, TInt)

IMPORT_C void	ConstructL	(	const CCoeControl *	aParent,
			TInt	aFlags = 0
		)	[virtual]

By default Symbian 2nd phase constructor is private.

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.

CEikListBox::TFlags

Parameters

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

ExtensionInterface(TUid)

IMPORT_C void *

ExtensionInterface

(

TUid

aInterface

)

[private, virtual]

From CAknControl

Parameters

TUid aInterface

GetColorUseListL(CArrayFix< TCoeColorUse > &)

IMPORT_C void

GetColorUseListL

(

CArrayFix < TCoeColorUse > &

aColorUseList

)

const [virtual]

From CCoeControl .

Not implemented or used in S60.

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.

Since: ER5U

Parameters

CArrayFix < TCoeColorUse > & aColorUseList

On return, a list of logical colours.

HandlePointerEventL(const TPointerEvent &)

IMPORT_C void

HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

[virtual]

From CCoeControl .

Handles pointer events.

Parameters

const TPointerEvent & aPointerEvent

The pointer event.

HandleResourceChange(TInt)

IMPORT_C void

HandleResourceChange

(

TInt

aType

)

[virtual]

From CCoeControl .

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.

Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.

Since: ER5U

Parameters

TInt aType

The type of resource that has changed.

Model()

IMPORT_C CTextListBoxModel *

Model

(

)

const

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