| class CAknPopupList : public CEikBorderedControl |
Used to popup a list or grid. Takes an existing listbox control and puts it into a popup frame together with an optional title.
CAknPopupList is not a dialog!
There are two standard usages of CAknPopupList:
CAknPopupList *plist = CAknPopupList::NewL(...);
CleanupStack::PushL(plist);
...
TInt popupOk = plist->ExecuteLD(...);
// No leaving functions allowed between ExecuteLD and
// CleanupStack::Pop().
CleanupStack::Pop(); // plist
if (popupOk) { ... } else { ... }
iPList = CAknPopupList::NewL(...);
...
TInt popupOk = iPlist->ExecuteLD(...);
// No leaving functions allowed between ExecuteLD and iPlist=NULL;
iPlist = NULL;
if (popupOk) {... } else {... }
// note, destructor deletes the iPlist instance.
Both these work corretly and leave-safe way. Notice this usage is pretty different of how dialogs work. With dialogs you _always_ want to do CleanupStack::Pop() before calling ExecuteLD().
| Public Member Functions | |
|---|---|
| IMPORT_C CEikButtonGroupContainer * | ButtonGroupContainer() |
| IMPORT_C void | CancelPopup() |
| IMPORT_C TBool | EnableAdaptiveFind(TBool) |
| IMPORT_C TBool | EnableFind(TBool) |
| IMPORT_C TBool | ExecuteLD() |
| IMPORT_C CAknSearchField * | FindBox() |
| IMPORT_C void | HandlePointerEventL(const TPointerEvent &) |
| IMPORT_C CAknPopupHeadingPane * | Heading() |
| IMPORT_C CAknPopupHeadingPane * | Heading() |
| IMPORT_C CEikListBox * | ListBox() |
| IMPORT_C CAknPopupList * | NewL(CEikListBox *, TInt, AknPopupLayouts::TAknPopupLayouts) |
| IMPORT_C void | SetMaximumHeight(TInt) |
| IMPORT_C void | SetTitleL(const TDesC &) |
| Protected Member Functions | |
|---|---|
| CAknPopupList() | |
| ~CAknPopupList() | |
| IMPORT_C void | AttemptExitL(TBool) |
| IMPORT_C void | ConstructL(CEikListBox *, TInt, AknPopupLayouts::TAknPopupLayouts) |
| IMPORT_C void | FadeBehindPopup(TBool) |
| IMPORT_C void | HandleControlEventL(CCoeControl *, TCoeEvent) |
| IMPORT_C void | HandleListBoxEventL(CEikListBox *, TListBoxEvent) |
| IMPORT_C void | HandleResourceChange(TInt) |
| IMPORT_C const TAknPopupWindowLayoutDef & | Layout() |
| IMPORT_C TAknPopupWindowLayoutDef & | Layout() |
| IMPORT_C CEikListBox * | ListBox() |
| IMPORT_C TTypeUid::Ptr | MopSupplyObject(TTypeUid) |
| IMPORT_C void | ProcessCommandL(TInt) |
| IMPORT_C void | SetupWindowLayout(AknPopupLayouts::TAknPopupLayouts) |
| Private Member Functions | |
|---|---|
| IMPORT_C void | CloseState() |
| IMPORT_C CCoeControl * | ComponentControl(TInt) |
| IMPORT_C TInt | CountComponentControls() |
| IMPORT_C TInt | CountFadedComponents() |
| IMPORT_C void | Draw(const TRect &) |
| IMPORT_C void * | ExtensionInterface(TUid) |
| IMPORT_C CCoeControl * | FadedComponent(TInt) |
| IMPORT_C void | FocusChanged(TDrawNow) |
| IMPORT_C TSize | MinimumSize() |
| IMPORT_C TKeyResponse | OfferKeyEventL(const TKeyEvent &, TEventCode) |
| void | RemoveFindFiltering() |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
| Private Attributes | |
|---|---|
| CAknPopupListExtension * | iPopupListExtension |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| CEikBorderedControl::iBorder | |
| IMPORT_C void | AttemptExitL | ( | TBool | aAccept | ) | [protected, virtual] |
Called when the user accepts or cancels the listbox.
| TBool aAccept | ETrue if the user has accepted, EFalse if the user has cancelled the listbox. |
| IMPORT_C CEikButtonGroupContainer * | ButtonGroupContainer | ( | ) |
Gets a button group container.
The button group.
| IMPORT_C void | CancelPopup | ( | ) |
Cancels the current popup. The popup ExecuteLD will return with EFalse.
| IMPORT_C CCoeControl * | ComponentControl | ( | TInt | aIndex | ) | const [private, virtual] |
| TInt aIndex |
| IMPORT_C void | ConstructL | ( | CEikListBox * | aListBox, |
| TInt | aCbaResource, | |||
| AknPopupLayouts::TAknPopupLayouts | aType | |||
| ) | [protected] | |||
Handles 2nd phase construction.
| CEikListBox * aListBox | Pre-existing listbox-derived class. |
| TInt aCbaResource | Softkey pane to display while pop-up is active. |
| AknPopupLayouts::TAknPopupLayouts aType | The layout used. |
| IMPORT_C void | Draw | ( | const TRect & | aRect | ) | const [private, virtual] |
From CCoeControl. Draws the border around the control. This function also clears the central area if the IsBlank() method returns ETrue.
From CCoeControl
| const TRect & aRect | Not used. |
| IMPORT_C TBool | EnableAdaptiveFind | ( | TBool | aEnable = ETrue | ) |
Enables the findbox with adaptive search of the popup list.
5.0
ETrue if enabling/disabling was successfull.
| TBool aEnable = ETrue | Enables (default) or disables the adaptive findbox. |
| IMPORT_C TBool | EnableFind | ( | TBool | aEnable = ETrue | ) |
Enables the findbox of the popup list.
ETrue if enabling/disabling was successfull.
| TBool aEnable = ETrue | Enables (default) or disables the findbox. |
| IMPORT_C TBool | ExecuteLD | ( | ) |
Executes the pop-up selection list. Function returns when the user have accepted or cancelled the pop-up.
ETrue if the popup was accepted. EFalse if the popup was cancelled.
| IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
From CAknControl
| TUid aInterface |
| IMPORT_C CCoeControl * | FadedComponent | ( | TInt | aIndex | ) | [private, virtual] |
| TInt aIndex |
| IMPORT_C CAknSearchField * | FindBox | ( | ) | const |
Gets the search field control.
Search field control.
| IMPORT_C void | FocusChanged | ( | TDrawNow | aDrawNow | ) | [private, virtual] |
| TDrawNow aDrawNow |
| IMPORT_C void | HandleControlEventL | ( | CCoeControl * | aControl, |
| TCoeEvent | aEventType | |||
| ) | [protected] | |||
From MCoeControlObserver.
Handles an event from an observed control.
| CCoeControl * aControl | Control being observed. |
| TCoeEvent aEventType | Event observed. |
| IMPORT_C void | HandleListBoxEventL | ( | CEikListBox * | aListBox, |
| TListBoxEvent | aEventType | |||
| ) | [protected] | |||
From MEikListBoxObserver.
Processes key events from the listbox. Responds to EEventEnterKeyPressed to accept the pop-up.
| CEikListBox * aListBox | Listbox being observed. |
| TListBoxEvent aEventType | Event being observed. |
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
From CCoeControl.
Handles pointer events of popups.
| const TPointerEvent & aPointerEvent | Pointer event to be handled. |
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [protected, virtual] |
From CCoeControl.
Handles a change to the control's resources.
| TInt aType | A message UID value. |
| IMPORT_C CAknPopupHeadingPane * | Heading | ( | ) |
Gets the popup header.
Header properties of the pop-up menu.
| IMPORT_C CAknPopupHeadingPane * | Heading | ( | ) | const |
Gets the popup header.
Header properties of the pop-up menu.
| IMPORT_C const TAknPopupWindowLayoutDef & | Layout | ( | ) | const [protected] |
Gets the layout definitions for the popup list.
Collects all LAF specification lines that are needed for popup windows.
| IMPORT_C TAknPopupWindowLayoutDef & | Layout | ( | ) | [protected] |
Gets the layout definitions for the popup list.
Collects all LAF specification lines that are needed for popup windows.
| IMPORT_C CEikListBox * | ListBox | ( | ) | const [protected] |
Returns the listbox being used.
Listbox contained in the pop-up.
| IMPORT_C TTypeUid::Ptr | MopSupplyObject | ( | TTypeUid | aId | ) | [protected] |
From MopSupplyObject.
Retrieves an object of the same type as that encapsulated in aId.
Encapsulates the pointer to the object provided. Note that the encapsulated pointer may be NULL.
| TTypeUid aId | Encapsulated object type ID. |
| IMPORT_C CAknPopupList * | NewL | ( | CEikListBox * | aListBox, |
| TInt | aCbaResource, | |||
| AknPopupLayouts::TAknPopupLayouts | aType = AknPopupLayouts::EMenuWindow | |||
| ) | [static] | |||
Two-phased constructor.
Creates the pop-up list.
A pointer to a pop-up list object.
| CEikListBox * aListBox | Pre-existing listbox-derived class. |
| TInt aCbaResource | Softkey pane to display while pop-up is active. |
| AknPopupLayouts::TAknPopupLayouts aType = AknPopupLayouts::EMenuWindow | The layout used. |
| IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
| TEventCode | aType | |||
| ) | [private, virtual] | |||
| const TKeyEvent & aKeyEvent | |
| TEventCode aType |
| IMPORT_C void | ProcessCommandL | ( | TInt | aCommandId | ) | [protected] |
From MEikCommandObserver.
Processes events from the softkeys. Responds to EAknSoftkeyOk and EAknSoftkeyBack to accept or cancel the pop-up.
| TInt aCommandId | Event Id from the soft-key. |
| IMPORT_C void | SetMaximumHeight | ( | TInt | aItems | ) |
Sets the maximum height for the popup frame.
| TInt aItems | The maximum height. |
| IMPORT_C void | SetTitleL | ( | const TDesC & | aTitle | ) |
Sets the title for the selection list.
| const TDesC & aTitle | Title to be displayed. |
| IMPORT_C void | SetupWindowLayout | ( | AknPopupLayouts::TAknPopupLayouts | aType | ) | [protected, virtual] |
Setup the whole window layout; window position, grid and heading position, shadow for the window.
| AknPopupLayouts::TAknPopupLayouts aType | A choice of layout. |
| TAknPopupWindowLayoutDef | iLayout | [protected] |
collects all LAF specification lines that are needed for popup window.
| CEikButtonGroupContainer * | iPopoutCba | [protected] |
A button group container - a wrapper around the different button arrays.
| CAknPopupHeadingPane * | iTitle | [protected] |
Header control for queries. Defines properties of the header of the pop-up menu.
| AknPopupLayouts::TAknPopupLayouts | iWindowType | [protected] |
Popup layout type.