CAknRadioButtonSettingPage Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknradiobuttonsettingpage.h>

Inherits CAknListBoxSettingPage.

Detailed Description

This class sets out a radio button listbox within a setting page.

Public Member Functions
IMPORT_C  CAknRadioButtonSettingPage (TInt aResourceID, TInt &aCurrentSelectionIndex, const MDesCArray *aItemArray)
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.
virtual IMPORT_C void  ConstructL ()
  2nd stage contruction for this type.
IMPORT_C CAknSetStyleListBox *  ListBoxControl () const
  Type specific access to the hosted "editor".
virtual IMPORT_C void  HandleListBoxEventL (CEikListBox *aListBox, MEikListBoxObserver::TListBoxEvent aEventType)
  From MEikListBoxObserver.
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  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  From CCoeControl Handles Radiobuttonlist's PointerEvent.
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  ~CAknRadioButtonSettingPage ()
  C++ destructor.
virtual IMPORT_C void  UpdateSettingL ()
  Called when the external setting is to be updated.
IMPORT_C void  DynamicInitL ()
  Called immediately prior to activation, but after all construction.
virtual IMPORT_C void  SelectCurrentItemL ()
  This method overrides the default implementation in order to do the special processing of selecting an item.
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 CAknRadioButtonSettingPage::CAknRadioButtonSettingPage (  TInt  aResourceID,
TInt &  aCurrentSelectionIndex,
const MDesCArray *  aItemArray
) 
 
IMPORT_C CAknRadioButtonSettingPage::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.

Parameters:
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
virtual IMPORT_C CAknRadioButtonSettingPage::~CAknRadioButtonSettingPage (   )  [protected, virtual]
 

C++ destructor.

Member Function Documentation

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

2nd stage contruction for this type.

Calls CAknSettingPage::BaseConstuctL() where the object is constructed from resource.

Reimplemented from CAknSettingPage.

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

Called immediately prior to activation, but after all construction.

Reimplemented from CAknSettingPage.

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

From MEikListBoxObserver.

Parameters:
listbox  generating the event
type  of listbox event

Implements MEikListBoxObserver.

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

From CCoeControl Handles Radiobuttonlist's PointerEvent.

Parameters:
aPointerEvent  PointerEvent to be handled

Reimplemented from CAknSettingPage.

IMPORT_C void CAknRadioButtonSettingPage::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* CAknRadioButtonSettingPage::ListBoxControl (   )  const [virtual]
 

Type specific access to the hosted "editor".

Returns:
pointer to contained listbox

Implements CAknListBoxSettingPage.

virtual IMPORT_C void CAknRadioButtonSettingPage::SelectCurrentItemL (   )  [protected, virtual]
 

This method overrides the default implementation in order to do the special processing of selecting an item.

Reimplemented from CAknSettingPage.

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

Parameters:
CDesCArrayFlat*  aItemArray The new item array; array of texts
TInt  aPushed A valid 0-based index. -1 is also legal indicating nothing is pushed
virtual IMPORT_C void CAknRadioButtonSettingPage::UpdateSettingL (   )  [protected, virtual]
 

Called when the external setting is to be updated.

Reimplemented from CAknSettingPage.

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