uiaccelerator_plat/alf_extension_api/inc/alf/alfserverutils.h
changeset 0 15bf7259bb7c
equal deleted inserted replaced
-1:000000000000 0:15bf7259bb7c
       
     1 /*
       
     2 * Copyright (c) 2006 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:   Application server
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef C_ALFAPPSERVERUTILS_H
       
    21 #define C_ALFAPPSERVERUTILS_H
       
    22 
       
    23 #include <e32def.h>
       
    24 #include <alf/alftimedvalue.h>
       
    25 
       
    26 class TAlfTimedValue;
       
    27 class THuiTimedValue;
       
    28 class TAlfTimedPoint;
       
    29 class THuiTimedPoint;
       
    30 class MAlfInterfaceProvider;
       
    31 class RFile;
       
    32 
       
    33 struct TAlfBoxMetric;
       
    34 struct THuiBoxMetric;
       
    35 struct TAlfXYMetric;
       
    36 struct THuiXYMetric;
       
    37 struct TAlfMetric;
       
    38 struct THuiMetric;
       
    39 
       
    40 
       
    41 class AlfTimedValueUtility
       
    42     {
       
    43 public:
       
    44     /** 
       
    45      *
       
    46      * Helper function to copy TAlfTimedValue (including mapping function) into THuiTimedValue. 
       
    47      * Can be used only inside the Alfred-server.
       
    48      *
       
    49      * @param aSrc Source ALF timedvalue.
       
    50      * @param aDst Destination HUI timedvalue.
       
    51      * @param aResolver Interface to be used for resolving MHuiMappingFunction from TAlfTimedValue 
       
    52      *     MappingFunctionIdentifier
       
    53      *
       
    54      */
       
    55     IMPORT_C static void CopyTimedValue(TAlfTimedValue& aSrc, THuiTimedValue& aDst, MAlfInterfaceProvider& aResolver);
       
    56 
       
    57     /** 
       
    58      *
       
    59      * Helper function to copy TAlfTimedValue (NOT including mapping function) into THuiTimedValue. 
       
    60      * Can be used only inside the Alfred-server.
       
    61      *
       
    62      * @param aSrc Source ALF timedvalue.
       
    63      * @param aDst Destination HUI timedvalue.
       
    64      *
       
    65      */
       
    66     IMPORT_C static void CopyTimedValue(TAlfTimedValue& aSrc, THuiTimedValue& aDst);
       
    67 
       
    68     /** 
       
    69      *
       
    70      * Helper function to copy THuiTimedValue (NOT including mapping function) into TAlfTimedValue. 
       
    71      * Can be used only inside the Alfred-server.
       
    72      *
       
    73      * @param aSrc Source HUI timedvalue.
       
    74      * @param aSrc Destination ALF timedvalue.
       
    75      *
       
    76      */
       
    77     IMPORT_C static void CopyTimedValue(THuiTimedValue& aSrc, TAlfTimedValue& aDst);
       
    78     };
       
    79 
       
    80 class AlfTimedPointUtility
       
    81     {
       
    82 public:
       
    83      
       
    84     /** 
       
    85      *
       
    86      * Helper function to copy TAlfTimedPoint (including mapping function) into THuiTimedPoint. 
       
    87      * Can be used only inside the Alfred-server.
       
    88      *
       
    89      * @param aSrc Source ALF timedpoint.
       
    90      * @param aDst Destination HUI timedpoint.
       
    91      * @param aResolver Interface to be used for resolving MHuiMappingFunction from TAlfTimedPoint 
       
    92      *     MappingFunctionIdentifier
       
    93      *
       
    94      */
       
    95     IMPORT_C static void CopyTimedPoint(TAlfTimedPoint& aSrc, THuiTimedPoint& aDst, MAlfInterfaceProvider& aResolver);
       
    96     
       
    97     /** 
       
    98      *
       
    99      * Helper function to copy TAlfTimedPoint (NOT including mapping function) into THuiTimedPoint. 
       
   100      * Can be used only inside the Alfred-server.
       
   101      *
       
   102      * @param aSrc Source ALF timedpoint.
       
   103      * @param aDst Destination HUI timedpoint.
       
   104      *
       
   105      */
       
   106     IMPORT_C static void CopyTimedPoint(TAlfTimedPoint& aSrc, THuiTimedPoint& aDst);
       
   107 
       
   108     /** 
       
   109      *
       
   110      * Helper function to copy THuiTimedPoint (NOT including mapping functions) into TAlfTimedPoint. 
       
   111      * Can be used only inside the Alfred-server.
       
   112      *
       
   113      * @param aDst Source HUI timedpoint.
       
   114      * @param aDst Destination ALF timedpoint.
       
   115      *
       
   116      */
       
   117     IMPORT_C static void CopyTimedPoint(THuiTimedPoint& aSrc, TAlfTimedPoint& aDst);
       
   118 
       
   119     };
       
   120 
       
   121 class AlfFileTokenUtility
       
   122     {
       
   123     public:
       
   124     /** 
       
   125      *
       
   126      * Helper function to open a file based on token received from client side
       
   127      * As token remains valid as long as the client session is open, there's no need to keep file handle
       
   128      * open unless file is really used
       
   129      *
       
   130      * @param aFile Handle to open
       
   131      * @param aToken Token received from client
       
   132      *
       
   133      */
       
   134     IMPORT_C static void OpenFileForTokenL(RFile& aFile, const TDesC8& aToken);
       
   135     };
       
   136 
       
   137 
       
   138 
       
   139 class AlfBoxMetricUtility
       
   140     {
       
   141 public:
       
   142     static void CopyMetric(TAlfBoxMetric& aSrc, THuiBoxMetric& aDst);
       
   143 
       
   144     static void CopyMetric(THuiBoxMetric& aSrc, TAlfBoxMetric& aDst);
       
   145     };
       
   146 
       
   147 class AlfXYMetricUtility
       
   148     {
       
   149 public:
       
   150     static void CopyMetric(TAlfXYMetric& aSrc, THuiXYMetric& aDst);
       
   151 
       
   152     static void CopyMetric(THuiXYMetric& aSrc, TAlfXYMetric& aDst);
       
   153     };
       
   154 
       
   155 class AlfMetricUtility
       
   156     {
       
   157 public:
       
   158     static void CopyMetric(TAlfMetric& aSrc, THuiMetric& aDst);
       
   159 
       
   160     static void CopyMetric(THuiMetric& aSrc, TAlfMetric& aDst);
       
   161     };
       
   162 
       
   163 
       
   164 #endif