CEikSettingsListBox Class Reference

#include <mw/eikslb.h>

Link against: Avkon.lib

class CEikSettingsListBox : public CEikFormattedCellListBox

Inherits from

CEikSettingsListBox
- CEikFormattedCellListBox
  - CEikTextListBox
    - CEikListBox
      - CEikBorderedControl
        CAknControl

Public Member Functions
	CEikSettingsListBox()
virtual IMPORT_C void	HandlePointerEventL(const TPointerEvent &)
IMPORT_C CSettingsListBoxItemDrawer *	ItemDrawer()
virtual IMPORT_C CListBoxView *	MakeViewClassInstanceL()

Protected Member Functions
virtual IMPORT_C void	CreateItemDrawerL()
CSettingsListBoxView *	View()

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
	CEikTextListBox::iRequiredCellCharWidth

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

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::CCoeControlArray
	CCoeControl::CapturesPointer()const
	CCoeControl::ClaimPointerGrab(TBool)
	CCoeControl::ClaimPointerGrab(TInt,TBool)
	CCoeControl::CloseWindow()
	CCoeControl::ComponentArrayExists()const
	CCoeControl::Components()
	CCoeControl::Components()const
	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::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)
	CEikFormattedCellListBox::AdjustRectHeightToWholeNumberOfItems(TRect &)const
	CEikFormattedCellListBox::CEikFormattedCellListBox()
	CEikFormattedCellListBox::ConstructFromResourceL(TResourceReader &)
	CEikFormattedCellListBox::ConstructL(const CCoeControl *,TInt)
	CEikFormattedCellListBox::EnableExtendedDrawingL()
	CEikFormattedCellListBox::EnableStretching(const TBool)
	CEikFormattedCellListBox::FocusChanged(TDrawNow)
	CEikFormattedCellListBox::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
	CEikFormattedCellListBox::HandleResourceChange(TInt)
	CEikFormattedCellListBox::HideSecondRow(const TBool)
	CEikFormattedCellListBox::Model()const
	CEikFormattedCellListBox::MopSupplyObject(TTypeUid)
	CEikFormattedCellListBox::SetIconSizes()
	CEikFormattedCellListBox::UseLogicalToVisualConversion(TBool)
	CEikListBox::ActivateL()
	CEikListBox::AddItemChangeObserverL(MListBoxItemChangeObserver *)
	CEikListBox::AddSelectionObserverL(MListBoxSelectionObserver *)
	CEikListBox::AdjustTopItemIndex()const
	CEikListBox::AknListBoxLayouts
	CEikListBox::AknListBoxShortCutsImplementation
	CEikListBox::BackColor()const
	CEikListBox::BackgroundDrawingSuppressed()const
	CEikListBox::BottomItemIndex()const
	CEikListBox::Buffer()const
	CEikListBox::CEikListBox()
	CEikListBox::CListBoxExt
	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::HandleDragEventL(TPoint)
	CEikListBox::HandleItemAdditionL()
	CEikListBox::HandleItemAdditionL(CArrayFix< TInt > &)
	CEikListBox::HandleItemRemovalL()
	CEikListBox::HandleItemRemovalL(CArrayFix< TInt > &)
	CEikListBox::HandleLeftArrowKeyL(CListBoxView::TSelectionMode)
	CEikListBox::HandlePhysicsScrollEventL(TInt)
	CEikListBox::HandleRightArrowKeyL(CListBoxView::TSelectionMode)
	CEikListBox::HandleScrollEventL(CEikScrollBar *,TEikScrollEvent)
	CEikListBox::HandleViewRectSizeChangeL()
	CEikListBox::HighlightRect()const
	CEikListBox::HorizScrollGranularityInPixels()const
	CEikListBox::HorizontalMargin()const
	CEikListBox::HorizontalNudgeValue()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::RestoreClientRectFromViewRect(TRect &)const
	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::SetTopItemIndex(TInt)const
	CEikListBox::SetVerticalMargin(TInt)
	CEikListBox::SetViewRectFromClientRect(const TRect &)
	CEikListBox::SetViewRectHeightAdjustment(TInt)
	CEikListBox::ShortcutValueForNextList()
	CEikListBox::SimulateArrowKeyEventL(TKeyCode)
	CEikListBox::SizeChanged()
	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()
	CEikTextListBox::CEikTextListBox()
	CEikTextListBox::WriteInternalStateL(RWriteStream &)const
	CEikTextListBox::~CEikTextListBox()

Detailed Description

List box base class. Creates listbox view and item drawer classes. This class is used throughout AknListBoxLinesTemplate< T > class. The CEikSettingsListBox uses CSettingsListBoxView as a list box view class and a CSettingsListBoxItemDrawer as an item drawer.

Since: S60 1.0

Constructor & Destructor Documentation

CEikSettingsListBox ( )

IMPORT_C

CEikSettingsListBox

(

)

C++ default constructor.

Member Function Documentation

CreateItemDrawerL ( )

IMPORT_C void

CreateItemDrawerL

(

)

[protected, virtual]

Reimplemented from CEikFormattedCellListBox::CreateItemDrawerL()

Creates an item drawer for CEikSettingsListBox.

HandlePointerEventL ( const TPointerEvent & )

IMPORT_C void

HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

[virtual]

Reimplemented from CEikFormattedCellListBox::HandlePointerEventL(const TPointerEvent &)

From CCoeControl.

Handles pointer events.

Parameter	Description
aPointerEvent	The pointer event.

ItemDrawer ( )

IMPORT_C CSettingsListBoxItemDrawer *

ItemDrawer

(

)

const

Reimplemented from CEikFormattedCellListBox::ItemDrawer()const

Gets an item drawer of CEikSettingListBox which handles drawing of single list box items and manages their properties.

Returns: Pointer to the item drawer instance.

MakeViewClassInstanceL ( )

IMPORT_C CListBoxView *

MakeViewClassInstanceL

(

)

[virtual]

Reimplemented from CEikFormattedCellListBox::MakeViewClassInstanceL()

From CEikListBox.

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.

View ( )

CSettingsListBoxView *

View

(

)

[protected, inline]

Gets a list box view class as CSettingsListBoxView.

Returns: Pointer to the list box view class object.