CAknPopupSettingPage Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None


#include <aknpopupsettingpage.h>

Inherits CAknListBoxSettingPage, and MAknPopupSettingListObserver.


Detailed Description

Interface for the setting page containing a menu list with a Query value data model This is the more generic of the list-style setting pages.

Public Member Functions

IMPORT_C  CAknPopupSettingPage (TInt aResourceID, MAknQueryValue &aQueryValue)
  C++ constructor.
IMPORT_C  CAknPopupSettingPage (const TDesC *aSettingTitleText, TInt aSettingNumber, TInt aControlType, TInt aEditorResourceId, TInt aSettingPageResourceId, MAknQueryValue &aQueryValue)
  Constructor that allows separate setting page and editor resources.
virtual IMPORT_C void  ConstructL ()
  2nd stage construction method.
IMPORT_C CAknSetStyleListBox ListBoxControl () const
  Access to the contained listbox (inside popup setting list).
IMPORT_C CAknPopupSettingList PopupSettingListBox () const
  Access to the editor control.
virtual IMPORT_C void  HandlePopupSettingListEventL (CAknPopupSettingList *aPopupSettingList, TAknPopupSettingListEvent aEventType, TInt aHint)
  From MAknPopupSettingListObserver Handle events from the popup field control, such as when it changes between selection list mode and label mode.
IMPORT_C void  UpdateQueryValueL (MAknQueryValue *aQueryValue)
  Can be used dynamically to set a new query value.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  From CCoeControl.

Protected Member Functions

virtual IMPORT_C  ~CAknPopupSettingPage ()
  C++ destructor.
IMPORT_C MAknQueryValue QueryValue () const
  This is required to give access to the QueryValue data member from re-implementations of the popup setting page.
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.
virtual IMPORT_C void  Reserved_2 ()
  Reserved method derived from CCoeControl.

Constructor & Destructor Documentation

IMPORT_C CAknPopupSettingPage::CAknPopupSettingPage TInt  aResourceID,
MAknQueryValue aQueryValue
 

C++ constructor.

This constructor uses just the setting page resource Id to construct the setting page, using listbox resource contained in the setting page resource.

Parameters:
aResourceId  a resource identifier for a AVKON_SETTING_PAGE resource
aQueryValue  a reference to a query value object
IMPORT_C CAknPopupSettingPage::CAknPopupSettingPage const TDesC *  aSettingTitleText,
TInt  aSettingNumber,
TInt  aControlType,
TInt  aEditorResourceId,
TInt  aSettingPageResourceId,
MAknQueryValue aQueryValue
 

Constructor that allows separate setting page and editor resources.

This constructor allows the use of setting page using only the editor resource. Other combinations are also possible

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 (Effectively like the other constructor) present = 0 Default Avkon SP resource if used + this editor resource = 0 = 0 uses default resource for both SP and editor. This is OK if: i) control type is present, ii) a default resource exists ( OK for text, integer, date, time, duration )

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 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)
aQueryValue  reference to a query value object
virtual IMPORT_C CAknPopupSettingPage::~CAknPopupSettingPage  )  [protected, virtual]
 

C++ destructor.


Member Function Documentation

virtual IMPORT_C void CAknPopupSettingPage::ConstructL  )  [virtual]
 

2nd stage construction method.

Type specific work is done here; most of the setting page constuction is performed in a call the base contstruction of CAknSettingPage

Reimplemented from CAknSettingPage.

IMPORT_C void CAknPopupSettingPage::HandlePointerEventL const TPointerEvent &  aPointerEvent  ) 
 

From CCoeControl.

Reimplemented from CAknSettingPage.

virtual IMPORT_C void CAknPopupSettingPage::HandlePopupSettingListEventL CAknPopupSettingList aPopupSettingList,
TAknPopupSettingListEvent  aEventType,
TInt  aHint
[virtual]
 

From MAknPopupSettingListObserver Handle events from the popup field control, such as when it changes between selection list mode and label mode.

Parameters:
aPopupSettingList  pointer to the popup field control that generated the event
aEventType  the type of event
aHint  for possible future use
IMPORT_C CAknSetStyleListBox* CAknPopupSettingPage::ListBoxControl  )  const [virtual]
 

Access to the contained listbox (inside popup setting list).

Returns:
CAknSetStyleListBox* pointer to the listbox used in the setting page; Does not transfer ownership

Implements CAknListBoxSettingPage.

IMPORT_C CAknPopupSettingList* CAknPopupSettingPage::PopupSettingListBox  )  const
 

Access to the editor control.

Returns:
CAknPopupSettingList* a reference to the contained "editor" as a listbox; no ownership transferred
IMPORT_C MAknQueryValue* CAknPopupSettingPage::QueryValue  )  const [protected]
 

This is required to give access to the QueryValue data member from re-implementations of the popup setting page.

Returns:
MAknQueryValue* a pointer to the query value object
virtual IMPORT_C void CAknPopupSettingPage::Reserved_2  )  [protected, virtual]
 

Reserved method derived from CCoeControl.

Reimplemented from CAknSettingPage.

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

Reimplemented from CAknSettingPage.

IMPORT_C void CAknPopupSettingPage::UpdateQueryValueL MAknQueryValue aQueryValue  ) 
 

Can be used dynamically to set a new query value.

This manages the setting up of the new PopupSettingList and its listbox, and also the resizing and redrawing of the setting page Note that all former query value objects and its associated arrays are owned by the client and if no longer used, should be deleted.

Parameters:
MAknQueryValue*  aQueryValue - the new value; no transfer of ownership
virtual IMPORT_C void CAknPopupSettingPage::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