#include <mw/aknradiobuttonsettingpage.h>
| class CAknRadioButtonSettingPage : public CAknListBoxSettingPage |
| Public Member Functions | |
|---|---|
| CAknRadioButtonSettingPage(TInt, TInt &, const MDesCArray *) | |
| CAknRadioButtonSettingPage(const TDesC *, TInt, TInt, TInt, TInt, TInt &, const MDesCArray *) | |
| virtual IMPORT_C void | ConstructL() |
| virtual IMPORT_C void | HandleListBoxEventL(CEikListBox *, MEikListBoxObserver::TListBoxEvent) |
| virtual IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
| virtual IMPORT_C void | HandleResourceChange(TInt) |
| virtual IMPORT_C CAknSetStyleListBox * | ListBoxControl() |
| IMPORT_C void | SetItemArrayAndSelectionL(const MDesCArray *, TInt) |
| Protected Member Functions | |
|---|---|
| virtual | ~CAknRadioButtonSettingPage() |
| virtual IMPORT_C void | DynamicInitL() |
| virtual IMPORT_C void | ProcessCommandL(TInt) |
| virtual IMPORT_C void | SelectCurrentItemL() |
| virtual IMPORT_C void | UpdateSettingL() |
| virtual IMPORT_C void | WriteInternalStateL(RWriteStream &) |
| Inherited Enumerations | |
|---|---|
| CAknSettingPage:TAknSettingPageUpdateMode | |
| CAknSettingPage:TEditedItemSkinClass | |
| CCoeControl:TZoomType | |
This class sets out a radio button listbox within a setting page.
| IMPORT_C | CAknRadioButtonSettingPage | ( | const TDesC * | aSettingTitleText, |
| TInt | aSettingNumber, | |||
| TInt | aControlType, | |||
| TInt | aEditorResourceId, | |||
| TInt | aSettingPageResourceId, | |||
| TInt & | aCurrentSelectionIndex, | |||
| const MDesCArray * | 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 = 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.
| Parameter | Description |
|---|---|
| aSettingTitleText | Text at top of setting pane; EXTERNALLY OWNED |
| aSettingNumber | Number at top left (if present) |
| aControlType | Determines the type constructed and how its resource is read |
| aEditorResourceId | Editor resource to use in the setting page (if present) |
| aSettingPageResourceId | Setting Page to use (if present) |
| aCurrentSelectionIndex | The currently selected index |
| aItemArray | List of option texts and their selection states |
| IMPORT_C | ~CAknRadioButtonSettingPage | ( | ) | [protected, virtual] |
C++ destructor
| IMPORT_C void | ConstructL | ( | ) | [virtual] |
Reimplemented from CAknSettingPage::ConstructL()
2nd stage contruction for this type. Calls CAknSettingPage::BaseConstuctL() where the object is constructed from resource.
| IMPORT_C void | DynamicInitL | ( | ) | [protected, virtual] |
Reimplemented from CAknSettingPage::DynamicInitL()
Called immediately prior to activation, but after all construction
| IMPORT_C void | HandleListBoxEventL | ( | CEikListBox * | aListBox, |
| MEikListBoxObserver::TListBoxEvent | aEventType | |||
| ) | [virtual] | |||
From MEikListBoxObserver
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Reimplemented from CAknSettingPage::HandlePointerEventL(const TPointerEvent &)
From CCoeControl Handles Radiobuttonlist's PointerEvent
| Parameter | Description |
|---|---|
| aPointerEvent | PointerEvent to be handled |
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
Reimplemented from CAknSettingPage::HandleResourceChange(TInt)
Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.
| Parameter | Description |
|---|---|
| aType | Reason for the "resource" change, usually an system event UID |
| IMPORT_C CAknSetStyleListBox * | ListBoxControl | ( | ) | const [virtual] |
Reimplemented from CAknListBoxSettingPage::ListBoxControl()const
Type specific access to the hosted "editor"
Returns: pointer to contained listbox
| IMPORT_C void | ProcessCommandL | ( | TInt | aCommandId | ) | [protected, virtual] |
Reimplemented from CAknSettingPage::ProcessCommandL(TInt)
From MEikCommandObserver Processes events from the softkeys. (Or translated from key events)
| Parameter | Description |
|---|---|
| aCommandId | Event Id from the soft-key |
| IMPORT_C void | SelectCurrentItemL | ( | ) | [protected, virtual] |
Reimplemented from CAknSettingPage::SelectCurrentItemL()
This method overrides the default implementation in order to do the special processing of selecting an item
| IMPORT_C void | SetItemArrayAndSelectionL | ( | const MDesCArray * | aItemArray, |
| TInt | aPushed | |||
| ) | ||||
Method to update the item array after a change in content and to re-select the "pushed in" index
| IMPORT_C void | UpdateSettingL | ( | ) | [protected, virtual] |
Reimplemented from CAknSettingPage::UpdateSettingL()
Called when the external setting is to be updated
| IMPORT_C void | WriteInternalStateL | ( | RWriteStream & | aWriteStream | ) | const [protected, virtual] |
Reimplemented from CAknSettingPage::WriteInternalStateL(RWriteStream &)const
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.