satengine/satserver/inc/MSatSUiClientHandler.h
author hgs
Fri, 17 Sep 2010 17:09:13 +0300
changeset 48 78df25012fda
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201037
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2006 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  MSatSUiClientHandler provides functions for some UI activity
hgs
parents:
diff changeset
    15
*                like LaunchUi
hgs
parents:
diff changeset
    16
*
hgs
parents:
diff changeset
    17
*/
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#ifndef MSATSUICLIENTHANDLER_H
hgs
parents:
diff changeset
    22
#define MSATSUICLIENTHANDLER_H
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
//  INCLUDES
hgs
parents:
diff changeset
    25
#include <e32std.h>
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
// FORWARD DECLARATION
hgs
parents:
diff changeset
    28
class MSatUiSession;
hgs
parents:
diff changeset
    29
class MSatShellController;
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
// CLASS DECLARATION
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
/**
hgs
parents:
diff changeset
    34
*  Interface provides some activity conserning UI client
hgs
parents:
diff changeset
    35
*
hgs
parents:
diff changeset
    36
*  @lib SatEngine.lib
hgs
parents:
diff changeset
    37
*  @since Series 60 3.0
hgs
parents:
diff changeset
    38
*/
hgs
parents:
diff changeset
    39
class MSatSUiClientHandler
hgs
parents:
diff changeset
    40
    {
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
     protected:  // Constructors and destructor
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
        /**
hgs
parents:
diff changeset
    45
        * C++ default constructor.
hgs
parents:
diff changeset
    46
        */
hgs
parents:
diff changeset
    47
        MSatSUiClientHandler() {};
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
        /**
hgs
parents:
diff changeset
    50
        * Destructor.
hgs
parents:
diff changeset
    51
        */
hgs
parents:
diff changeset
    52
        virtual ~MSatSUiClientHandler() {};
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
    public: // New functions
hgs
parents:
diff changeset
    55
hgs
parents:
diff changeset
    56
        /**
hgs
parents:
diff changeset
    57
        * Gives pointer to ui session interface. If pointer is NULL, then
hgs
parents:
diff changeset
    58
        * ui session is not available.
hgs
parents:
diff changeset
    59
        * @return Pointer to ui session interface.
hgs
parents:
diff changeset
    60
        */
hgs
parents:
diff changeset
    61
        virtual MSatUiSession* UiSession() = 0;
hgs
parents:
diff changeset
    62
hgs
parents:
diff changeset
    63
        /**
hgs
parents:
diff changeset
    64
        * Launches the SAT UI Client.
hgs
parents:
diff changeset
    65
        */
hgs
parents:
diff changeset
    66
        virtual void LaunchSatUiL() = 0;
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
        /**
hgs
parents:
diff changeset
    69
        * Tells if user has started the ui client.
hgs
parents:
diff changeset
    70
        * @return ETrue if user has launched the ui client.
hgs
parents:
diff changeset
    71
        */
hgs
parents:
diff changeset
    72
        virtual TBool UiLaunchedByUser() = 0;
hgs
parents:
diff changeset
    73
hgs
parents:
diff changeset
    74
        /**
hgs
parents:
diff changeset
    75
        * Gives pointer to MSatShellController.
hgs
parents:
diff changeset
    76
        * @return Pointer to sat shell controller.
hgs
parents:
diff changeset
    77
        */
hgs
parents:
diff changeset
    78
        virtual MSatShellController& ShellController() = 0;
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
        /**
hgs
parents:
diff changeset
    81
        * Tells is UI closing
hgs
parents:
diff changeset
    82
        * @return Boolean value indicating is UI closing
hgs
parents:
diff changeset
    83
        */
hgs
parents:
diff changeset
    84
        virtual TBool IsUiClosing() const = 0;
hgs
parents:
diff changeset
    85
hgs
parents:
diff changeset
    86
    private:
hgs
parents:
diff changeset
    87
hgs
parents:
diff changeset
    88
        // Prohibit copy constructor if not deriving from CBase.
hgs
parents:
diff changeset
    89
        MSatSUiClientHandler( const MSatSUiClientHandler& );
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
        // Prohibit assigment operator if not deriving from CBase.
hgs
parents:
diff changeset
    92
        MSatSUiClientHandler& operator=( const MSatSUiClientHandler& );
hgs
parents:
diff changeset
    93
    };
hgs
parents:
diff changeset
    94
hgs
parents:
diff changeset
    95
#endif      // MSATSUICLIENTHANDLER_H
hgs
parents:
diff changeset
    96
hgs
parents:
diff changeset
    97
// End of File