CAknSettingItemList Class Reference

class CAknSettingItemList : public CAknControl

Inherits from

Public Member Functions
CAknSettingItemList()
~CAknSettingItemList()
IMPORT_C CCoeControl *ComponentControl(TInt)
IMPORT_C voidConstructFromResourceL(TInt)
IMPORT_C voidConstructFromResourceL(TResourceReader &)
IMPORT_C TIntCountComponentControls()
IMPORT_C voidEditItemL(TInt, TBool)
IMPORT_C voidFocusChanged(TDrawNow)
IMPORT_C voidHandleChangeInItemArrayOrVisibilityL()
IMPORT_C voidHandleListBoxEventL(CEikListBox *, TListBoxEvent)
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C voidHandleResourceChange(TInt)
IMPORT_C TBoolIsNumberedStyle()
IMPORT_C CEikFormattedCellListBox *ListBox()
IMPORT_C voidLoadSettingsL()
IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C voidSetIncludeHiddenInOrdinal(TBool)
IMPORT_C CAknSettingItemArray *SettingItemArray()
IMPORT_C voidStoreSettingsL()
Protected Member Functions
IMPORT_C CAknSettingItem *CreateSettingItemL(TInt)
Private Member Functions
IMPORT_C void *ExtensionInterface(TUid)
voidUpdateAllListBoxTextsL()
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::ActivateL()
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::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::GetColorUseListL(CArrayFix< TCoeColorUse > &)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::HasBorder()const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::InputCapabilities()const
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::MakeVisible(TBool)
CCoeControl::MaximumWidth()const
CCoeControl::MinimumSize()
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::SetAdjacent(TInt)
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
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::SizeChanged()
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateL(RWriteStream &)const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
Public Member Enumerations
enumTAknSettingItemStyle { ENumberedStyle, EUnnumberedStyle }
Inherited Enumerations
CCoeControl:TZoomType
Private Attributes
TInt iFlags
TInt iInitialOrdinal
CAknSettingItemArray *iSettingItemArray
CEikFormattedCellListBox *iSettingItemListBox
HBufC *iSettingItemListTitle
TInt iSpare_1
TInt iSpare_2
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CAknSettingItemList()

IMPORT_CCAknSettingItemList()

Constructs the setting item list

~CAknSettingItemList()

IMPORT_C~CAknSettingItemList()

Destructor

Member Functions Documentation

ComponentControl(TInt)

IMPORT_C CCoeControl *ComponentControl(TIntaId)const [virtual]

Parameters

TInt aId

ConstructFromResourceL(TInt)

IMPORT_C voidConstructFromResourceL(TIntaResourceId)

2nd-stage construction from resource id

Parameters

TInt aResourceId

ConstructFromResourceL(TResourceReader &)

IMPORT_C voidConstructFromResourceL(TResourceReader &aReader)[virtual]

2nd-stage construction from constructed resource reader

Parameters

TResourceReader & aReader

CountComponentControls()

IMPORT_C TIntCountComponentControls()const [virtual]

CreateSettingItemL(TInt)

IMPORT_C CAknSettingItem *CreateSettingItemL(TIntaSettingId)[protected, virtual]

Framework method to create a setting item based upon the user id aSettingId. The client code decides what type to contruct. new (ELeave) must then be used and the resulting pointer returned. Ownership is thereafter base class's responsiblity.

Parameters

TInt aSettingIdID to use to determine the type of the setting item

EditItemL(TInt, TBool)

IMPORT_C voidEditItemL(TIntaIndex,
TBoolaCalledFromMenu
)[virtual]

This launches the setting page for the current item by calling EditItemL on it

Parameters

TInt aIndex- current item's (Visible) index in the list aCalledFromMenu- ignored in most classes; may alter the behaviour of the setting page
TBool aCalledFromMenu

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[private, virtual]

Parameters

TUid aInterface

FocusChanged(TDrawNow)

IMPORT_C voidFocusChanged(TDrawNowaDrawNow)[virtual]

Take action necessary when the focus is change

Parameters

TDrawNow aDrawNow

HandleChangeInItemArrayOrVisibilityL()

IMPORT_C voidHandleChangeInItemArrayOrVisibilityL()

Method to be called when the client code has added or removed items or their visibility; This should be called when a single event's batch of array or visibility changes is complete in order to avoid more re-draws than is necessary

HandleListBoxEventL(CEikListBox *, TListBoxEvent)

IMPORT_C voidHandleListBoxEventL(CEikListBox *aListBox,
TListBoxEventaEventType
)[virtual]

Parameters

CEikListBox * aListBox
TListBoxEvent aEventType

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

From CCoeControl. Handles pointer events

Parameters

const TPointerEvent & aPointerEvent

HandleResourceChange(TInt)

IMPORT_C voidHandleResourceChange(TIntaType)[virtual]

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

Since
2.0

Parameters

TInt aTypeReason for the "resource" change, usually an system event UID

IsNumberedStyle()

IMPORT_C TBoolIsNumberedStyle()

ListBox()

IMPORT_C CEikFormattedCellListBox *ListBox()

LoadSettingsL()

IMPORT_C voidLoadSettingsL()[virtual]

Calls LoadL() on each item in the MAknSettingItemArray.

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[virtual]

Handles keys sent to this control

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

SetIncludeHiddenInOrdinal(TBool)

IMPORT_C voidSetIncludeHiddenInOrdinal(TBoolaInclude)

Parameters

TBool aIncludeIf EFalse, numbering does not include hidden items Otherwise, they are

SettingItemArray()

IMPORT_C CAknSettingItemArray *SettingItemArray()const

StoreSettingsL()

IMPORT_C voidStoreSettingsL()[virtual]

This command calls StoreL on all the setting items (hidden or not)

This must be called by the client if he wants it to occur

UpdateAllListBoxTextsL()

voidUpdateAllListBoxTextsL()const [private]

Member Enumerations Documentation

Enum TAknSettingItemStyle

Enumerators

ENumberedStyle
EUnnumberedStyle

Member Data Documentation

TInt iFlags

TInt iFlags[private]

TInt iInitialOrdinal

TInt iInitialOrdinal[private]

CAknSettingItemArray * iSettingItemArray

CAknSettingItemArray *iSettingItemArray[private]

CEikFormattedCellListBox * iSettingItemListBox

CEikFormattedCellListBox *iSettingItemListBox[private]

HBufC * iSettingItemListTitle

HBufC *iSettingItemListTitle[private]

TInt iSpare_1

TInt iSpare_1[private]

TInt iSpare_2

TInt iSpare_2[private]