CLmkLandmarkSelectorDlg Class Reference
#include
<app/CLmkLandmarkSelectorDlg.h>
Link against: LmkCommonUi.lib
| class CLmkLandmarkSelectorDlg : public CBase |
Detailed Description
This is a dialog class, which is used to launch landmark selector dialog and to get the selected landmark ids.It displays the landmarks 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 landmark or multiple landmarks.
Constructor & Destructor Documentation
~CLmkLandmarkSelectorDlg ( )
| IMPORT_C | ~CLmkLandmarkSelectorDlg | ( | ) | |
Member Function Documentation
ExecuteLD ( TLmkItemIdDbCombiInfo & )
This function launches the landmark selector dialog. Client uses this function to launch single landmark selector dialog. This object is destroyed when this function returns or leaves.
- 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.
ExecuteLD ( RArray< TLmkItemIdDbCombiInfo > & )
This function launches the landmark selector dialog. Client uses this function to launch multiple landmark selector dialog. This object is destroyed when this function returns or leaves. If the array(aSelectedItems) is passed with already filled landmark ids, then such landmarks will be shown as selected when the dialog is launched, but if any of these ids do not exist in landmarks database, it will be ignored.
-
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.
NewL ( )
This is a static function, which creates and returns an instance of this class. All the landmarks present in the landmark database are shown in the selector.
-
leave
- Leaves with KErrNotSupported if framework functionality is not available.
-
panic
- Panics with system-wide panic codes.
Returns: new instance of this class
NewL ( const TDesC & )
This is a static function, which creates and returns an instance of this class. All the landmarks present in the user specified landmark database are shown in the selector.
- leave
- Leaves with KErrNotSupported if framework functionality is not available or the protocol specified in URI is not supported.
- leave
- Leaves with KErrArgument if an empty string is passed as argument or extension of the local database name is not "ldb".
- panic
- Panics with system-wide panic codes.
| Parameter | Description | | aDatabaseUri | The URI of the databases to open. |
Returns: new instance of this class
SetDialogTitleL ( const TDesC & )
| IMPORT_C void | SetDialogTitleL | ( | const TDesC & | aTitle | ) | |
This function sets the title string of the landmark selector dialog. This function has to be called before ExecuteLD() to make the set title appear on ui. Calling this api after ExecuteLD() will not have any impact.
-
panic
- Panics with KLmkPanicNullMember, if the selector is not constructed properly.
| Parameter | Description | | aTitle | The title string of the selector dialog. |
SetMopParent ( MObjectProvider * )
| IMPORT_C void | SetMopParent | ( | MObjectProvider * | aParent | ) | |
This function sets the context - that is, the enclosing parent control - for this control.
-
panic
- Panics with KLmkPanicNullMember, if the selector is not constructed properly.
| Parameter | Description | | aParent | The parent object which is the context for the control. |