CAknCheckBoxSettingPage Class Reference

class CAknCheckBoxSettingPage : public CAknListBoxSettingPage

Setting Page class supporting multiple selection.

Interface is via a CSelectionItemList array

Public Member Functions
CAknCheckBoxSettingPage ( TInt , CSelectionItemList *)
CAknCheckBoxSettingPage (const TDesC *, TInt , TInt , TInt , TInt , CSelectionItemList *)
IMPORT_C void ConstructL ()
IMPORT_C void HandleListBoxEventL ( CEikListBox *, MEikListBoxObserver::TListBoxEvent )
IMPORT_C void HandlePointerEventL (const TPointerEvent &)
IMPORT_C void HandleResourceChange ( TInt )
IMPORT_C CAknSetStyleListBox * ListBoxControl ()
IMPORT_C void SetSelectionItemArrayL ( CSelectionItemList *)
Protected Member Functions
~CAknCheckBoxSettingPage ()
IMPORT_C void DynamicInitL ()
IMPORT_C void ProcessCommandL ( TInt )
IMPORT_C void SelectCurrentItemL ()
IMPORT_C void UpdateSettingL ()
IMPORT_C void WriteInternalStateL ( RWriteStream &)
Private Member Functions
IMPORT_C void CAknListBoxSettingPage_Reserved_1 ()
IMPORT_C void CAknSettingPage_Reserved_1 ()
IMPORT_C void CAknSettingPage_Reserved_2 ()
void CreateCheckBoxBitmapsL ()
IMPORT_C void * ExtensionInterface ( TUid )
void GenerateInternalArrayAndGiveToListBoxL ()
IMPORT_C void Reserved_2 ()
void SetAllSelectionsL ()
void ToggleSelectionL ()
void UpdateAllSelections ()
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
CAknListBoxSettingPage::CAknListBoxSettingPage(TInt)
CAknListBoxSettingPage::CAknListBoxSettingPage(const TDesC *,TInt,TInt,TInt,TInt)
CAknListBoxSettingPage::CheckAndSetDataValidity()
CAknListBoxSettingPage::CreateIconAndAddToArrayL(CArrayPtr< CGulIcon > *&,const TAknsItemID &,const TInt,const TDesC &,const TInt32,const TInt32)
CAknListBoxSettingPage::Draw(const TRect &)const
CAknListBoxSettingPage::EnableSingleClickHighlight(TInt)
CAknListBoxSettingPage::FocusToFirstItem()
CAknListBoxSettingPage::FocusToSelectedItem()
CAknListBoxSettingPage::HandleListBoxEventL(CEikListBox *,TListBoxEvent)
CAknListBoxSettingPage::SizeChanged()
CAknListBoxSettingPage::UpdateCbaL()
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::CountComponentControls()const
CAknSettingPage::DataValidity()const
CAknSettingPage::DefaultCbaResourceId()const
CAknSettingPage::DismissL(TBool)
CAknSettingPage::DisplayMenuL()
CAknSettingPage::DynInitMenuPaneL(TInt,CEikMenuPane *)
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::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::ResetFlags()
CAknSettingPage::RestoreOriginalSettingL()
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::Waiting()
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
Private Attributes
CAknCheckBoxSettingPageExtension * iExtension
CDesCArrayFlat * iInternalItemArray
CSelectionItemList * iItemArray
Inherited Attributes
CAknListBoxSettingPage::iAreaExtension
CAknSettingPage::iSettingPageObserver
CAknSettingPage::iUpdateMode
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CAknCheckBoxSettingPage(TInt, CSelectionItemList *)

IMPORT_C CAknCheckBoxSettingPage ( TInt aResourceID,
CSelectionItemList * aItemArray
)

Parameters

TInt aResourceID
CSelectionItemList * aItemArray

CAknCheckBoxSettingPage(const TDesC *, TInt, TInt, TInt, TInt, CSelectionItemList *)

IMPORT_C CAknCheckBoxSettingPage ( const TDesC * aSettingTitleText,
TInt aSettingNumber,
TInt aControlType,
TInt aEditorResourceId,
TInt aSettingPageResourceId,
CSelectionItemList * aItemArray
)

Constructor that allows separate setting page and editor resources

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 (to no effect?) = 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.

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 the resource. It is assumed that number from resource is very rare. Special text is somewhat more likely.

Parameters

