Symbian^3 Application Developer Library >

CLmkLandmarkSelectorDlg Class Reference

class CLmkLandmarkSelectorDlg : public CBase

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.

Inherits from

Public Member Functions
~CLmkLandmarkSelectorDlg ()
IMPORT_C TInt ExecuteLD ( TLmkItemIdDbCombiInfo &)
IMPORT_C TInt ExecuteLD ( RArray < TLmkItemIdDbCombiInfo > &)
IMPORT_C CLmkLandmarkSelectorDlg * NewL ()
IMPORT_C CLmkLandmarkSelectorDlg * NewL (const TDesC &)
IMPORT_C void SetDialogTitleL (const TDesC &)
IMPORT_C void SetMopParent (MObjectProvider *)
Private Member Functions
CLmkLandmarkSelectorDlg ()
void ConstructL ()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
HBufC * iDatabaseUri
RPointerArray < CPosLandmarkDatabase > iDbs
TBool * iDestroyedPtr
TBool iIsMultiSelector
CLmkDlgSelectorImplBase * iSelector

Constructor & Destructor Documentation

CLmkLandmarkSelectorDlg()

CLmkLandmarkSelectorDlg ( ) [private]

C++ default constructor.

~CLmkLandmarkSelectorDlg()

IMPORT_C ~CLmkLandmarkSelectorDlg ( )

Destructor.

Member Functions Documentation

ConstructL()

void ConstructL ( ) [private]

By default Symbian 2nd phase constructor is private.

ExecuteLD(TLmkItemIdDbCombiInfo &)

IMPORT_C TInt ExecuteLD ( TLmkItemIdDbCombiInfo & aSelected )
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.

Parameters

TLmkItemIdDbCombiInfo & aSelected

ExecuteLD(RArray< TLmkItemIdDbCombiInfo > &)

IMPORT_C TInt ExecuteLD ( RArray < TLmkItemIdDbCombiInfo > & aSelectedItems )

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.

Parameters

RArray < TLmkItemIdDbCombiInfo > & aSelectedItems

NewL()

IMPORT_C CLmkLandmarkSelectorDlg * NewL ( ) [static]

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.

NewL(const TDesC &)

IMPORT_C CLmkLandmarkSelectorDlg * NewL ( const TDesC & aDatabaseUri ) [static]
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.

Parameters

const TDesC & aDatabaseUri The URI of the databases to open.

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.

Parameters

const TDesC & 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.

Parameters

MObjectProvider * aParent The parent object which is the context for the control.

Member Data Documentation

HBufC * iDatabaseUri

HBufC * iDatabaseUri [private]

RPointerArray< CPosLandmarkDatabase > iDbs

RPointerArray < CPosLandmarkDatabase > iDbs [private]

TBool * iDestroyedPtr

TBool * iDestroyedPtr [private]

TBool iIsMultiSelector

TBool iIsMultiSelector [private]

CLmkDlgSelectorImplBase * iSelector

CLmkDlgSelectorImplBase * iSelector [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.