epoc32/include/app/clmklandmarkselectordlg.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 /*
     1 /*
     2 * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
     2 * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     4 * This component and the accompanying materials are made available
     5 * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     8 *
     9 * Initial Contributors:
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    10 * Nokia Corporation - initial contribution.
    11 *
    11 *
    12 * Contributors:
    12 * Contributors:
    59         * @leave  Leaves with KErrNotSupported if framework functionality is not available.
    59         * @leave  Leaves with KErrNotSupported if framework functionality is not available.
    60         * @panic  Panics with system-wide panic codes.
    60         * @panic  Panics with system-wide panic codes.
    61         * @return new instance of this class
    61         * @return new instance of this class
    62         */
    62         */
    63         IMPORT_C static CLmkLandmarkSelectorDlg* NewL();
    63         IMPORT_C static CLmkLandmarkSelectorDlg* NewL();
       
    64         
       
    65         /**
       
    66         * This is a static function, which creates and returns an instance of this class.
       
    67         * All the landmarks present in the user specified landmark database are shown in the selector.
       
    68         * @param[in] aDatabaseUri The URI of the databases to open.
       
    69     		*
       
    70         * @leave  Leaves with KErrNotSupported if framework functionality is not available or
       
    71         *					the protocol specified in URI is not supported.
       
    72         * @leave  Leaves with KErrArgument if an empty string is passed as argument or
       
    73         *					extension of the local database name is not "ldb".
       
    74         * @panic  Panics with system-wide panic codes.
       
    75         * @return new instance of this class
       
    76         */
       
    77         IMPORT_C static CLmkLandmarkSelectorDlg* NewL( const TDesC&  aDatabaseUri );
    64 
    78 
    65         /**
    79         /**
    66         * Destructor.
    80         * Destructor.
    67         */
    81         */
    68         IMPORT_C ~CLmkLandmarkSelectorDlg();
    82         IMPORT_C ~CLmkLandmarkSelectorDlg();
   103 	    * @leave Leaves with system-wide leave codes.
   117 	    * @leave Leaves with system-wide leave codes.
   104 	    * @panic Panics with KLmkPanicNullMember, if the selector is not constructed properly.
   118 	    * @panic Panics with KLmkPanicNullMember, if the selector is not constructed properly.
   105         * @return Returns non-zero if accepted, else zero.
   119         * @return Returns non-zero if accepted, else zero.
   106         */
   120         */
   107         IMPORT_C TInt ExecuteLD( RArray<TLmkItemIdDbCombiInfo>& aSelectedItems );
   121         IMPORT_C TInt ExecuteLD( RArray<TLmkItemIdDbCombiInfo>& aSelectedItems );
       
   122 
       
   123         /**
       
   124         * This function sets the title string of the landmark selector dialog.
       
   125         * This function has to be called before ExecuteLD() to make the set title appear on ui. 
       
   126         * Calling this api after ExecuteLD() will not have any impact.
       
   127         *
       
   128         * @param [in] aTitle The title string of the selector dialog. 
       
   129         * @panic Panics with KLmkPanicNullMember, if the selector is not
       
   130         *        constructed properly.
       
   131         */
       
   132         IMPORT_C void SetDialogTitleL(const TDesC& aTitle );
       
   133 
   108     private:
   134     private:
   109         /**
   135         /**
   110         * C++ default constructor.
   136         * C++ default constructor.
   111         * @return newly instantiated object
   137         * @return newly instantiated object
   112         */
   138         */
   121 
   147 
   122     private:    // Data
   148     private:    // Data
   123         // ETrue if executed in multiple item selector mode
   149         // ETrue if executed in multiple item selector mode
   124         TBool iIsMultiSelector;
   150         TBool iIsMultiSelector;
   125 
   151 
       
   152         // User defined database set to be viewed in selector
       
   153         HBufC* iDatabaseUri;
       
   154 
   126         /// Own: Search implementor object
   155         /// Own: Search implementor object
   127         CLmkDlgSelectorImplBase* iSelector;
   156         CLmkDlgSelectorImplBase* iSelector;
   128 
   157 
   129         // Set to ETrue in destructor
   158         // Set to ETrue in destructor
   130         TBool* iDestroyedPtr;
   159         TBool* iDestroyedPtr;