satengine/satserver/inc/MSatEventMonitor.h
author hgs
Fri, 15 Oct 2010 13:21:28 +0300
changeset 53 25b8d29b7c59
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2008 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:  Event monitor interface
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef MSATEVENTMONITOR_H
hgs
parents:
diff changeset
    20
#define MSATEVENTMONITOR_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
//  INCLUDES
hgs
parents:
diff changeset
    23
#include <e32base.h>
hgs
parents:
diff changeset
    24
// CLASS DECLARATION
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
/**
hgs
parents:
diff changeset
    27
*  Interface for event monitors.
hgs
parents:
diff changeset
    28
*
hgs
parents:
diff changeset
    29
*  @lib EventMonitors.lib
hgs
parents:
diff changeset
    30
*  @since Series 60 3.0
hgs
parents:
diff changeset
    31
*/
hgs
parents:
diff changeset
    32
class MSatEventMonitor
hgs
parents:
diff changeset
    33
    {
hgs
parents:
diff changeset
    34
    public: // Enums
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
        // Monitored events
hgs
parents:
diff changeset
    37
        enum TEvent
hgs
parents:
diff changeset
    38
            {
hgs
parents:
diff changeset
    39
            EUserActivity,
hgs
parents:
diff changeset
    40
            EIdleScreenAvailable,
hgs
parents:
diff changeset
    41
            ELanguageSelection,
hgs
parents:
diff changeset
    42
            ESimRemoved,
hgs
parents:
diff changeset
    43
            EBrowserTerminated,
hgs
parents:
diff changeset
    44
            EDataAvailable,
hgs
parents:
diff changeset
    45
            EChannelStatus
hgs
parents:
diff changeset
    46
            };
hgs
parents:
diff changeset
    47
hgs
parents:
diff changeset
    48
    public: // New functions
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
        /**
hgs
parents:
diff changeset
    51
        * Cancels event monitoring
hgs
parents:
diff changeset
    52
        */
hgs
parents:
diff changeset
    53
        virtual void CancelMonitor() = 0;
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
        /**
hgs
parents:
diff changeset
    56
        * Updates monitors state. This function call starts or cancels monitor
hgs
parents:
diff changeset
    57
        * @param aEvents A list of events to be monitored. If this monitors event
hgs
parents:
diff changeset
    58
        * is not on the list, this monitor is cancelled.
hgs
parents:
diff changeset
    59
        * @return TInt An error code indicating update status
hgs
parents:
diff changeset
    60
        */
hgs
parents:
diff changeset
    61
        virtual TInt UpdateMonitor( TUint aEvents ) = 0;
hgs
parents:
diff changeset
    62
hgs
parents:
diff changeset
    63
        /**
hgs
parents:
diff changeset
    64
        * Checks is this event monitor monitoring particular event
hgs
parents:
diff changeset
    65
        * @param aEvent Event to check against
hgs
parents:
diff changeset
    66
        * @return ETrue if aEvent is the same event this is monitoring
hgs
parents:
diff changeset
    67
        */
hgs
parents:
diff changeset
    68
        virtual TBool IsMonitoringEvent( const TInt aEvent ) = 0;
hgs
parents:
diff changeset
    69
hgs
parents:
diff changeset
    70
        /**
hgs
parents:
diff changeset
    71
        * Destructor.
hgs
parents:
diff changeset
    72
        */
hgs
parents:
diff changeset
    73
        virtual ~MSatEventMonitor() {};
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
    protected:
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
        /**
hgs
parents:
diff changeset
    78
        * C++ default constructor.
hgs
parents:
diff changeset
    79
        */
hgs
parents:
diff changeset
    80
        MSatEventMonitor() {};
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
    private:
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
        // Prohibit copy constructor if not deriving from CBase.
hgs
parents:
diff changeset
    85
        MSatEventMonitor( const MSatEventMonitor& );
hgs
parents:
diff changeset
    86
 
hgs
parents:
diff changeset
    87
        // Prohibit assigment operator if not deriving from CBase.
hgs
parents:
diff changeset
    88
        MSatEventMonitor& operator=( const MSatEventMonitor& );
hgs
parents:
diff changeset
    89
hgs
parents:
diff changeset
    90
    };
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
#endif      // MSATEVENTMONITOR_H
hgs
parents:
diff changeset
    93
hgs
parents:
diff changeset
    94
// End of file