1 /*

     2 * Copyright (c) 2005 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:  Active Object to monitor the UI Server launch requests

    15 *

    16 */

    17 

    18 

    19 #ifndef C_LOCLAUNCHUIAO_H

    20 #define C_LOCLAUNCHUIAO_H

    21 

    22 // System Includes

    23 #include <e32base.h>

    24 

    25 // Forward Declarations

    26 class MLocLaunchUiObserver;

    27 

    28 /**

    29  *  Active Object to monitor the UI Server launch requests

    30  *

    31  *  This class is a helper class. The status variable of this active obect is 

    32  *  used to provide the asynchronous Send Receive server calls. The IPC message

    33  *  completes on this active object. 

    34  *

    35  *  @lib locsettingsuiclient.lib

    36  *  @since S60 v3.1

    37  */

    38 NONSHARABLE_CLASS( CLocLaunchUiAO ): public CActive

    39     {

    40 public:

    41     /**

    42      * Two Phase constructor 

    43      * 

    44      * @since S60 v3.1

    45      * @param aObserver Observer to the Launch UI Active Object

    46      * @return The reference of the newly allocated CLocLaunchUiAO 

    47      *         object

    48      */

    49     static CLocLaunchUiAO* NewL( MLocLaunchUiObserver&    aObserver );

    50 

    51     /**

    52      * Two Phase constructor. Leaves the allocated object on the Clean-up

    53      * stack 

    54      * 

    55      * @since S60 v3.1

    56      * @param aObserver Observer to the Launch UI Active Object

    57      * @return The reference of the newly allocated CLocLaunchUiAO 

    58      *         object

    59      */

    60     static CLocLaunchUiAO* NewLC( MLocLaunchUiObserver&    aObserver );

    61 

    62     /**

    63      * C++ Destructor

    64      * 

    65      * @since S60 v3.1

    66      */

    67     virtual ~CLocLaunchUiAO();

    68 

    69     /**

    70      * Informs the active object that there is an outstanding request.

    71      * The function leaves with error KErrInUse

    72      *

    73      * @since S60 v3.1

    74      */

    75     void    SetRequestOutStandingL();

    76     

    77     /**

    78      * Returns a reference to the active objects Status variable

    79      *

    80      * @since S60 v3.1

    81      * @return TRequestStatus&  Reference to the Status variable

    82      */

    83     TRequestStatus&     GetStatusVariable();

    84     

    85 protected:

    86     

    87     /**

    88      * Inherited from CActive

    89      */

    90     void RunL();

    91     

    92     /**

    93      * Inherited from CActive

    94      */

    95     void DoCancel();

    96 

    97 private:

    98     /**

    99      * C++ Default Constructor

   100      */

   101     CLocLaunchUiAO( MLocLaunchUiObserver&    aObserver );

   102 

   103 private:

   104     /**

   105      * Reference to the Observer

   106      */ 

   107      MLocLaunchUiObserver&    iObserver ;

   108      

   109     };

   110 

   111 #endif //  C_LOCLAUNCHUIAO_H