CAknPopupSettingList Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknpopupsettingpage.h>

Inherits CAknSetStyleListBox, and MEikListBoxObserver.

Detailed Description

Represents menu list that appears in a popped up setting item.

Public Member Functions
IMPORT_C  CAknPopupSettingList ()
  Standard constructor.
IMPORT_C  ~CAknPopupSettingList ()
  Destructor.
IMPORT_C void  ConstructL ()
  2nd phase construction
IMPORT_C void  SetAllowsUserDefinedEntry (TBool aAllows)
  Sets flag that enables user defined entry.
IMPORT_C void  SetQueryValueL (MAknQueryValue *aValue)
  Used by the client to set the query value used to represent the user defined value belonging to this popup field control.
IMPORT_C void  SetShowIndicators (TBool aShowIndicators)
  Set the flag which determines whether the indicators are shown In practice the indicators have the appearance of radio buttons.
IMPORT_C TInt  NumLines () const
  number of lines used
IMPORT_C void  SetPopupSettingListObserver (MAknPopupSettingListObserver *aObserver)
  set an observer of this class to receive events from popup setting list
IMPORT_C void  ConstructFromResourceL (TResourceReader &aReader)
  from CCoeControl Construct from resources.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  From CCoeControl.
IMPORT_C void  HandleResourceChange (TInt aType)
  From CCoeControl.

Protected Member Functions
IMPORT_C void  CreateMenuListL ()
  Create the popup list.
IMPORT_C void  ActivateMenuListL ()
  Causes the list of pre-defined values to appear.
IMPORT_C void  ConfigureMenuListL ()
  This routine sets up the text arrays for the menu list.
IMPORT_C void  DestroyMenuList ()
  All this does now is remove this from the stack.
IMPORT_C void  HandleListBoxEventL (CEikListBox *aListBox, TListBoxEvent aEventType)
  From MEikListBoxObserver Processes key events from the listbox.

Constructor & Destructor Documentation

IMPORT_C CAknPopupSettingList::CAknPopupSettingList (   ) 
 

Standard constructor.

IMPORT_C CAknPopupSettingList::~CAknPopupSettingList (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C void CAknPopupSettingList::ActivateMenuListL (   )  [protected]
 

Causes the list of pre-defined values to appear.

Use this method to activate the pop-up field from a menu option command. Note that the desired control must have the focus before it can be activated.

IMPORT_C void CAknPopupSettingList::ConfigureMenuListL (   )  [protected]
 

This routine sets up the text arrays for the menu list.

IMPORT_C void CAknPopupSettingList::ConstructFromResourceL (  TResourceReader &  aReader  )  [virtual]
 

from CCoeControl Construct from resources.

Parameters:
aReader  constucted and positioned TResourceReader&

Reimplemented from CEikFormattedCellListBox.

IMPORT_C void CAknPopupSettingList::ConstructL (   ) 
 

2nd phase construction

IMPORT_C void CAknPopupSettingList::CreateMenuListL (   )  [protected]
 

Create the popup list.

IMPORT_C void CAknPopupSettingList::DestroyMenuList (   )  [protected]
 

All this does now is remove this from the stack.

IMPORT_C void CAknPopupSettingList::HandleListBoxEventL (  CEikListBox *  aListBox,
TListBoxEvent  aEventType
)  [protected]
 

From MEikListBoxObserver Processes key events from the listbox.

Responds to EEventEnterKeyPressed to accept the pop-up.

Parameters:
aListBox  Listbox being observed
aEventType  Event observed
This implementation is vestige of former implementation when the listbox was wrapped up, not derived from. Currently observing itself..
IMPORT_C void CAknPopupSettingList::HandlePointerEventL (  const TPointerEvent &  aPointerEvent  )  [virtual]
 

From CCoeControl.

Handles pointer event

Parameters:
aPointerEvent  Pointer event to be handled

Reimplemented from CAknSetStyleListBox.

IMPORT_C void CAknPopupSettingList::HandleResourceChange (  TInt  aType  )  [virtual]
 

From CCoeControl.

Handles a change to the control's resources.

Parameters:
aType  A message UID value.

Reimplemented from CEikFormattedCellListBox.

IMPORT_C TInt CAknPopupSettingList::NumLines (   )  const
 

number of lines used

Returns:
number of lines being currently displayed by control, which is determined by the number of entries on the selection list, and whether the selection list is active. NOTE that the number is limited by KAknMaxLinesOnOnePage
IMPORT_C void CAknPopupSettingList::SetAllowsUserDefinedEntry (  TBool  aAllows  ) 
 

Sets flag that enables user defined entry.

Note that flag can also be set from resources, but this method allows behaviour to be changed at runtime.

Parameters:
aAllows  if ETrue, set flag; if EFalse, clear flag.
IMPORT_C void CAknPopupSettingList::SetPopupSettingListObserver (  MAknPopupSettingListObserver *  aObserver  ) 
 

set an observer of this class to receive events from popup setting list

Parameters:
aObserver  pointer to the class that implements the observer interface,
IMPORT_C void CAknPopupSettingList::SetQueryValueL (  MAknQueryValue *  aValue  ) 
 

Used by the client to set the query value used to represent the user defined value belonging to this popup field control.

Parameters:
aValue  pointer to value, ownership is not passed
IMPORT_C void CAknPopupSettingList::SetShowIndicators (  TBool  aShowIndicators  ) 
 

Set the flag which determines whether the indicators are shown In practice the indicators have the appearance of radio buttons.

Parameters:
aShowIndicators  If ETrue, indicators are displayed; if EFalse, indicators are not displayed
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top