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 Enumerations | |
---|---|
CAknSettingPage:TAknSettingPageUpdateMode | |
CAknSettingPage:TEditedItemSkinClass | |
CCoeControl:TZoomType |
Private Attributes | |
---|---|
CAknCheckBoxSettingPageExtension * | iExtension |
CDesCArrayFlat * | iInternalItemArray |
CSelectionItemList * | iItemArray |
IMPORT_C | CAknCheckBoxSettingPage | ( | TInt | aResourceID, |
CSelectionItemList * | aItemArray | |||
) |
TInt aResourceID | |
CSelectionItemList * aItemArray |
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.
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 |
IMPORT_C void | CAknListBoxSettingPage_Reserved_1 | ( | ) | [private, virtual] |
New reserved method from CAknListBoxSettingPage
IMPORT_C void | CAknSettingPage_Reserved_1 | ( | ) | [private, virtual] |
New reserved methods for CAknSettingPage hierarchy
IMPORT_C void | DynamicInitL | ( | ) | [protected, virtual] |
Called when the setting page is about to be displayed
IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
From CAknControl
TUid aInterface |
void | GenerateInternalArrayAndGiveToListBoxL | ( | ) | [private] |
Internal method to re-generate the internal, "decorated" text array used in the real listbox.
IMPORT_C void | HandleListBoxEventL | ( | CEikListBox * | aListBox, |
MEikListBoxObserver::TListBoxEvent | aEventType | |||
) | [virtual] |
Observer callback from the listbox
CEikListBox * aListBox | ptr to listbox that is calling the method |
MEikListBoxObserver::TListBoxEvent aEventType | type of event; defined by MEikListBoxObserver |
IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
From CCoeControl Handles pointer events
const TPointerEvent & aPointerEvent |
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.
TInt aType | Reason for the "resource" change, usually an system event UID |
IMPORT_C CAknSetStyleListBox * | ListBoxControl | ( | ) | const [virtual] |
Access to ListBoxControl
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.
TInt aCommandId | Event Id from the soft-key |
IMPORT_C void | Reserved_2 | ( | ) | [private, virtual] |
Reserved method derived from CCoeControl
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.
IMPORT_C void | SetSelectionItemArrayL | ( | CSelectionItemList * | aItemArray | ) |
Method to update the item array after a change in content
CSelectionItemList * aItemArray |
IMPORT_C void | UpdateSettingL | ( | ) | [protected, virtual] |
Called when the setting is updated
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.
RWriteStream & aWriteStream |
CAknCheckBoxSettingPageExtension * | iExtension | [private] |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.