1 /*

     2 * Copyright (c) 2004 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:  Interface towards Tts custom command parser, public methods

    15 *                called by the MMF

    16 *

    17 */

    18 

    19 

    20 #ifndef TTSCUSTOMCOMMANDPARSER_H

    21 #define TTSCUSTOMCOMMANDPARSER_H

    22 

    23 // INCLUDE FILES

    24 #include <mmfcontroller.h>

    25 #include <nssttscustomcommandimplementor.h>

    26 

    27 // CLASS DECLARATION

    28 

    29 /**

    30 * Server side parser for TTS custom commands. 

    31 *

    32 * @since 2.8

    33 * @lib nssttscustomcommands.lib

    34 */

    35 class CTtsCustomCommandParser : public CMMFCustomCommandParserBase

    36     {

    37     

    38     public:

    39         

    40         /** 

    41         * Factory function for creating this class.

    42         *

    43         * @since 2.8

    44         * @param "MTtsCustomCommandImplementor& aImplementor" Rreference to 

    45         *        custom commands implementor.

    46         * @return Pointer to CSpeechRecognitionCustomCommandParser object.

    47         */

    48         IMPORT_C static CTtsCustomCommandParser* NewL( MTtsCustomCommandImplementor& aImplementor );

    49         

    50         /**

    51         * Destructor

    52         */

    53         IMPORT_C  ~CTtsCustomCommandParser();

    54         

    55         /**

    56         * Handles the request from the client

    57         *

    58         * @since 2.8

    59         * @param "TMMFMessage& aMessage" Message containing the CC information.

    60         */

    61         void HandleRequest( TMMFMessage& aMessage );

    62         

    63     private:

    64         

    65         /**

    66         * C++ constructor for CSpeechRecognitionCustomCommandParser class.

    67         *

    68         * @since 2.8

    69         * @param "MTtsCustomCommandImplementor& aImplementor" Reference to 

    70         *        custom commands implementor.

    71         */

    72         CTtsCustomCommandParser( MTtsCustomCommandImplementor& aImplementor );

    73         

    74         /**

    75         * Private method to handle the request from the client.

    76         *

    77         * @since 2.8

    78         * @param "TMMFMessage& aMessage" Message containing the information

    79         *        of the request.

    80         */

    81         void DoHandleRequestL( TMMFMessage& aMessage );

    82 

    83         /**

    84         * Uses plugin to add a new style.

    85         *

    86         * @since 2.8

    87         * @param "TMMFMessage& aMessage" MMF message.

    88         */

    89         void DoAddStyleL( TMMFMessage& aMessage );

    90 

    91         /**

    92         * Uses plugin to delete a style.

    93         *

    94         * @since 2.8

    95         * @param "TMMFMessage& aMessage" MMF message.

    96         */

    97         void DoDeleteStyleL( TMMFMessage& aMessage );

    98 

    99         /**

   100         * Uses plugin to get the synthesis position.

   101         *

   102         * @since 2.8

   103         * @param "TMMFMessage& aMessage" MMF message.

   104         */

   105         void DoGetPositionL( TMMFMessage& aMessage );

   106       

   107         /**

   108         * Uses plugin to get the number of registered styles.

   109         *

   110         * @since 2.8

   111         * @param "TMMFMessage& aMessage" MMF message.

   112         */

   113         void DoNumberOfStylesL( TMMFMessage& aMessage );

   114 

   115         /**

   116         * Uses plugin to open a parsed text source.

   117         *

   118         * @since 2.8

   119         * @param "TMMFMessage& aMessage" MMF message.

   120         */

   121         void DoOpenParsedTextL( TMMFMessage& aMessage );

   122 

   123         /**

   124         * Uses plugin to set synthesis position.

   125         *

   126         * @since 2.8

   127         * @param "TMMFMessage& aMessage" MMF message.

   128         */

   129         void DoSetPositionL( TMMFMessage& aMessage );

   130 

   131         /**

   132         * Uses plugin to get style based on its ID.

   133         *

   134         * @since 2.8

   135         * @param "TMMFMessage& aMessage" MMF message.

   136         */

   137         void DoStyleIDL( TMMFMessage& aMessage );

   138 

   139         /**

   140         * Uses plugin to get style based on its index.

   141         *

   142         * @since 2.8

   143         * @param "TMMFMessage& aMessage" MMF message.

   144         */

   145         void DoStyleIndexL( TMMFMessage& aMessage );

   146 

   147         /**

   148         * Uses plugin to set default style to be used in synthesis

   149         * if not set otherwise. 

   150         *

   151         * @since 3.2

   152         * @param "TMMFMessage& aMessage" MMF message.

   153         */

   154         void DoSetDefaultStyleL( TMMFMessage& aMessage );

   155 

   156         /**

   157         * Uses plugin to get the default style in use. 

   158         *

   159         * @since 3.2

   160         * @param "TMMFMessage& aMessage" MMF message.

   161         */

   162         void DoGetDefaultStyleL( TMMFMessage& aMessage );

   163 

   164         /**

   165         * Uses plugin to set speaking rate. 

   166         *

   167         * @since 3.2

   168         * @param "TMMFMessage& aMessage" MMF message.

   169         */

   170         void DoSetSpeakingRateL( TMMFMessage& aMessage );

   171 

   172         /**

   173         * Uses plugin to get spekaing rate in use. 

   174         *

   175         * @since 3.2

   176         * @param "TMMFMessage& aMessage" MMF message.

   177         */

   178         void DoGetSpeakingRateL( TMMFMessage& aMessage );

   179 

   180         /**

   181         * Uses plugin to get supported synthesis languages. 

   182         *

   183         * @since 3.2

   184         * @param "TMMFMessage& aMessage" MMF message.

   185         */

   186         void DoGetSupportedLanguagesL( TMMFMessage& aMessage );

   187 

   188         /**

   189         * Uses plugin to get number of supported synthesis languages. 

   190         *

   191         * @since 3.2

   192         * @param "TMMFMessage& aMessage" MMF message.

   193         */

   194         void DoGetSupportedLanguagesCountL( TMMFMessage& aMessage );

   195 

   196         /**

   197         * Uses plugin to get supported voices of particular language. 

   198         *

   199         * @since 3.2

   200         * @param "TMMFMessage& aMessage" MMF message.

   201         */

   202         void DoGetSupportedVoicesL( TMMFMessage& aMessage );

   203 

   204         /**

   205         * Uses plugin to get number of supported voices of particular language. 

   206         *

   207         * @since 3.2

   208         * @param "TMMFMessage& aMessage" MMF message.

   209         */

   210         void DoGetSupportedVoicesCountL( TMMFMessage& aMessage );

   211 

   212     private:

   213     

   214         // Reference to the Custom Command Implementor class

   215         MTtsCustomCommandImplementor& iImplementor; 

   216   

   217         TAny* iReservedPtr1; // Reserved for future expansion

   218         TAny* iReservedPtr2; // Reserved for future expansion

   219 };

   220 

   221 #endif // TTSCUSTOMCOMMANDPARSER_H

   222 

   223 // End of file