bluetoothengine/btnotif/btnotifsrv/inc/btnotifsettingstracker.h
author hgs
Mon, 17 May 2010 11:06:23 +0300
changeset 31 a0ea99b6fa53
parent 29 48ae3789ce00
permissions -rw-r--r--
201019_1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     1
/*
31
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
     3
* All rights reserved.
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
     4
* This component and the accompanying materials are made available
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
     6
* which accompanies this distribution, and is available
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     8
*
31
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
     9
* Initial Contributors:
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
    10
* Nokia Corporation - initial contribution.
29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    11
*
31
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
    12
* Contributors:
29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    13
*
31
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
    14
* Description: Class for tracking Bluetooth settings, and also for 
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
    15
* handling notes unrelated to specific connection.
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
    16
*
29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    17
*/
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    18
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    19
#ifndef BTNOTIFSETTINGSTRACKER_H
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    20
#define BTNOTIFSETTINGSTRACKER_H
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    21
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    22
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    23
#include <e32base.h>
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    24
#include <btengsettings.h>
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    25
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    26
#include "bluetoothnotification.h"
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    27
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    28
class CBTNotifServer;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    30
/**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    31
 * CBTNotifSettingsTracker keeps track of local device settings
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    32
 * 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    33
 * @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    34
 */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    35
NONSHARABLE_CLASS( CBTNotifSettingsTracker ) : public CBase,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    36
                                               public MBTEngSettingsObserver,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    37
                                               public MBTNotificationResult
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    38
    {
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    39
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    40
public:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    41
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    42
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    43
     * Two-phased constructor.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    44
     * @param aServer Pointer to our parent
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    45
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    46
    static CBTNotifSettingsTracker* NewL( CBTNotifServer* aServer );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    47
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    48
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    49
    * Destructor.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    50
    */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    51
    virtual ~CBTNotifSettingsTracker();
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    52
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    53
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    54
     * Return the current power state
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
     * @return The current power state.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    58
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    59
    inline TBTPowerStateValue GetPowerState() const
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    60
        { return iPowerState; }
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    61
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    62
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    63
     * Processes a message from a notifier client related to settings.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    64
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    65
     * @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    66
     * @param aMessage The message containing the details of the client request.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    67
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    68
    void DispatchNotifierMessageL( const RMessage2& aMessage );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    69
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    70
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    71
     * Cancels an oustanding message from a notifier client related to settings.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    72
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    73
     * @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    74
     * @param aMessage The message containing the details of the original client request.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    75
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    76
    void CancelNotifierMessageL( const RMessage2& aMessage );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    77
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    78
// from base class MBTEngSettingsObserver
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    79
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    80
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    81
     * From MBTEngSettingsObserver.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    82
     * Provides notification of changes in the power state 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    83
     * of the Bluetooth hardware.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    84
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    85
     * @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    86
     * @param aState EBTPowerOff if the BT hardware has been turned off, 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    87
     *               EBTPowerOn if it has been turned off.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    88
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    89
    virtual void PowerStateChanged( TBTPowerStateValue aState );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    90
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    91
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    92
     * From MBTEngSettingsObserver.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    93
     * Provides notification of changes in the discoverability 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    94
     * mode of the Bluetooth hardware.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    95
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    96
     * @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    97
     * @param aState EBTDiscModeHidden if the BT hardware is in hidden mode, 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    98
     *               EBTDiscModeGeneral if it is in visible mode.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    99
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   100
    virtual void VisibilityModeChanged( TBTVisibilityMode aState );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   101
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   102
// from base class MBTNotificationResult
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   103
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   104
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   105
     * From MBTNotificationResult.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   106
     * Handle an intermediate result from a user query.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   107
     * This ffunction is called if the user query passes information
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   108
     * back before it has finished i.e. is dismissed. The final acceptance/
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   109
     * denial of a query is passed back in MBRNotificationClosed.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   110
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   111
     * @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   112
     * @param aData the returned data. The actual format 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   113
     *              is dependent on the actual notifier.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   114
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   115
    virtual void MBRDataReceived( CHbSymbianVariantMap& aData );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   116
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   117
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   118
     * From MBTNotificationResult.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   119
     * The notification is finished. The resulting data (e.g. user input or
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   120
     * acceptance/denial of the query) is passed back here.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   121
     *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   122
     * @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   123
     * @param aErr KErrNone or one of the system-wide error codes.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   124
     * @param aData the returned data. The actual format 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   125
     *              is dependent on the actual notifier.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   126
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   127
    virtual void MBRNotificationClosed( TInt aError, const TDesC8& aData );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   128
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   129
private:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   130
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   131
    CBTNotifSettingsTracker( CBTNotifServer* aServer );
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   132
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   133
    void ConstructL();
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   134
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   135
private: // data
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   136
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   137
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   138
     * Local copy of current power state.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   139
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   140
    TBTPowerStateValue iPowerState;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   141
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   142
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   143
     * Local copy of current visibility mode.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   144
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   145
    TBTVisibilityMode iVisibilityMode;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   146
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   147
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   148
     * ?description_of_pointer_member
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   149
     * Own.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   150
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   151
    CBTEngSettings* iSettings;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   152
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   153
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   154
     * Pointer to an outstanding user interaction.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   155
     * Not own.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   156
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   157
    CBluetoothNotification* iNotification;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   158
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   159
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   160
     * Reference to our parent the server class.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   161
     * Not own.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   162
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   163
    CBTNotifServer* iServer;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   164
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   165
    };
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   166
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   167
#endif // BTNOTIFSETTINGSTRACKER_H