locationsystemui/locationsysui/locsettingsuiservice/locsettingsuiserver/inc/locsettingsuilaunchmgr.h
branchRCL_3
changeset 44 2b4ea9893b66
parent 42 02ba3f1733c6
child 45 6b6920c56e2f
equal deleted inserted replaced
42:02ba3f1733c6 44:2b4ea9893b66
     1 /*
       
     2 * Copyright (c) 2005-2009 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:  The declaration for Settings Launch Manager class of Location
       
    15 *                Settings UI Server
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef C_LOCSETTINGSUILAUNCHMGR_H
       
    21 #define C_LOCSETTINGSUILAUNCHMGR_H
       
    22 
       
    23 #include<coemain.h>
       
    24 
       
    25 //Forward declarations
       
    26 class CLocSettingsUISrvLaunchAO;
       
    27 
       
    28 /**
       
    29  *  The Settings UI Launch Management class.
       
    30  *  This class is a Singleton. Session objects enqueue the requests
       
    31  *  to CLocSettingsUILaunchAO object through this Singleton.
       
    32  *
       
    33  *  @lib
       
    34  *  @since S60 v3.1
       
    35  */
       
    36 class CLocSettingsUILaunchMgr : public CCoeStatic
       
    37     {
       
    38 public:
       
    39     /**
       
    40      * Factory Method to create the Singleton.
       
    41      *
       
    42      * @since S60 v3.1
       
    43      * @return A pointer to the created CLocSettingsUILaunchMgr object
       
    44      */
       
    45     static CLocSettingsUILaunchMgr* InstanceL();
       
    46 
       
    47 public:
       
    48     /**
       
    49      * Enqueue the Settings UI launch request.
       
    50      *
       
    51      * @since S60 v3.1
       
    52      * @param aMessage The Request IPC message from the Client.
       
    53      */
       
    54     void EnqueueRequestL( const RMessage2& aMessage );
       
    55 
       
    56     /**
       
    57      * Cancel the launched Settings UI request.
       
    58      *
       
    59      * @since S60 v3.1
       
    60      * @param aSession Pointer to the session that launched the settings UI
       
    61      * to be cancelled.
       
    62      */
       
    63     void CancelRequest( const CSession2* aSession );
       
    64 
       
    65     /**
       
    66      * Close the currently running Settings UI.
       
    67      * Needed when the Settings UI issues a EEikCmdExit which needs to be
       
    68      * handled in the Server App UI
       
    69      *
       
    70      * @since S60 v3.1
       
    71      * @param aErrorCode The error code to send to the Client
       
    72      */
       
    73     void CloseRunningSettingsUi(TInt aErrorCode);
       
    74 
       
    75 private:
       
    76     /**
       
    77      * Constructor
       
    78      */
       
    79     CLocSettingsUILaunchMgr();
       
    80 
       
    81     /**
       
    82      * Destructor
       
    83      */
       
    84     virtual ~CLocSettingsUILaunchMgr();
       
    85 
       
    86     /**
       
    87      * Symbian 2nd Phase Constructor
       
    88      * Leaves in case of Error.
       
    89      *
       
    90      * @since S60 v3.1
       
    91      * @return None
       
    92      */
       
    93     void ConstructL();
       
    94 
       
    95 private: // data
       
    96     /**
       
    97      * The Active Object which launches the Setitngs UI and monitors the
       
    98      * actions.
       
    99      */
       
   100     CLocSettingsUISrvLaunchAO* iLauncher;
       
   101     };
       
   102 
       
   103 #endif // C_LOCSETTINGSUILAUNCHMGR_H