CAknListBoxSettingPage Class Reference

class CAknListBoxSettingPage : public CAknSettingPage

Intermediate setting page class to soak up common listbox setting page code

This class has the responsibility of performing the listbox layout and setting out some of the API for listbox setting pages.

Inherits from

Public Member Functions
void CreateIconAndAddToArrayL ( CArrayPtr < CGulIcon > *&, const TAknsItemID &, const TInt , const TDesC &, const TInt32 , const TInt32 )
IMPORT_C void HandleListBoxEventL ( CEikListBox *, TListBoxEvent)
CAknSetStyleListBox * ListBoxControl ()
Protected Member Functions
CAknListBoxSettingPage ( TInt )
CAknListBoxSettingPage (const TDesC *, TInt , TInt , TInt , TInt )
IMPORT_C void CheckAndSetDataValidity ()
IMPORT_C void Draw (const TRect &)
TBool EnableSingleClickHighlight ( TInt )
TBool FocusToFirstItem ()
TBool FocusToSelectedItem ()
IMPORT_C void SizeChanged ()
IMPORT_C void UpdateCbaL ()
Private Member Functions
IMPORT_C void CAknListBoxSettingPage_Reserved_1 ()
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
CAknSettingPage::AcceptSettingL()
CAknSettingPage::AttemptExitL(TBool)
CAknSettingPage::BaseConstructL()
CAknSettingPage::BaseConstructL(TUint)
CAknSettingPage::BaseDraw(const TRect &)const
CAknSettingPage::CAknSettingPage(TInt)
CAknSettingPage::CAknSettingPage(const TDesC *,TInt,TInt,TInt,TInt)
CAknSettingPage::Cba()const
CAknSettingPage::ComponentControl(TInt)const
CAknSettingPage::ConstructFromResourceL(TInt)
CAknSettingPage::ConstructFromResourceL(TResourceReader &)
CAknSettingPage::ConstructL()
CAknSettingPage::CountComponentControls()const
CAknSettingPage::DataValidity()const
CAknSettingPage::DefaultCbaResourceId()const
CAknSettingPage::DismissL(TBool)
CAknSettingPage::DisplayMenuL()
CAknSettingPage::DynInitMenuPaneL(TInt,CEikMenuPane *)
CAknSettingPage::DynamicInitL()
CAknSettingPage::EditedItemControlContext()const
CAknSettingPage::EditorControl()const
CAknSettingPage::ExecuteLD(enum CAknSettingPage::TAknSettingPageUpdateMode)
CAknSettingPage::FocusChanged(TDrawNow)
CAknSettingPage::GetCaptionForFep(TDes &)const
CAknSettingPage::GetEditorResourceInfoL(TInt,TInt &,TInt &)
CAknSettingPage::HandleControlEventL(CCoeControl *,TCoeEvent)
CAknSettingPage::HandlePointerEventL(const TPointerEvent &)
CAknSettingPage::HandleResourceChange(TInt)
CAknSettingPage::HideMenu()
CAknSettingPage::InputCapabilities()const
CAknSettingPage::InvalidDataCbaResourceId()const
CAknSettingPage::IsBackgroundDrawingEnabled()const
CAknSettingPage::IsBaseConstructed()
CAknSettingPage::IsEditable()const
CAknSettingPage::IsNumbered()const
CAknSettingPage::IsSkinsHandlingEditorFrameDrawing()const
CAknSettingPage::IsStopActiveSchudlerCalled()const
CAknSettingPage::MenuShowing()const
CAknSettingPage::MopSupplyObject(TTypeUid)
CAknSettingPage::OfferKeyEventL(const TKeyEvent &,TEventCode)
CAknSettingPage::OkToExitL(TBool)
CAknSettingPage::PostDisplayCheckL()
CAknSettingPage::ProcessCommandL(TInt)
CAknSettingPage::ResetFlags()
CAknSettingPage::RestoreOriginalSettingL()
CAknSettingPage::SelectCurrentItemL()
CAknSettingPage::SetDataValidity(TBool)
CAknSettingPage::SetDrawBackground(const TBool)
CAknSettingPage::SetEditState(const TBool)
CAknSettingPage::SetEditedItemFrameIID(const TAknsItemID &,const TAknsItemID &)
CAknSettingPage::SetEditedItemFrameRects(const TRect &,const TRect &)
CAknSettingPage::SetEditorIndicatorRect(const TRect &)
CAknSettingPage::SetEmphasis(CCoeControl *,TBool)
CAknSettingPage::SetFocusToEditor()
CAknSettingPage::SetNumbered(TBool)
CAknSettingPage::SetSettingId(TInt)
CAknSettingPage::SetSettingNumberL(const TInt)
CAknSettingPage::SetSettingPageObserver(MAknSettingPageObserver *)
CAknSettingPage::SetSettingTextL(const TDesC &)
CAknSettingPage::SetStopActiveSchedulerFlag(const TBool)
CAknSettingPage::SettingId()const
CAknSettingPage::SettingItemContentRect(TBool)
CAknSettingPage::SettingNumber()const
CAknSettingPage::SettingPageResourceId()
CAknSettingPage::ShadowText()const
CAknSettingPage::StandardSettingPageLayout()
CAknSettingPage::StopActiveScheduler()
CAknSettingPage::TextLabel()const
CAknSettingPage::UpdateSettingL()
CAknSettingPage::Waiting()
CAknSettingPage::WriteInternalStateL(RWriteStream &)const
CAknSettingPage::~CAknSettingPage()
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::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::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::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()
Inherited Enumerations
CAknSettingPage:TAknSettingPageUpdateMode
CAknSettingPage:TEditedItemSkinClass
CCoeControl:TZoomType
Protected Attributes
TAknLayoutRect iAreaExtension
Inherited Attributes
CAknSettingPage::iSettingPageObserver
CAknSettingPage::iUpdateMode
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CAknListBoxSettingPage(TInt)

