CLmkCategorySelectorDlg Class Reference

API published in: S60 3rd Ed

Link against: lmkcommonui.lib

Capability Information

Required Capabilities

LocalServices Location NetworkServices ReadUserData WriteUserData

Exceptions

None

Other Information

None

#include <clmkcategoryselectordlg.h>

Detailed Description

This is a dialog class, which is used to launch category selector dialog and to get the selected category ids.It displays the categories present in landmarks database,as a list.The dialog can be a single selector or multiple selector dialog, depending upon argument passed by the client (in ExecuteLD function) at the time when it is launched.Based on whether it is a single selector or multiple selector dialog, user can select single category or multiple categories.

Public Member Functions
IMPORT_C  ~CLmkCategorySelectorDlg ()
  Destructor.
IMPORT_C void  SetMopParent (MObjectProvider *aParent)
  This function sets the context - that is, the enclosing parent control - for this control.
IMPORT_C TInt  ExecuteLD (TLmkItemIdDbCombiInfo &aSelected)
  This function launches the category selector dialog.Client use this function to launch single category selector dialog.
IMPORT_C TInt  ExecuteLD (RArray< TLmkItemIdDbCombiInfo > &aSelectedItems)
  This function launches the category selector dialog.Client use this function to launch multiple category selector dialog.

Static Public Member Functions
static IMPORT_C CLmkCategorySelectorDlg *  NewL (TBool aShowEmptyCategories=EFalse)
  This is a static function, which create and return an instance of this class.

Constructor & Destructor Documentation

IMPORT_C CLmkCategorySelectorDlg::~CLmkCategorySelectorDlg (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C TInt CLmkCategorySelectorDlg::ExecuteLD (  RArray< TLmkItemIdDbCombiInfo > &  aSelectedItems  ) 
 

This function launches the category selector dialog.Client use this function to launch multiple category selector dialog.

This object is destroyed when this function returns or leaves. If the array(aSelectedItems) is passed with already filled cateogry ids, then such categories will be shown as selected when the dialog is launched,but if any of these ids do not exist in landmarks database,will be ignored.

Parameters:
[in/out]  aSelectedItems Passed as reference,either filled with category ids for pre-selection or an empty array.On return of the function contains the selected category ids.
Leave:
Leaves with system-wide leave codes.
Panic:
Panics with KLmkPanicNullMember, if the selector is not constructed properly.
Returns:
Returns non-zero if accepted, else zero.
IMPORT_C TInt CLmkCategorySelectorDlg::ExecuteLD (  TLmkItemIdDbCombiInfo &  aSelected  ) 
 

This function launches the category selector dialog.Client use this function to launch single category selector dialog.

This object is destroyed when this function returns or leaves.

Parameters:
[in/out]  aSelected Passed as reference and when the function returns, contains the selected category id.
Leave:
Leaves with system-wide leave codes.
Panic:
Panics with KLmkPanicNullMember, if the selector is not constructed properly.
Returns:
Returns non-zero if accepted, else zero.
static IMPORT_C CLmkCategorySelectorDlg* CLmkCategorySelectorDlg::NewL (  TBool  aShowEmptyCategories = EFalse  )  [static]
 

This is a static function, which create and return an instance of this class.

Categories present in the landmark database, are shown in selector.

Parameters:
[in]  aShowEmptyCategories  specifies whether categories without landmarks are shown or not
Leave:
Leaves with KErrNotSupported if framework functionality is not available.
Panic:
Panics with system-wide panic codes.
Returns:
new instance of this class
IMPORT_C void CLmkCategorySelectorDlg::SetMopParent (  MObjectProvider *  aParent  ) 
 

This function sets the context - that is, the enclosing parent control - for this control.

Parameters:
[in]  aParent  The parent object which is the context for the control.
Panic:
Panics with KLmkPanicNullMember, if the selector is not constructed properly.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top