satengine/satserver/inc/msatmediatoreventprovider.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) 2005-2005 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:  Provider of the SAT Mediator Events.
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
hgs
parents:
diff changeset
    20
#ifndef M_MSATMEDIATOREVENTPROVIDER_H
hgs
parents:
diff changeset
    21
#define M_MSATMEDIATOREVENTPROVIDER_H
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
#include <e32std.h>
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
/**
hgs
parents:
diff changeset
    28
*  Mediator Event provider interface.
hgs
parents:
diff changeset
    29
*
hgs
parents:
diff changeset
    30
*  Responsible to notify Mediator Event Consumers about SAT Mediator Events.
hgs
parents:
diff changeset
    31
*
hgs
parents:
diff changeset
    32
*  @lib SatEngine
hgs
parents:
diff changeset
    33
*  @since S60 v3.1
hgs
parents:
diff changeset
    34
*/
hgs
parents:
diff changeset
    35
class MSatMediatorEventProvider
hgs
parents:
diff changeset
    36
    {
hgs
parents:
diff changeset
    37
    
hgs
parents:
diff changeset
    38
public:  
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
    MSatMediatorEventProvider() {};
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
    virtual ~MSatMediatorEventProvider() {};
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
    /**
hgs
parents:
diff changeset
    45
     * Raises SAT Mediator Event.
hgs
parents:
diff changeset
    46
     *
hgs
parents:
diff changeset
    47
     * @since S60 v3.1
hgs
parents:
diff changeset
    48
     * @param aData contains packaged event information for event consumer
hgs
parents:
diff changeset
    49
     * @return KErrNone or possible error code
hgs
parents:
diff changeset
    50
     */
hgs
parents:
diff changeset
    51
    virtual TInt RaiseSatEvent( const TDesC8& aData ) = 0;
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
    /**
hgs
parents:
diff changeset
    54
     * Checks Cover UI support for SAT Mediator Event.
hgs
parents:
diff changeset
    55
     *
hgs
parents:
diff changeset
    56
     * @since S60 v3.1
hgs
parents:
diff changeset
    57
     * @return ETrue if cover Ui is supported
hgs
parents:
diff changeset
    58
     */        
hgs
parents:
diff changeset
    59
    virtual TBool CoverUiSupported() = 0;
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
private:
hgs
parents:
diff changeset
    62
hgs
parents:
diff changeset
    63
    /**
hgs
parents:
diff changeset
    64
     * Prohibit copy constructor if not deriving from CBase.
hgs
parents:
diff changeset
    65
     *
hgs
parents:
diff changeset
    66
     * @since S60 v3.1
hgs
parents:
diff changeset
    67
     * @param const reference to MSatMediatorEventProvider.
hgs
parents:
diff changeset
    68
     */
hgs
parents:
diff changeset
    69
    MSatMediatorEventProvider( const MSatMediatorEventProvider& );
hgs
parents:
diff changeset
    70
hgs
parents:
diff changeset
    71
    /**
hgs
parents:
diff changeset
    72
     * Prohibit assigment operator if not deriving from CBase.
hgs
parents:
diff changeset
    73
     *
hgs
parents:
diff changeset
    74
     * @since S60 v3.1
hgs
parents:
diff changeset
    75
     * @param const reference to MSatMediatorEventProvider.
hgs
parents:
diff changeset
    76
     */
hgs
parents:
diff changeset
    77
    MSatMediatorEventProvider& 
hgs
parents:
diff changeset
    78
            operator=( const MSatMediatorEventProvider& );
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
    };
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
#endif // M_MSATMEDIATOREVENTPROVIDER_H
hgs
parents:
diff changeset
    83