CAknListBoxSettingPage ( TInt aSettingPageResourceId ) [protected]

Pass-through constructor

Parameters

TInt aSettingPageResourceId resource id for CAknSettingPage::BaseConstructL()

CAknListBoxSettingPage(const TDesC *, TInt, TInt, TInt, TInt)

CAknListBoxSettingPage ( const TDesC * aSettingTitleText,
TInt aSettingNumber,
TInt aControlType,
TInt aEditorResourceId,
TInt aSettingPageResourceId = 0
) [protected]

Pass-through constructor

Generic constructor allowing either editor-resource constuction or setting page resource based constuction In all cases the number (if supplied i.e. <> 0 ) is used.

Editor Resource Setting Page Resource present present Both are used (but text & number overridden) = 0 present Editor resource is used via SP resource present = 0 Default Avkon SP resource if used = 0 = 0 Not permitted

Note: THe first argument is a TDesC* (rather than TDesC&) because the other constructor cannot initialize such a member without allocation or having an internal dummy buffer. Note that the setting title provided here must be owned by the client.

Rules for text and numbers: The rules are the same for both: (non-zero length) text or number other than EAknSettingPageNoOrdinalDisplayed if given in this constructor will not override resource (unless that is zero length or EAknSettingPageNoOrdinalDisplayed). Note, however, that text or number given via the specific API for setting them, WILL override resource. It is assumed that number from resource is very rare. Special text is somewhat more likely.

Parameters

const TDesC * aSettingTitleText externally-owned title text
TInt aSettingNumber the setting number to be displayed
TInt aControlType control type enumeration for the control to be constructed by type
TInt aEditorResourceId resource Id at which to read the control's resource
TInt aSettingPageResourceId = 0 optional setting page resource Id; See notes above about resource combinations

Member Functions Documentation

CAknListBoxSettingPage_Reserved_1()

IMPORT_C void CAknListBoxSettingPage_Reserved_1 ( ) [private, virtual]

CheckAndSetDataValidity()

IMPORT_C void CheckAndSetDataValidity ( ) [protected, virtual]

This standard implementation uses ListBoxControl to access the listbox and check the number of items. If 0, validity is set to EFalse

CreateIconAndAddToArrayL(CArrayPtr< CGulIcon > *&, const TAknsItemID &, const TInt, const TDesC &, const TInt32, const TInt32)

void CreateIconAndAddToArrayL ( CArrayPtr < CGulIcon > *& aIconArray,
const TAknsItemID & aId,
const TInt aColorIndex,
const TDesC & aBmpFile,
const TInt32 aBmp,
const TInt32 aBmpM
) [static]

Create colorskinned icon and add it to icon array. Utility for radiobutton, popup & checkbox setting page lists

Since
3.1

Parameters

CArrayPtr < CGulIcon > *& aIconArray
const TAknsItemID & aId
const TInt aColorIndex
const TDesC & aBmpFile
const TInt32 aBmp
const TInt32 aBmpM

Draw(const TRect &)

IMPORT_C void Draw ( const TRect & aRect ) const [protected, virtual]

From CCoeControl : Common draw routine for the listboxes

Parameters

const TRect & aRect rectangle within which to draw

EnableSingleClickHighlight(TInt)

TBool EnableSingleClickHighlight ( TInt aCommandId ) [protected]

Enables highlight to listbox control in single click mode if needed

Since
5.2

Parameters

TInt aCommandId Event Id from the soft-key

FocusToFirstItem()

TBool FocusToFirstItem ( ) [protected, static]

Obtain initial selection policy for popup setting item editing

Since
2.0

FocusToSelectedItem()

TBool FocusToSelectedItem ( ) [protected, static]

Obtain initial selection policy for popup setting item editing

Since
2.0

HandleListBoxEventL(CEikListBox *, TListBoxEvent)

IMPORT_C void HandleListBoxEventL ( CEikListBox * aListBox,
TListBoxEvent aEventType
) [virtual]

Default empty implementation of the listbox observer handling routine

Parameters

CEikListBox * aListBox
TListBoxEvent aEventType

ListBoxControl()

CAknSetStyleListBox * ListBoxControl ( ) const [pure virtual]

Type-specific control access method with a null implementation

SizeChanged()

IMPORT_C void SizeChanged ( ) [protected, virtual]

From CCoeControl : Routine called by Cone framework whenever there has been a size change on this control

UpdateCbaL()

IMPORT_C void UpdateCbaL ( ) [protected, virtual]

Implementation to remove go to "invalid" cba when data is invalid

Member Data Documentation

TAknLayoutRect iAreaExtension

TAknLayoutRect iAreaExtension [protected]

Layout for the extra piece of white (sometimes) at the bottom of the listbox