CAknSettingItemList Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknsettingitemlist.h>

Inherits CAknControl, and MEikListBoxObserver.


Public Types
enum	TAknSettingItemStyle { ENumberedStyle, EUnnumberedStyle }
Public Member Functions
IMPORT_C	CAknSettingItemList ()
	Constructs the setting item list.
IMPORT_C	~CAknSettingItemList ()
	Destructor.
IMPORT_C void	ConstructFromResourceL (TInt aResourceId)
	2nd-stage construction from resource id
IMPORT_C void	ConstructFromResourceL (TResourceReader &aReader)
	2nd-stage construction from constructed resource reader
IMPORT_C TInt	CountComponentControls () const
IMPORT_C CCoeControl *	ComponentControl (TInt aId) const
virtual IMPORT_C TKeyResponse	OfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode aType)
	Handles keys sent to this control.
virtual IMPORT_C void	FocusChanged (TDrawNow aDrawNow)
	Take action necessary when the focus is change.
IMPORT_C void	HandleResourceChange (TInt aType)
	Handles a change to the control's resources of type aType which are shared across the environment, e.g.
virtual IMPORT_C void	HandleListBoxEventL (CEikListBox *aListBox, TListBoxEvent aEventType)
virtual IMPORT_C void	EditItemL (TInt aIndex, TBool aCalledFromMenu)
	This launches the setting page for the current item by calling EditItemL on it.
virtual IMPORT_C void	LoadSettingsL ()
	Calls LoadL() on each item in the MAknSettingItemArray.
virtual IMPORT_C void	StoreSettingsL ()
	This command calls StoreL on all the setting items (hidden or not).
IMPORT_C void	SetIncludeHiddenInOrdinal (TBool aInclude)
IMPORT_C TBool	IsNumberedStyle ()
IMPORT_C CEikFormattedCellListBox *	ListBox ()
IMPORT_C CAknSettingItemArray *	SettingItemArray () const
IMPORT_C void	HandleChangeInItemArrayOrVisibilityL ()
	Method to be called when the client code has added or removed items or their visibility; This should be called when a single event's batch of array or visibility changes is complete in order to avoid more re-draws than is necessary.
IMPORT_C void	HandlePointerEventL (const TPointerEvent &aPointerEvent)
	From CCoeControl.
Protected Member Functions
virtual IMPORT_C CAknSettingItem *	CreateSettingItemL (TInt aSettingId)
	Framework method to create a setting item based upon the user id aSettingId.

Member Enumeration Documentation

enum CAknSettingItemList::TAknSettingItemStyle

Enumerator:

ENumberedStyle
EUnnumberedStyle

Constructor & Destructor Documentation

IMPORT_C CAknSettingItemList::CAknSettingItemList

(

)

Constructs the setting item list.

IMPORT_C CAknSettingItemList::~CAknSettingItemList

(

)

Destructor.

Member Function Documentation

IMPORT_C CCoeControl* CAknSettingItemList::ComponentControl

(

TInt

aId

)

const

Parameters:

TInt

aId

Returns:: a reference to the component control at index aId

IMPORT_C void CAknSettingItemList::ConstructFromResourceL

(

TResourceReader &

aReader

)

2nd-stage construction from constructed resource reader

IMPORT_C void CAknSettingItemList::ConstructFromResourceL

(

TInt

aResourceId

)

2nd-stage construction from resource id

IMPORT_C TInt CAknSettingItemList::CountComponentControls

(

)

const

Returns:: the number of component controls

virtual IMPORT_C CAknSettingItem* CAknSettingItemList::CreateSettingItemL ( TInt aSettingId ) [protected, virtual]

Framework method to create a setting item based upon the user id aSettingId.

The client code decides what type to contruct. new (ELeave) must then be used and the resulting pointer returned. Ownership is thereafter base class's responsiblity.

Parameters:

aSettingId

ID to use to determine the type of the setting item

Returns:: a constructed (not 2nd-stage constructed) setting item.

virtual IMPORT_C void CAknSettingItemList::EditItemL	(	TInt	aIndex,
		TBool	aCalledFromMenu
	)	`[virtual]`

This launches the setting page for the current item by calling EditItemL on it.

Parameters:

aIndex

- current item's (Visible) index in the list aCalledFromMenu- ignored in most classes; may alter the behaviour of the setting page

virtual IMPORT_C void CAknSettingItemList::FocusChanged ( TDrawNow aDrawNow ) [virtual]

Take action necessary when the focus is change.

IMPORT_C void CAknSettingItemList::HandleChangeInItemArrayOrVisibilityL

(

)

Method to be called when the client code has added or removed items or their visibility; This should be called when a single event's batch of array or visibility changes is complete in order to avoid more re-draws than is necessary.

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

IMPORT_C void CAknSettingItemList::HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

From CCoeControl.

Handles pointer events

IMPORT_C void CAknSettingItemList::HandleResourceChange

(

TInt

aType

)

Handles a change to the control's resources of type aType which are shared across the environment, e.g.

colors or fonts.

Parameters:

aType

Reason for the "resource" change, usually an system event UID

IMPORT_C TBool CAknSettingItemList::IsNumberedStyle

(

)

Returns:: EFalse if the listbox is not numbered style; Not EFalse otherwise

IMPORT_C CEikFormattedCellListBox* CAknSettingItemList::ListBox

(

)

Returns:: the listbox used by setting item list

virtual IMPORT_C void CAknSettingItemList::LoadSettingsL ( ) [virtual]

Calls LoadL() on each item in the MAknSettingItemArray.

virtual IMPORT_C TKeyResponse CAknSettingItemList::OfferKeyEventL	(	const TKeyEvent &	aKeyEvent,
		TEventCode	aType
	)	`[virtual]`

Handles keys sent to this control.

IMPORT_C void CAknSettingItemList::SetIncludeHiddenInOrdinal

(

TBool

aInclude

)

Parameters:

aInclude

If EFalse, numbering does not include hidden items Otherwise, they are

IMPORT_C CAknSettingItemArray* CAknSettingItemList::SettingItemArray

(

)

const

Returns:: a pointer to the setting item array; No ownership is transferred

virtual IMPORT_C void CAknSettingItemList::StoreSettingsL ( ) [virtual]

This command calls StoreL on all the setting items (hidden or not).

This must be called by the client if he wants it to occur

The documentation for this class was generated from the following file:

aknsettingitemlist.h

CAknSettingItemList Class Reference

Capability Information

Public Types

Public Member Functions

Protected Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation