bluetoothengine/btnotif/btnotifsrv/inc/btnotificationresult.h
author hgs
Mon, 12 Jul 2010 18:51:05 +0300
changeset 42 b72428996822
parent 29 48ae3789ce00
permissions -rw-r--r--
201025
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     1
/*
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     2
* ============================================================================
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     3
*  Name        : btnotificationresult.h
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     4
*  Part of     : bluetoothengine / btnotif
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     5
*  Description : Abstract interface for receiving the result of a user query.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     6
*
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     7
*  Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies).
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     8
*  All rights reserved.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     9
*  This component and the accompanying materials are made available
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    10
*  under the terms of "Eclipse Public License v1.0"
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    11
*  which accompanies this distribution, and is available
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    12
*  at the URL "http://www.eclipse.org/legal/epl-v10.html".
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    13
*
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    14
*  Initial Contributors:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    15
*  Nokia Corporation - initial contribution.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    16
*
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    17
*  Contributors:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    18
*  Nokia Corporation
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    19
* ============================================================================
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    20
* Template version: 4.2
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    21
*/
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    22
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    23
#ifndef BTNOTIFICATIONRESULT_H
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    24
#define BTNOTIFICATIONRESULT_H
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    25
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    26
class CHbSymbianVariantMap;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    27
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    28
/**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    29
 *  MBTNotificationResult returns the result from a user query.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    30
 *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    31
 *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    32
 *  @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    33
 */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    34
class MBTNotificationResult
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    35
    {
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    36
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    37
public:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    38
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    39
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    40
     * Handle an intermediate result from a user query.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    41
     * This function is called if the user query passes information
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    42
     * back before it has finished i.e. is dismissed. The final acceptance/
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    43
     * denial of a query is passed back in MBRNotificationClosed.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    44
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    45
     * @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    46
     * @param aData the returned data. The actual format 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    47
     *              is dependent on the actual notifier.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    48
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    49
    virtual void MBRDataReceived( CHbSymbianVariantMap& aData ) = 0;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    50
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    51
    
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    52
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    53
     * The notification is finished. The resulting data (e.g. user input or
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    54
     * acceptance/denial of the query) is passed back here.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    55
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    56
     * @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    57
     * @param aErr KErrNone or one of the system-wide error codes.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    58
     * @param aData the returned data. The actual format 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    59
     *              is dependent on the actual notifier.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    60
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    61
    virtual void MBRNotificationClosed( TInt aError, const TDesC8& aData ) = 0;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    62
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    63
    };
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    64
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    65
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    66
#endif // BTNOTIFICATIONRESULT_H