speechsrv_plat/voice_ui_plugin_api/inc/nssvoiceevent.h
branchRCL_3
changeset 19 e36f3802f733
parent 0 bf1d17376201
equal deleted inserted replaced
18:cad71a31b7fc 19:e36f3802f733
       
     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:  Definition of voice event interfaces
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef NSSVOICEEVENT_H
       
    20 #define NSSVOICEEVENT_H
       
    21 
       
    22 
       
    23 // CLASS DECLARATION
       
    24 
       
    25 /**
       
    26 *  MVoiceEventExecutor for notifies VoiceUI Plug-in Handler about voice event
       
    27 *
       
    28 *  @since 3.1
       
    29 */
       
    30 class MVoiceEventExecutor
       
    31     {
       
    32   
       
    33     public: 
       
    34         
       
    35         /**
       
    36         * Notifies observer that a voice event needs to be handled.
       
    37         * @since 3.1
       
    38         * @param aEventUID UID of voice event
       
    39         * @return One of the system wide error codes, KErrNone if successful.
       
    40         */
       
    41         virtual TInt VoiceEvent( TUid aEventUid ) = 0;
       
    42     };
       
    43 
       
    44 /**
       
    45 *  MVoiceEventObserverPlugin determines VoiceUI Plug-in interface.
       
    46 *
       
    47 *  @since 3.1
       
    48 */
       
    49 class CVoiceEventObserverPluginBase : public CBase
       
    50     {
       
    51   
       
    52     public: 
       
    53 
       
    54         /**
       
    55         * Initializes a plug-in
       
    56         * @since 3.1
       
    57         * @param aEventHandler reference to a voice event handler.
       
    58         * @return none
       
    59         */
       
    60         virtual void InitializeL( MVoiceEventExecutor& aEventHandler ) = 0;
       
    61         
       
    62     };
       
    63 
       
    64 #endif // NSSVOICEEVENT_H   
       
    65 
       
    66 // End of File