logsui/EngineInc/MLogsSharedData.h
changeset 0 e686773b3f54
equal deleted inserted replaced
-1:000000000000 0:e686773b3f54
       
     1 /*
       
     2 * Copyright (c) 2002 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: 
       
    15 *     Defines abstract interface for accessing Logs SD
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef __MLogsSharedData_H_
       
    21 #define __MLogsSharedData_H_
       
    22 
       
    23 // INCLUDES
       
    24 #include "LogsEng.hrh"
       
    25 #include "LogsAlsEnum.hrh"
       
    26 
       
    27 // MACROS
       
    28 
       
    29 // DATA TYPES
       
    30 
       
    31 // FUNCTION PROTOTYPES
       
    32 
       
    33 // FORWARD DECLARATIONS
       
    34 class MLogsObserver;
       
    35 
       
    36 // CLASS DECLARATION
       
    37 
       
    38 /**
       
    39  *	Defines abstract interface for accessing Logs SD
       
    40  */
       
    41 class MLogsSharedData
       
    42     {
       
    43     public:
       
    44     
       
    45         virtual ~MLogsSharedData() {};
       
    46 
       
    47     public:
       
    48         
       
    49         /**
       
    50          *  Last Call Timer's value getter. 
       
    51          *
       
    52          *  @param  aLine   Line to fetch, default EAllLines
       
    53          *  @param  aVoip   Whether or voip line is to be fetched
       
    54          *  @return Last Call Timer value
       
    55          */
       
    56         virtual TInt LastCallTimer( TAlsEnum aLine, TVoipEnum aVoip ) = 0; 
       
    57 
       
    58         /**
       
    59          *  Dialled Call Timer's value getter
       
    60          *
       
    61          *  @param  aLine   Line, to fetch
       
    62          *  @param  aVoip   Whether or voip line is to be included 
       
    63          *  @return Dialled Call Timer value
       
    64          */
       
    65         virtual TInt DialledCallsTimer( TAlsEnum aLine, TVoipEnum aVoip ) = 0;
       
    66 
       
    67         /**
       
    68          *  Received Call Timer's value getter
       
    69          *
       
    70          *  @param  aLine   Line to fetch
       
    71          *  @param  aVoip   Whether or voip line is to be included          
       
    72          *  @return Received Call Timer value
       
    73          */
       
    74         virtual TInt ReceivedCallsTimer( TAlsEnum aLine, TVoipEnum aVoip )  = 0;
       
    75 
       
    76         /**
       
    77          *  All Calls Timer's value getter, 
       
    78          *
       
    79          *  @param  aLine   Line to fetch
       
    80          *  @param  aVoip   Whether or voip line is to be included          
       
    81          *  @return All Calls Timer value
       
    82          */
       
    83         virtual TInt AllCallsTimer( TAlsEnum aLine, TVoipEnum aVoip ) = 0;
       
    84 
       
    85         /**
       
    86          *  Clears Call Timers
       
    87          */
       
    88         virtual void ClearCallTimers() = 0;
       
    89         
       
    90         /**
       
    91          *  Returns whether Logging is enabled 
       
    92          *  (Log length is != "no log")
       
    93          *
       
    94          *  @return LoggingEnabled true/false
       
    95          */        
       
    96         virtual TBool IsLoggingEnabled() = 0;
       
    97 
       
    98         /**
       
    99          *  Logging ON/OFF switch
       
   100          *
       
   101          *  @param  aSwitch    ETrue - ON, EFalse - OFF
       
   102          */
       
   103         virtual void SetLoggingEnabled( TBool aSwitch ) = 0;
       
   104 
       
   105         /**
       
   106          *  GPRS sent value getter
       
   107          *
       
   108          *  @return The value of the GPRS sent counter
       
   109          */
       
   110         virtual TInt64 GprsSentCounter() = 0;
       
   111 
       
   112         /**
       
   113          *  GPRS received value getter
       
   114          *
       
   115          *  @return The value of the GPRS received counter
       
   116          */
       
   117         virtual TInt64 GprsReceivedCounter() = 0;
       
   118 
       
   119         /**
       
   120          *  Clears GPRS counters
       
   121          */
       
   122         virtual void ClearGprsCounters() = 0;
       
   123 
       
   124         /**
       
   125          *  Flag getter for Show call duration in Logs application.
       
   126          *
       
   127          *  @return ETrue if call duration is to be shown,
       
   128          *          otherwise EFalse
       
   129          */
       
   130         virtual TBool ShowCallDurationLogsL() = 0;    
       
   131 
       
   132         //For ring duation feature
       
   133         /**
       
   134          *  Show Ring duration for missed calls
       
   135          *  @return ETrue if value must be shown,
       
   136          *          EFalse otherwise.
       
   137          */        
       
   138         virtual TBool ShowRingDuration() const = 0;
       
   139         
       
   140         /*******************************************************************************
       
   141         FIXME: Toolbar is currently always on - keeping the toolbar visibility handling 
       
   142         sources in comments for now - remove later.*/
       
   143   
       
   144         /**
       
   145          *  Show Toolbar status getter
       
   146          *  @return 0   Don't show toolbar.
       
   147          *          !0  Show toolbar.
       
   148          */        
       
   149         //virtual TInt ToolbarVisibility() const = 0;
       
   150 
       
   151         /**
       
   152          *  Show Toolbar status setter
       
   153          *  @param aShow !0 (use 1) Show toolbar,
       
   154          *               0  Don't show toolbar.
       
   155          */        
       
   156          //virtual void SetToolbarVisibility( TInt aToolbarVisibility ) = 0; 
       
   157           
       
   158         /*******************************************************************************/
       
   159      
       
   160         
       
   161         /**
       
   162          *  New Missed Calls getter
       
   163          *
       
   164          *  @param aClear clear counter if true, default EFalse
       
   165          *  @return Amount of new missed calls
       
   166          */
       
   167         virtual TInt NewMissedCalls( const TBool aClear = EFalse ) = 0;
       
   168 
       
   169         /**
       
   170          *   Set UI observer for notifications
       
   171          * 
       
   172          *   @param aObserver pointer to observer.
       
   173          */
       
   174         virtual void SetObserver( MLogsObserver* aObserver ) = 0;
       
   175         
       
   176         /**
       
   177          *  Returns whether MSK is enabled in platform
       
   178          *
       
   179          *  @return MSKEnabled true/false
       
   180          */            
       
   181         virtual TBool IsMSKEnabledInPlatform() = 0;
       
   182          
       
   183          /**
       
   184          *  Returns whether VoIP is enabled in platform
       
   185          *
       
   186          *  @return VoIPEnabled true/false
       
   187          */            
       
   188         virtual TBool IsVoIPEnabledInPlatform() = 0;  
       
   189     };
       
   190 
       
   191             
       
   192 #endif
       
   193 
       
   194 // End of File  __MLogsSharedData_H_