logsui/logsengine/logssymbianos/inc/logsstatebasecontext.h
changeset 14 f27aebe284bb
equal deleted inserted replaced
11:64a47b97e1e1 14:f27aebe284bb
       
     1 /*
       
     2 * Copyright (c) 2009 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 *
       
    16 */
       
    17 
       
    18 #ifndef LOGSSTATEBASECONTEXT_H
       
    19 #define LOGSSTATEBASECONTEXT_H
       
    20 
       
    21 //  INCLUDES
       
    22 #include <e32base.h>
       
    23 
       
    24 // FORWARD DECLARATION
       
    25 class LogsStateBase;
       
    26 class CLogView;
       
    27 class CLogViewDuplicate;
       
    28 class CLogViewEvent;
       
    29 class TRequestStatus;
       
    30 class CLogClient;
       
    31 
       
    32 // CLASS DECLARATION
       
    33         
       
    34 /**
       
    35  * Context base for state machines
       
    36  */
       
    37 class LogsStateBaseContext {
       
    38     public:
       
    39         
       
    40         /**
       
    41          * Change state
       
    42          * @param state, new state
       
    43          */
       
    44         virtual void setCurrentState(const LogsStateBase& state) = 0;
       
    45         
       
    46         /**
       
    47          * Get log view
       
    48          * @return current log view
       
    49          */
       
    50         virtual CLogView& logView() = 0;
       
    51         
       
    52         /**
       
    53          * Get duplicates view
       
    54          * @return current duplicates view
       
    55          */
       
    56         virtual CLogViewDuplicate& duplicatesView() = 0;
       
    57         
       
    58         /**
       
    59          * Get view index
       
    60          * @return ref to view index
       
    61          */
       
    62         virtual int& index() = 0;
       
    63        
       
    64         /**
       
    65          * Request status for async operations
       
    66          * inside states
       
    67          * @return reqstatus
       
    68          */
       
    69         virtual TRequestStatus& reqStatus() = 0;
       
    70         
       
    71         /**
       
    72          * Get ID of the event to be handled
       
    73          * @return ID of the event
       
    74          */
       
    75         virtual int currentEventId() = 0;
       
    76         
       
    77         /**
       
    78          * Get log client
       
    79          * @return log client
       
    80          */
       
    81         virtual CLogClient& logClient() = 0;
       
    82         
       
    83         /**
       
    84          * Check if current view is recent view.
       
    85          * @return true if recent view
       
    86          */
       
    87         virtual bool isRecentView() = 0;
       
    88    
       
    89 };
       
    90 
       
    91 
       
    92 #endif      // LOGSSTATEBASECONTEXT_H
       
    93 
       
    94 
       
    95 // End of File
       
    96       
       
    97 
       
    98         
       
    99