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.
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 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 |
CAknListBoxSettingPage | ( | TInt | aSettingPageResourceId | ) | [protected] |
Pass-through constructor
TInt aSettingPageResourceId | resource id for CAknSettingPage::BaseConstructL() |
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.
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 |
IMPORT_C void | CAknListBoxSettingPage_Reserved_1 | ( | ) | [private, virtual] |
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
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
IMPORT_C void | Draw | ( | const TRect & | aRect | ) | const [protected, virtual] |
From CCoeControl: Common draw routine for the listboxes
const TRect & aRect | rectangle within which to draw |
TBool | EnableSingleClickHighlight | ( | TInt | aCommandId | ) | [protected] |
Enables highlight to listbox control in single click mode if needed
TInt aCommandId | Event Id from the soft-key |
TBool | FocusToFirstItem | ( | ) | [protected, static] |
Obtain initial selection policy for popup setting item editing
TBool | FocusToSelectedItem | ( | ) | [protected, static] |
Obtain initial selection policy for popup setting item editing
IMPORT_C void | HandleListBoxEventL | ( | CEikListBox * | aListBox, |
TListBoxEvent | aEventType | |||
) | [virtual] |
Default empty implementation of the listbox observer handling routine
CEikListBox * aListBox | |
TListBoxEvent aEventType |
CAknSetStyleListBox * | ListBoxControl | ( | ) | const [pure virtual] |
Type-specific control access method with a null implementation
IMPORT_C void | SizeChanged | ( | ) | [protected, virtual] |
From CCoeControl: Routine called by Cone framework whenever there has been a size change on this control
IMPORT_C void | UpdateCbaL | ( | ) | [protected, virtual] |
Implementation to remove go to "invalid" cba when data is invalid
TAknLayoutRect | iAreaExtension | [protected] |
Layout for the extra piece of white (sometimes) at the bottom of the listbox
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.