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