1 /*

     2 * Copyright (c) 2006-2007 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:   Declares a interface for metrics recorder class

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef __HUIPROBE_H__

    21 #define __HUIPROBE_H__

    22 

    23 #include <e32base.h>

    24 

    25 class MHuiSessionObject;

    26 

    27 /**

    28  * Interface for Hitchcock Toolkit Probe object.

    29  */

    30 class MHuiProbe

    31     {

    32 public:

    33 

    34     /**

    35      * Event enums for object lifecycle changes.

    36      */

    37     enum TLifecycleEvent

    38         {

    39         ELifecycleEventConstructed,

    40         ELifecycleEventDestructed,

    41         ELifecycleEventReleased,

    42         ELifecycleEventRestored,

    43         };

    44 

    45     /**

    46      * Location enums for points of interest in program flow.

    47      */

    48     enum TProgramFlowPoint

    49         {   

    50         EProgramFlowPointRefreshPrepareDraw,

    51         EProgramFlowPointRefreshDraw,

    52         EProgramFlowPointRefresh,

    53         };

    54 

    55     /**

    56      * Event enums for entering to or exiting from the point of interest in program flow.

    57      */

    58     enum TProgramFlowEvent

    59         {   

    60         EProgramFlowEventEnter,

    61         EProgramFlowEventExit,

    62         };

    63 

    64     /**

    65      * Report change in object life cycle

    66      */

    67     virtual void ReportObjectLifeCycleEvent(

    68         const MHuiSessionObject& aObject,

    69         TLifecycleEvent aLifecycleEvent) = 0;

    70 

    71     /**

    72      * Report enter or exit to/from "point of interest" in program flow

    73      */

    74     virtual void ReportProgramFlowEvent(

    75         TProgramFlowPoint aProgramFlowPoint,

    76         TProgramFlowEvent aProgramFlowEvent) = 0;

    77 

    78     /**

    79      * Report enter or exit to/from "point of interest" in program flow, which

    80      * resides inside session-aware object

    81      */

    82     virtual void ReportProgramFlowEvent(

    83         const MHuiSessionObject& aSessionObject,

    84         TProgramFlowPoint aProgramFlowPoint,

    85         TProgramFlowEvent aProgramFlowEvent) = 0;

    86 

    87     /**

    88      * Explocitly report the frame rate

    89      */

    90     virtual void ReportFrameRate(TInt aFrameRate) const = 0;

    91 

    92     /**

    93      * Associate the given object with current session (e.g. session

    94      * which is currently handling a message).

    95      */

    96     virtual void AssociateWithCurrentSession(MHuiSessionObject& aObject) = 0;

    97 

    98     };

    99 

   100 #endif // __HUIPROBE_H__

   101