1 /*

     2 * Copyright (c) 2005 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:  Generic interface for VUI plug-in

    15 *

    16 */

    17 

    18 

    19 #ifndef NSSVOICEUIPLUGIN_H

    20 #define NSSVOICEUIPLUGIN_H

    21 

    22 // TYPE DEFINITIONS

    23 

    24 enum TVuipPriority

    25     {

    26     EVuipPriorityExtraLow = 0,

    27     EVuipPriorityLow = 25,

    28     EVuipPriorityNormal = 50,

    29     EVuipPriorityHigh = 75,

    30     EVuipPriorityExtraHigh = 100

    31     };

    32 

    33 

    34 // CLASS DECLARATION

    35 

    36 /**

    37 *  MVoiceUiPlugin defines an interface for VUI plug-ins

    38 *

    39 *  @since 3.1

    40 */

    41 class CVoiceUiPluginBase : public CBase

    42     {

    43      

    44     public:

    45     

    46         /**

    47         * Returns a reference to the array of Uids of events, which are handled by the plug-in.

    48         * @since 3.1

    49         * @param None

    50         * @return Event Uids

    51         */

    52         virtual RArray<TUid>& EventUids() = 0;

    53 

    54         /**

    55         * Runs a task of plug-in

    56         * @since 3.1

    57         * @param aEvent Event which has happened

    58         * @return status of execution: standard error or VUIPF status values

    59         * @see nssvoicestatus.h

    60         */

    61         virtual TInt Execute( TUid aEvent ) = 0;

    62 

    63         /**

    64         * Initializes a plug-in

    65         * @since 3.1

    66         * @param None

    67         * @return None.

    68         */

    69         virtual void InitializeL() = 0;

    70 

    71         /**

    72         * Retirieves a current priority value

    73         * @since 3.1

    74         * @param None

    75         * @return Priority value. 0 is idle, 100 is highest priority.

    76         * @see TVuipPriority

    77         */

    78         inline virtual TVuipPriority Priority() = 0;

    79 

    80     };

    81 

    82 #endif // NSSVOICEUIPLUGIN_H   

    83 

    84 // End of File