bluetoothengine/btnotif/inc/bluetoothdevicedialogs.h
author hgs
Mon, 17 May 2010 11:06:23 +0300
changeset 31 a0ea99b6fa53
parent 29 48ae3789ce00
child 40 997690c3397a
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
/*
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     2
* ============================================================================
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     3
*  Name        : bluetoothdevicedialogs.h
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     4
*  Part of     : bluetoothengine / btnotif
48ae3789ce00 201017_2
hgs
parents:
diff changeset
     5
*  Description : Data structures for passing dialog type and formatting between btnotif and the UI component showing the actual dialogs. Also defines identifiers for Bluetooth device dialogs.
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 BLUETOOTHDEVICEDIALOGS_H
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    24
#define BLUETOOTHDEVICEDIALOGS_H
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    25
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    26
#include <btdevice.h>
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    27
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    28
/**  Enumeration for the type of notification to be launched. */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    29
enum TBTDialogResourceId
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    30
    {
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    31
    ENoResource,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    32
    EAuthorization,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    33
    EIncomingPairing,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    34
    EPinInput,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    35
    ENumericComparison,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    36
    EPasskeyDisplay,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    37
    EObexPasskeyInput,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    38
    ESetTrusted,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    39
    EBlockUnpairedDevice,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    40
    EBlockPairedDevice,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    41
    EPairingSuccess,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    42
    EPairingFailure,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    43
    EVisibilityTimeout,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    44
    EUnusedResource	// The last ID
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    45
    };
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    46
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    47
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    48
/**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    49
 *  TBluetoothDialogParams contains device dialog parameters except for device name and type
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    50
 *
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    51
 *  @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    52
 */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    53
NONSHARABLE_CLASS( TBluetoothDialogParams )
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    54
    {
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    55
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    56
public:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    57
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    58
    /**  Enumeration for the type of notification to be launched. */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    59
    enum TBTDialogType
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    60
        {
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    61
        EInvalidDialog,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    62
        ENote,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    63
        EQuery,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    64
        EInput,
31
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
    65
        EMoreDevice,
29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    66
        EDeviceSearch,
31
a0ea99b6fa53 201019_1
hgs
parents: 29
diff changeset
    67
        ESend,
29
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    68
        EGlobalNotif
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    69
        };
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    70
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    71
    /**  Enumeration for the notification parameters data type to be configured. */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    72
    enum TDialogDataType
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    73
        {
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    74
        ENoParams,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    75
        EDialogType,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    76
        EResource,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    77
        EAddress,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    78
        EDialogTitle,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    79
        EDialogExt  // Id for first data type of derived class.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    80
        };
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    81
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    82
    inline TBluetoothDialogParams();
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    83
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    84
public: // data
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    85
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    86
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    87
     * Identifier for the type of notification.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    88
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    89
    TInt iDialogType;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    90
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    91
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    92
     * Identifier for the resource to be shown in the dialog.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    93
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    94
    TInt iResourceId;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    95
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    96
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    97
     * Address of the remote device (not used, for future extension).
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    98
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
    99
    TBTDevAddr iAddr;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   100
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   101
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   102
     * Unused padding (not used, for future extension).
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   103
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   104
    TUint32 iPadding;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   105
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   106
    };
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   107
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   108
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   109
/**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   110
 *  TBluetoothDeviceDialog contains more device dialog parameters 
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   111
 *  
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   112
 *  @since Symbian^4
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   113
 */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   114
NONSHARABLE_CLASS( TBluetoothDeviceDialog ) : public TBluetoothDialogParams
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   115
    {
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   116
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   117
public:
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   118
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   119
    /**  Enumeration for the notification parameters data type to be configured. */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   120
    enum TDialogDataType
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   121
        {
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   122
        ENoParams = TBluetoothDialogParams::EDialogExt,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   123
        EDeviceName,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   124
        EDeviceClass,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   125
        EAdditionalInt,
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   126
        EAdditionalDesc
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   127
        };
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   128
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   129
    inline TBluetoothDeviceDialog();
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   130
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   131
public: // data
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   132
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   133
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   134
     * The name of the remote device.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   135
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   136
    TBTDeviceName iDeviceName;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   137
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   138
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   139
     * The class of device of the remote device.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   140
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   141
    TInt iDeviceClass;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   142
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   143
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   144
     * Additional data depending on the resource.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   145
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   146
    TInt iIntParam;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   147
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   148
    /**
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   149
     * Additional data depending on the resource.
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   150
     */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   151
    TBuf<10> iDescParam;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   152
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   153
    };
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   154
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   155
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   156
/**  Typedef'ed pckgbuf to send dialog parameters to the notification framework. */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   157
typedef TPckgBuf<TBluetoothDialogParams> TBluetoothDialogParamsPckg;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   158
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   159
/**  Typedef'ed pckgbuf to send dialog parameters to the notification framework. */
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   160
typedef TPckgBuf<TBluetoothDeviceDialog> TBluetoothDeviceDialogPckg;
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   161
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   162
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   163
inline TBluetoothDialogParams::TBluetoothDialogParams()
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   164
:   iDialogType( EInvalidDialog ),
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   165
    iResourceId( ENoResource ),
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   166
    iAddr( TBTDevAddr() ),
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   167
    iPadding( 0 )
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   168
    {
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   169
    }
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   170
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   171
inline TBluetoothDeviceDialog::TBluetoothDeviceDialog()
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   172
:   iDeviceName( 0 ),
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   173
    iDeviceClass( 0 ),
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   174
    iIntParam( 0 )
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   175
    {
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   176
    }
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   177
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   178
48ae3789ce00 201017_2
hgs
parents:
diff changeset
   179
#endif // BLUETOOTHDEVICEDIALOGS_H