landmarksui/uicontrols/inc/LmkNotes.h
branchRCL_3
changeset 17 1fc85118c3ae
parent 16 8173571d354e
child 18 870918037e16
equal deleted inserted replaced
16:8173571d354e 17:1fc85118c3ae
     1 /*
       
     2 * Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:    LandmarksUi Content File -    Landmarks Ui note class definition
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 #ifndef __LMKNOTES_H__
       
    25 #define __LMKNOTES_H__
       
    26 
       
    27 #include <e32std.h>
       
    28 #include <AknInfoPopupNoteController.h>
       
    29 
       
    30 
       
    31 // CLASS DECLARATION
       
    32 
       
    33 /**
       
    34 *  LmkNotes class.
       
    35 */
       
    36 class LmkNotes
       
    37     {
       
    38     public: // new functions
       
    39         /**
       
    40         * Display category deletes confirmation query
       
    41         * @param aAmount
       
    42         * @return positive value if yes, else zero or negative
       
    43         */
       
    44         IMPORT_C static TInt CategoryConfirmationQueryL( CEikonEnv* aEnv, const TInt aAmount );
       
    45 
       
    46         /**
       
    47         * Display landmark deletes confirmation query
       
    48         * @param aAmount
       
    49         * @return positive value if yes, else zero or negative
       
    50         */
       
    51         IMPORT_C static TInt LandmarkConfirmationQueryL( CEikonEnv* aEnv,const TInt aAmount=1);
       
    52 
       
    53         /**
       
    54         * Display landmark information note.
       
    55         * @param resource id
       
    56         */
       
    57         IMPORT_C static void InformationNoteL( CEikonEnv* aEnv, const TInt aResourceId );
       
    58 
       
    59         /**
       
    60         * Display category name query
       
    61         * @param aDataText, empty or existing name
       
    62         * @param resource id (CAknTextQueryDialog)
       
    63         * @return positive value if pressed ok, else negative
       
    64         */
       
    65         IMPORT_C static TInt CategoryNameQueryL( TDes& aDataText,
       
    66        											 const TInt aResourceId );
       
    67         /**
       
    68         * Display landmark information note.
       
    69         * @param resource id
       
    70         * @param extra text to be displayed
       
    71         */
       
    72          IMPORT_C static void InformationNotewithTextL( CEikonEnv* aEnv, TInt aResourceId,
       
    73                                                   TPtrC aTextPtr );
       
    74         /**
       
    75         * Display Out of memory note
       
    76         *
       
    77         */
       
    78         IMPORT_C static void OutOfMemoryNoteL( CEikonEnv* aEnv );
       
    79         /**
       
    80         * Display names in a message query ( List of names, one in each line )
       
    81         * @param aMsg, set of names to be displayed in the query
       
    82         */
       
    83         IMPORT_C static void MessageQueryL( CEikonEnv* aEnv, TDes& aMsg, TInt aCount );
       
    84         /**
       
    85          * Display an information note for show on map use case
       
    86          * when selected landmarks are empty
       
    87          *
       
    88          */
       
    89 		IMPORT_C static void AllLandmarksEmptyNoteL( CEikonEnv* aEnv );
       
    90 
       
    91 		/**
       
    92          * Display an information note for show on map use case when
       
    93          * a landmark are empty
       
    94          *
       
    95          * @param aLandmarkName the name of the landmark which does
       
    96          *                      not have coordinates
       
    97          */
       
    98 		IMPORT_C static void LandmarksEmptyNoteL( CEikonEnv* aEnv,TPtrC aLandmarkName );
       
    99 
       
   100 		/**
       
   101          * Display an information note for category show on map use
       
   102          * case when all landmarks are empty
       
   103          *
       
   104          * @param aLandmarkName the name of the landmark which does
       
   105          *                      not have coordinates
       
   106          */
       
   107 		IMPORT_C static void CategoryEmptyNoteL( CEikonEnv* aEnv, TPtrC aCategory );
       
   108 
       
   109 		/**
       
   110          * Display an information note for category show on map use
       
   111          * case when all landmarks are empty
       
   112          *
       
   113          * @param aLandmarkName the name of the landmark which does
       
   114          *                      not have coordinates
       
   115          */
       
   116 		IMPORT_C static void LandmarkInCategoryEmptyNoteL( CEikonEnv* aEnv, TPtrC aCategory, TPtrC aLandmark);
       
   117 
       
   118 		/**
       
   119          * Display an information popup note after 1 sec.
       
   120          * @param aMsg This is the message to be displayed.
       
   121          * @param aPosition Position of the info popup.
       
   122          */
       
   123 		IMPORT_C static CAknInfoPopupNoteController* ShowDelayedInfoPopupL( TDesC& aMsg,TPoint& aPosition );
       
   124 		/**
       
   125          * This query dialog will be displayed, when the landmark, already
       
   126          * has location coordinate, which is being replaced with new coordinate
       
   127          * It asks whether to replace or not.
       
   128          */
       
   129 		IMPORT_C static TInt ShowOwerriteLocationQueryL( CEikonEnv* aEnv );
       
   130 		/**
       
   131          * This message query displays text with the link.
       
   132          * @return returns the button id
       
   133          */
       
   134 		IMPORT_C static TInt MessageQueryWithLinkL( CEikonEnv* aEnv, TInt aHeadingText,
       
   135 											   TInt aMsgQueryText, TInt aLinkText,
       
   136 											   TCallBack aCallBack );
       
   137 		/**
       
   138          * This message query is a generic message query.
       
   139          *
       
   140          */
       
   141 		IMPORT_C static TInt GenericMessageQueryL( CEikonEnv* aEnv, TInt aMsgQueryText, TInt aHeadingText );
       
   142 
       
   143     };
       
   144 
       
   145 #endif // __LMKNOTES_H__
       
   146 
       
   147 // End of File