1 /*

     2 * Copyright (c) 2002-2006 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:  MSatSUiClientHandler provides functions for some UI activity

    15 *                like LaunchUi

    16 *

    17 */

    18 

    19 

    20 

    21 #ifndef MSATSUICLIENTHANDLER_H

    22 #define MSATSUICLIENTHANDLER_H

    23 

    24 //  INCLUDES

    25 #include <e32std.h>

    26 

    27 // FORWARD DECLARATION

    28 class MSatUiSession;

    29 class MSatShellController;

    30 

    31 // CLASS DECLARATION

    32 

    33 /**

    34 *  Interface provides some activity conserning UI client

    35 *

    36 *  @lib SatEngine.lib

    37 *  @since Series 60 3.0

    38 */

    39 class MSatSUiClientHandler

    40     {

    41 

    42      protected:  // Constructors and destructor

    43 

    44         /**

    45         * C++ default constructor.

    46         */

    47         MSatSUiClientHandler() {};

    48 

    49         /**

    50         * Destructor.

    51         */

    52         virtual ~MSatSUiClientHandler() {};

    53 

    54     public: // New functions

    55 

    56         /**

    57         * Gives pointer to ui session interface. If pointer is NULL, then

    58         * ui session is not available.

    59         * @return Pointer to ui session interface.

    60         */

    61         virtual MSatUiSession* UiSession() = 0;

    62 

    63         /**

    64         * Launches the SAT UI Client.

    65         */

    66         virtual void LaunchSatUiL() = 0;

    67 

    68         /**

    69         * Tells if user has started the ui client.

    70         * @return ETrue if user has launched the ui client.

    71         */

    72         virtual TBool UiLaunchedByUser() = 0;

    73 

    74         /**

    75         * Gives pointer to MSatShellController.

    76         * @return Pointer to sat shell controller.

    77         */

    78         virtual MSatShellController& ShellController() = 0;

    79 

    80         /**

    81         * Tells is UI closing

    82         * @return Boolean value indicating is UI closing

    83         */

    84         virtual TBool IsUiClosing() const = 0;

    85 

    86     private:

    87 

    88         // Prohibit copy constructor if not deriving from CBase.

    89         MSatSUiClientHandler( const MSatSUiClientHandler& );

    90 

    91         // Prohibit assigment operator if not deriving from CBase.

    92         MSatSUiClientHandler& operator=( const MSatSUiClientHandler& );

    93     };

    94 

    95 #endif      // MSATSUICLIENTHANDLER_H

    96 

    97 // End of File