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 XAVIBRAITF_H

    19 #define XAVIBRAITF_H

    20 

    21 #include "xaadptbasectx.h"

    22 

    23 /** MACROS **/

    24 #define MIN_INTENSITY 0

    25 #define MAX_INTENSITY 1000

    26 #define MIN_FREQUENCY 0x00000001

    27 #define MAX_FREQUENCY 0xFFFFFFFF

    28 /** TYPES **/

    29 

    30 /** ENUMERATIONS **/

    31 

    32 /** STRUCTURES **/

    33 

    34 /* Definition of XAXAVibraItfItf implementation */

    35 typedef struct XAVibraItfImpl_

    36 {

    37    /* parent interface */

    38     struct XAVibraItf_ itf;

    39     /* pointer to self */

    40     struct XAVibraItfImpl_* self;

    41 

    42     /* variables */

    43     XAboolean       vibrate;

    44     XAmilliHertz    frequency;

    45     XApermille      intensity;

    46 

    47     /*Adaptation variables*/

    48     XAAdaptationBaseCtx *adapCtx;

    49 

    50 } XAVibraItfImpl;

    51 

    52 /** METHODS **/

    53 

    54 /* Base interface XAVibraItf implementation

    55  * See API Specification for method documentation

    56 */

    57 XAresult XAVibraItfImpl_Vibrate ( XAVibraItf self, XAboolean vibrate );

    58 XAresult XAVibraItfImpl_IsVibrating ( XAVibraItf self, XAboolean * pVibrating );

    59 XAresult XAVibraItfImpl_SetFrequency ( XAVibraItf self, XAmilliHertz frequency );

    60 XAresult XAVibraItfImpl_GetFrequency ( XAVibraItf self, XAmilliHertz * pFrequency );

    61 XAresult XAVibraItfImpl_SetIntensity ( XAVibraItf self, XApermille intensity );

    62 XAresult XAVibraItfImpl_GetIntensity ( XAVibraItf self, XApermille * pIntensity );

    63 

    64  

    65 /* XAVibraItfImpl -specific methods*/

    66 XAVibraItfImpl* XAVibraItfImpl_Create( XAAdaptationBaseCtx *adapCtx );

    67 

    68 void XAVibraItfImpl_Free(XAVibraItfImpl* self);

    69 #endif /* XAVIBRAITF_H */