CAknCheckBoxSettingPage Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <akncheckboxsettingpage.h>

Inherits CAknListBoxSettingPage.

Detailed Description

Setting Page class supporting multiple selection.

Interface is via a CSelectionItemList array


Public Member Functions
IMPORT_C  CAknCheckBoxSettingPage (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.
virtual IMPORT_C void  ConstructL ()
  2nd phase constructor
IMPORT_C CAknSetStyleListBox *  ListBoxControl () const
  Access to ListBoxControl.
IMPORT_C void  SetSelectionItemArrayL (CSelectionItemList *aItemArray)
  Method to update the item array after a change in content.
virtual IMPORT_C void  HandleListBoxEventL (CEikListBox *aListBox, MEikListBoxObserver::TListBoxEvent aEventType)
  Observer callback from the listbox.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  From CCoeControl Handles pointer events.
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.

Protected Member Functions
virtual IMPORT_C  ~CAknCheckBoxSettingPage ()
  Destructor.
virtual IMPORT_C void  UpdateSettingL ()
  Called when the setting is updated.
IMPORT_C void  DynamicInitL ()
  Called when the setting page is about to be displayed.
virtual IMPORT_C void  ProcessCommandL (TInt aCommandId)
  From MEikCommandObserver Processes events from the softkeys.
virtual IMPORT_C void  SelectCurrentItemL ()
  This method should be implemented in listbox classes to move the selection in listbox editors prior to exiting from the setting page.
virtual IMPORT_C void  WriteInternalStateL (RWriteStream &aWriteStream) const
  Writes the internal state of the control and its components to aStream.

Constructor & Destructor Documentation

IMPORT_C CAknCheckBoxSettingPage::CAknCheckBoxSettingPage (  TInt  aResourceID,
CSelectionItemList *  aItemArray
) 
 
IMPORT_C CAknCheckBoxSettingPage::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.

Parameters:
aSettingTitleText  Text at top of setting pane
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)
aItemArray  List of option texts and their selection states
virtual IMPORT_C CAknCheckBoxSettingPage::~CAknCheckBoxSettingPage (   )  [protected, virtual]
 

Destructor.

Member Function Documentation

virtual IMPORT_C void CAknCheckBoxSettingPage::ConstructL (   )  [virtual]
 

2nd phase constructor

Reimplemented from CAknSettingPage.

IMPORT_C void CAknCheckBoxSettingPage::DynamicInitL (   )  [protected, virtual]
 

Called when the setting page is about to be displayed.

Reimplemented from CAknSettingPage.

virtual IMPORT_C void CAknCheckBoxSettingPage::HandleListBoxEventL (  CEikListBox *  aListBox,
MEikListBoxObserver::TListBoxEvent  aEventType
)  [virtual]
 

Observer callback from the listbox.

Parameters:
aListBox  ptr to listbox that is calling the method
aEventType  type of event; defined by MEikListBoxObserver

Implements MEikListBoxObserver.

IMPORT_C void CAknCheckBoxSettingPage::HandlePointerEventL (  const TPointerEvent &  aPointerEvent  ) 
 

From CCoeControl Handles pointer events.

Reimplemented from CAknSettingPage.

IMPORT_C void CAknCheckBoxSettingPage::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

Reimplemented from CAknSettingPage.

IMPORT_C CAknSetStyleListBox* CAknCheckBoxSettingPage::ListBoxControl (   )  const [virtual]
 

Access to ListBoxControl.

Returns:
pointer to listbox used by the setting page; No transfer of ownership

Implements CAknListBoxSettingPage.

virtual IMPORT_C void CAknCheckBoxSettingPage::ProcessCommandL (  TInt  aCommandId  )  [protected, virtual]
 

From MEikCommandObserver Processes events from the softkeys.

Responds to EAknSoftkeyOk and EAknSoftkeyBack to accept or cancel the pop-up.

Parameters:
aCommandId  Event Id from the soft-key

Reimplemented from CAknSettingPage.

virtual IMPORT_C void CAknCheckBoxSettingPage::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.

Reimplemented from CAknSettingPage.

IMPORT_C void CAknCheckBoxSettingPage::SetSelectionItemArrayL (  CSelectionItemList *  aItemArray  ) 
 

Method to update the item array after a change in content.

Parameters:
CSelectionItemList*  aItemArray The new array of selectable items
virtual IMPORT_C void CAknCheckBoxSettingPage::UpdateSettingL (   )  [protected, virtual]
 

Called when the setting is updated.

Reimplemented from CAknSettingPage.

virtual IMPORT_C void CAknCheckBoxSettingPage::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.

Parameters:
aWriteSteam  A connected write stream

Reimplemented from CAknSettingPage.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top