speechsrv_plat/vas_api/inc/nssvasmtagselectnotification.h
branchRCL_3
changeset 23 e36f3802f733
parent 0 bf1d17376201
equal deleted inserted replaced
22:cad71a31b7fc 23:e36f3802f733
       
     1 /*
       
     2 * Copyright (c) 2003 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:  The MTagSelectNotification interface class allows the client to
       
    15 *                register and deregister for a voice tag select event.
       
    16 *                See MTagSelectHandler class for event handler. 
       
    17 *
       
    18 */
       
    19 
       
    20 
       
    21 #ifndef MNSSTAGSELECTNOTIFICATION_H
       
    22 #define MNSSTAGSELECTNOTIFICATION_H
       
    23 
       
    24 // INCLUDES
       
    25 #include <e32base.h>
       
    26 #include <e32def.h>
       
    27 #include "nssvasmcontext.h"
       
    28 #include "nssvasmtagselecthandler.h"
       
    29 
       
    30 // CLASS DEFINITIONS
       
    31 
       
    32 /**
       
    33 *  Voice Tag Select Notification class.
       
    34 *  Allows the client to register and deregister for a voice tag select event.
       
    35 *
       
    36 *  @lib NssVASApi.lib
       
    37 *  @since 2.8
       
    38 */
       
    39 
       
    40 class MNssTagSelectNotification
       
    41 {
       
    42 
       
    43 public:
       
    44 
       
    45 
       
    46    public:  //enum
       
    47 
       
    48         enum TNssSelectResult
       
    49         {
       
    50         EVasErrorNone,
       
    51         EVasSelectFailed  
       
    52         };
       
    53 
       
    54         /**
       
    55         * Register for voice tag select notification
       
    56         * @since 2.0
       
    57         * @param aContext The voice tag context which determines notification.
       
    58         * @param aTagSelectHandler The event handler for tag select notification.
       
    59         * @return TSelectError Return code to indicate request was valid.
       
    60         */
       
    61         virtual TNssSelectResult RegisterL(
       
    62             MNssContext* aContext,
       
    63 			MNssTagSelectHandler* aTagSelectHandler) = 0;
       
    64 
       
    65        /**
       
    66         * Deegister from voice tag select notification
       
    67         * @since 2.0
       
    68         * @param aContext The voice tag context which determines notification.
       
    69         * @param aTagSelectHandler The event handler for tag select notification,
       
    70 		*                          used to deregister the correct client.
       
    71         * @return TSelectError Return code to indicate request was valid.
       
    72         */
       
    73         virtual TNssSelectResult Deregister(
       
    74             MNssContext* aContext,
       
    75 			MNssTagSelectHandler * aTagSelectHandler) = 0;
       
    76 
       
    77 };
       
    78 
       
    79 #endif // MNSSTAGSELECTNOTIFICATION_H
       
    80 
       
    81 // End of File