#include <mw/aknsettingitemlist.h>
| class CAknSettingItem : public CBase |
| Public Member Enumerations | |
|---|---|
| enum | TFlags { EIsHidden, EHasIcon, EIsNumberedStyle, ENoProtection, ..., EProtected } |
| enum | TSettingItemProtection { ENoSettingItemProtection, ESettingItemViewOnly, ESettingItemProtected } |
| Protected Member Functions | |
|---|---|
| IMPORT_C TInt | AssociatedResourceId() |
| virtual IMPORT_C void | CompleteConstructionL() |
| virtual IMPORT_C CFbsBitmap * | CreateBitmapL() |
| TInt | EditorControlType() |
| IMPORT_C TDesC & | EmptyItemText() |
| IMPORT_C TBool | SetIconMask(CFbsBitmap *) |
| CFbsBitmap * | SetIconMaskAndReturnBitmap(CGulIcon *) |
| IMPORT_C void | SetSettingPage(CAknSettingPage *) |
| IMPORT_C void | SetUpStandardSettingPageL() |
| IMPORT_C TInt | SettingEditorResourceId() |
| IMPORT_C CAknSettingPage * | SettingPage() |
| IMPORT_C TInt | SettingPageResourceId() |
CAknSettingItem is the base class for all setting items. The abstracted functionality is implemented in this class if possible.
All array of setting items is held in CAknSettingItemArray, which in turn is owned by CAknSettingItemList, a listbox type.
| IMPORT_C TInt | AssociatedResourceId | ( | ) | const [protected] |
Returns the associate editor resource. This is an LLINK in the seting item resource that subclasses can use in CompleteContstructionL
Returns: 0 or the extra resource id
| IMPORT_C void | CompleteConstructionL | ( | ) | [protected, virtual] |
Method called by framework to complete the construction. Extra allocations of memory or extra resource reading can happen here.
| IMPORT_C void | ConstructL | ( | const TBool | aIsNumberedStyle, |
| const TInt | aOrdinal, | |||
| const TDesC & | aSettingTitle, | |||
| CArrayPtr< CGulIcon > * | aIconArray, | |||
| const TInt | aSettingPageResource, | |||
| const TInt | aEditorControlType, | |||
| const TInt | aSettingEditorResource = 0, | |||
| const TInt | aAssociatedResource = 0 | |||
| ) | ||||
2nd-stage constuctor. Resource for setting item is read externally in setting item list and the values are passed here.
| IMPORT_C CFbsBitmap * | CreateBitmapL | ( | ) | [protected, virtual] |
Method to obtain a new bitmap for the setting content
This method is usually empty in setting items classes except for volume and slider. Any derived implementations of this method should call SetIconMask().
| IMPORT_C void | EditItemL | ( | TBool | aCalledFromMenu | ) | [virtual] |
This launches the setting page
| Parameter | Description |
|---|---|
| aCalledFromMenu | - ignored in this class |
| IMPORT_C TDesC & | EmptyItemText | ( | ) | const [protected] |
Access to the empty text that has been set, or is default
Returns: ref to empty text descriptor
| IMPORT_C void | HandleSettingPageEventL | ( | CAknSettingPage * | aSettingPage, |
| TAknSettingPageEvent | aEventType | |||
| ) | [virtual] | |||
| IMPORT_C TBool | HasIcon | ( | ) | const |
Checks if the setting item has a bitmap in its setting contents
Returns: ETrue if it has a bitmap
| IMPORT_C TInt | Identifier | ( | ) | const |
Access to the setting item's identifier. This is set in the setting item's constructor but usually comes via resource in the setting item list read of its resource structure
Returns: The identifier of this setting item
| IMPORT_C TBool | IsHidden | ( | ) | const |
Access to the setting visibility
Returns: ETrue if the setting item is hidden
| IMPORT_C TBool | IsNumberedStyle | ( | ) | const |
Access to the numbering style of the setting item
Returns: ETrue if it is numbered
| IMPORT_C HBufC * | ListBoxText | ( | ) |
This gives access to the listbox text content at this item (fully decorated)
Returns: pointer to listboxtext. No allocation is performed and no change of ownership
| IMPORT_C CAknSettingItem::TSettingItemProtection | ProtectionState | ( | ) |
Get the protection state
See SetProtected for details for the different states.
Returns: Protection state of the setting item
| IMPORT_C void | SetCompulsoryIndTextL | ( | const TDesC & | aCompulsoryInd | ) |
| IMPORT_C void | SetEmptyItemTextL | ( | const TDesC & | aEmptyItemText | ) |
This sets the text to display if the current setting is empty.
| IMPORT_C void | SetHidden | ( | TBool | aHidden | ) |
Set the visibility Note that the setting item array must have be notified of this by calling CAknSettingItemList::HandleChangeInItemArrayOrVisibility
| IMPORT_C TBool | SetIconMask | ( | CFbsBitmap * | aMask | ) | [protected] |
This sets the mask of this setting item's icon array, if it exists. The normal usage of this routine is inside a re-implementation of CAknSettingItem::CreateBitmapL. It is used to set the mask of the setting item's setting icon as a side effect of a framework call to CreateBitmapL
The return value may need to be looked at to decide how to dispose of, for example, an a CGulIcon that may be holding the mask.
| Parameter | Description |
|---|---|
| aMask | bitmap to set as a mask for the CGulIcon in the setting listbox's icon array |
Returns: TBool ETrue if the ownership of aMask has been passed
| CFbsBitmap * | SetIconMaskAndReturnBitmap | ( | CGulIcon * | aIcon | ) | [protected] |
This sets the mask of this setting item's icon array, if it exists, using the mask from the passed icon. It returns the bitmap from the aIcon. The method also takes ownership of aIcon and may delete it (but not its bitmap).
| Parameter | Description |
|---|---|
| aIcon | icon of which the mask is passed through to SetIconMask() and bitmap is returned |
Returns: CFbsBitmap* bitmap from aIcon. Ownership of the bitmap is transfered to the caller
| void | SetParentListBox | ( | const CEikFormattedCellListBox * | aListBox | ) |
Set the parent lisbox into the setting item
| Parameter | Description |
|---|---|
| aListBox | listbox with which the setting item is associated. |
| IMPORT_C void | SetProtectionState | ( | CAknSettingItem::TSettingItemProtection | aProtected | ) |
Set the protection state of the setting item
prohibit opening of the setting page
allow access to the setting page, but prohibit editing of it
The protected item is indicated in the setting item list with a lock icon. If a user tries to open a protected setting item, a notification is shown to the user.
The "view only" -mode is only possible for pop-up setting page.
| Parameter | Description |
|---|---|
| aProtected | Sets the protection state of the setting item |
| IMPORT_C void | SetSettingPage | ( | CAknSettingPage * | aSettingPage | ) | [protected] |
A setting page should know when it is "Editing". This is set in EditItemL and cleared to 0 when the dialog is finished.
| IMPORT_C void | SetSettingPageFlags | ( | TInt | aFlagPattern | ) |
Set the flags that are required for some of the setting page constructors
| Parameter | Description |
|---|---|
| aFlagPattern | Flag pattern to set |
| IMPORT_C void | SetUpStandardSettingPageL | ( | ) | [protected] |
Performs standard setup on a setting page
| IMPORT_C TInt | SettingEditorResourceId | ( | ) | const [protected] |
Access to the setting page editor's resource id that might have been read by the setting item resource.
Returns: 0 or the setting page editor's id
| IMPORT_C TInt | SettingPageFlags | ( | ) | const |
Access method for the setting page specific flags
Returns: the flag pattern
| IMPORT_C TInt | SettingPageResourceId | ( | ) | const [protected] |
Access to the setting page resource id that might have been read by the setting item resource.
Returns: 0 or the setting page resource id
| IMPORT_C void | StoreL | ( | ) | [virtual] |
This command externalizes the current setting. The displayed (internal) copy is transferred to the external copy (the one referenced in the constructor).
This must be called by the client if he wants this to happen. Note that StoreAllL() on the setting item list will call this for each setting item.
| IMPORT_C void | UpdateListBoxTextL | ( | ) | [virtual] |
This method is called by framework in order to update the text in the setting item. It may be called by the client.
| IMPORT_C TInt | VisibleIndex | ( | ) |
Get the index at which this item appears in the listbox
Returns: index in listbox