const TDesC * aSettingTitleText Text at top of setting pane
TInt aSettingNumber Number at top left (if present)
TInt aControlType Determines the type constructed and how its resource is read
TInt aEditorResourceId Editor resource to use in the setting page (if present)
TInt aSettingPageResourceId Setting Page to use (if present)
CSelectionItemList * aItemArray List of option texts and their selection states

~CAknCheckBoxSettingPage()

IMPORT_C ~CAknCheckBoxSettingPage ( ) [protected, virtual]

Destructor

Member Functions Documentation

CAknListBoxSettingPage_Reserved_1()

IMPORT_C void CAknListBoxSettingPage_Reserved_1 ( ) [private, virtual]

New reserved method from CAknListBoxSettingPage

CAknSettingPage_Reserved_1()

IMPORT_C void CAknSettingPage_Reserved_1 ( ) [private, virtual]

New reserved methods for CAknSettingPage hierarchy

CAknSettingPage_Reserved_2()

IMPORT_C void CAknSettingPage_Reserved_2 ( ) [private, virtual]

ConstructL()

IMPORT_C void ConstructL ( ) [virtual]

2nd phase constructor

CreateCheckBoxBitmapsL()

void CreateCheckBoxBitmapsL ( ) [private]

DynamicInitL()

IMPORT_C void DynamicInitL ( ) [protected, virtual]

Called when the setting page is about to be displayed

ExtensionInterface(TUid)

IMPORT_C void * ExtensionInterface ( TUid aInterface ) [private, virtual]

Parameters

TUid aInterface

GenerateInternalArrayAndGiveToListBoxL()

void GenerateInternalArrayAndGiveToListBoxL ( ) [private]

Internal method to re-generate the internal, "decorated" text array used in the real listbox.

HandleListBoxEventL(CEikListBox *, MEikListBoxObserver::TListBoxEvent)

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

Observer callback from the listbox

Parameters

CEikListBox * aListBox ptr to listbox that is calling the method
MEikListBoxObserver::TListBoxEvent aEventType type of event; defined by MEikListBoxObserver

HandlePointerEventL(const TPointerEvent &)

IMPORT_C void HandlePointerEventL ( const TPointerEvent & aPointerEvent ) [virtual]

From CCoeControl Handles pointer events

Parameters

const TPointerEvent & aPointerEvent

HandleResourceChange(TInt)

IMPORT_C void HandleResourceChange ( TInt aType ) [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 aType Reason for the "resource" change, usually an system event UID

ListBoxControl()

IMPORT_C CAknSetStyleListBox * ListBoxControl ( ) const [virtual]

Access to ListBoxControl

ProcessCommandL(TInt)

IMPORT_C void ProcessCommandL ( TInt aCommandId ) [protected, virtual]

From MEikCommandObserver Processes events from the softkeys. Responds to EAknSoftkeyOk and EAknSoftkeyBack to accept or cancel the pop-up.

Parameters

TInt aCommandId Event Id from the soft-key

Reserved_2()

IMPORT_C void Reserved_2 ( ) [private, virtual]

Reserved method derived from CCoeControl

SelectCurrentItemL()

IMPORT_C void SelectCurrentItemL ( ) [protected, virtual]

This method should be implemented in listbox classes to move the selection in listbox editors prior to exiting from the setting page. It is called on a CAknSettingPage* reference, and is therefore declared here.

SetAllSelectionsL()

void SetAllSelectionsL ( ) [private]

SetSelectionItemArrayL(CSelectionItemList *)

IMPORT_C void SetSelectionItemArrayL ( CSelectionItemList * aItemArray )

Method to update the item array after a change in content

Parameters

CSelectionItemList * aItemArray

ToggleSelectionL()

void ToggleSelectionL ( ) [private]

UpdateAllSelections()

void UpdateAllSelections ( ) [private]

UpdateSettingL()

IMPORT_C void UpdateSettingL ( ) [protected, virtual]

Called when the setting is updated

WriteInternalStateL(RWriteStream &)

IMPORT_C void WriteInternalStateL ( RWriteStream & aWriteStream ) const [protected, virtual]

Writes the internal state of the control and its components to aStream. Does nothing in release mode. Designed to be overidden and base called by subclasses.

Parameters

RWriteStream & aWriteStream

Member Data Documentation

CAknCheckBoxSettingPageExtension * iExtension

CAknCheckBoxSettingPageExtension * iExtension [private]

CDesCArrayFlat * iInternalItemArray

CDesCArrayFlat * iInternalItemArray [private]

CSelectionItemList * iItemArray

CSelectionItemList * iItemArray [private]