srsf/ttscustomcommands/src/nssttscustomcommandcommon.h
branchRCL_3
changeset 19 e36f3802f733
parent 0 bf1d17376201
equal deleted inserted replaced
18:cad71a31b7fc 19:e36f3802f733
       
     1 /*
       
     2 * Copyright (c) 2004-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:  Common header file for TTS custom commands, both client &
       
    15 *                server side need this
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef NSSTTSCUSTOMCOMMANDCOMMON_H
       
    21 #define NSSTTSCUSTOMCOMMANDCOMMON_H
       
    22 
       
    23 // INCLUDE FILES
       
    24 #include <nssttscommon.h>
       
    25 
       
    26 // FORWARD DECLARATIONS
       
    27 class TTtsParsedText;
       
    28 
       
    29 // CONSTANTS
       
    30 
       
    31 const TUid KUidInterfaceTts = { 0x101FF939 };
       
    32 
       
    33 // DATA TYPES
       
    34 
       
    35 // Custom command messages
       
    36 enum TTtsCustomCommandMessages
       
    37     {
       
    38     ETtsAddStyle,
       
    39     ETtsDeleteStyle,
       
    40     ETtsGetPosition,
       
    41     ETtsNumberOfStyles,
       
    42     ETtsOpenParsedText,
       
    43     ETtsSetPosition,
       
    44     ETtsStyleID, // Style query based on ID
       
    45     ETtsStyleIndex, // Style query based on index
       
    46     ETtsSetDefaultStyle,
       
    47     ETtsGetDefaultStyle,
       
    48     ETtsSetSpeakingRate,
       
    49     ETtsGetSpeakingRate,
       
    50     ETtsSupportedLanguages,
       
    51     ETtsSupportedLanguagesCount,
       
    52     ETtsSupportedVoices,
       
    53     ETtsSupportedVoicesCount
       
    54     };
       
    55 
       
    56 // Packages
       
    57 typedef TPckgBuf<TTtsStyleID> TTtsStyleIDPckg;
       
    58 typedef TPckgBuf<TTtsStyleID*> TTtsStyleIDPtrPckg;
       
    59 typedef TPckgBuf<TInt> TTtsIntPckg;
       
    60 typedef TPckgBuf<TInt*> TTtsIntPtrPckg;
       
    61 typedef TPckgBuf<TUint16> TTtsUintPckg;
       
    62 typedef TPckgBuf<TUint16*> TTtsUintPtrPckg;
       
    63 typedef TPckgBuf<TTtsStyle*> TTtsStylePtrPckg;
       
    64 typedef TPckgBuf<TTtsParsedText> TTtsParsedTextPckg;
       
    65 typedef TPckgBuf<RArray<TLanguage>*> TTtsRArrayLanguagePtrPckg;
       
    66 typedef TPckgBuf<TLanguage> TTtsLanguagePckg;
       
    67 typedef TPckgBuf<RArray<TTtsStyle>*> TTtsRArrayTtsStylePtrPckg;
       
    68 
       
    69 // CLASS DECLARATION
       
    70 
       
    71 /**
       
    72 * Container for CTtsParsedText.
       
    73 *
       
    74 * @lib TtsCustomCommands.lib
       
    75 * @since 2.8
       
    76 */
       
    77 class TTtsParsedText
       
    78     {
       
    79     public:
       
    80         
       
    81         /**
       
    82         * C++ default constructor.
       
    83         */
       
    84         TTtsParsedText() {}
       
    85         
       
    86         /**
       
    87         * C++ constructor for this class.
       
    88         *
       
    89         * @since 2.8
       
    90         * @param "CtsParsedText* aParsedText" Pointer to parsed text.
       
    91         */
       
    92         TTtsParsedText( CTtsParsedText* aParsedText ) : 
       
    93                         iParsedText( aParsedText ) {}
       
    94          
       
    95         // Pointer to parsed text
       
    96         CTtsParsedText* iParsedText;
       
    97     };
       
    98 
       
    99 #endif // NSSTTSCUSTOMCOMMANDCOMMON_H
       
   100 
       
   101 // End of file