usbuis/usbindicatorplugin/inc/usbindicatorplugin.h
author hgs
Mon, 17 May 2010 11:03:15 +0300
changeset 52 831068540b07
child 56 f45583a69686
permissions -rw-r--r--
201019_1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
52
831068540b07 201019_1
hgs
parents:
diff changeset
     1
/*
831068540b07 201019_1
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
831068540b07 201019_1
hgs
parents:
diff changeset
     3
* All rights reserved.
831068540b07 201019_1
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
831068540b07 201019_1
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
831068540b07 201019_1
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
831068540b07 201019_1
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
831068540b07 201019_1
hgs
parents:
diff changeset
     8
*
831068540b07 201019_1
hgs
parents:
diff changeset
     9
* Initial Contributors:
831068540b07 201019_1
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
831068540b07 201019_1
hgs
parents:
diff changeset
    11
*
831068540b07 201019_1
hgs
parents:
diff changeset
    12
* Contributors:
831068540b07 201019_1
hgs
parents:
diff changeset
    13
*
831068540b07 201019_1
hgs
parents:
diff changeset
    14
* Description: USB Indicator Plugin Class
831068540b07 201019_1
hgs
parents:
diff changeset
    15
*
831068540b07 201019_1
hgs
parents:
diff changeset
    16
*/
831068540b07 201019_1
hgs
parents:
diff changeset
    17
831068540b07 201019_1
hgs
parents:
diff changeset
    18
#ifndef USBINDICATORPLUGIN_H
831068540b07 201019_1
hgs
parents:
diff changeset
    19
#define USBINDICATORPLUGIN_H
831068540b07 201019_1
hgs
parents:
diff changeset
    20
831068540b07 201019_1
hgs
parents:
diff changeset
    21
831068540b07 201019_1
hgs
parents:
diff changeset
    22
#include <hbindicatorplugininterface.h>
831068540b07 201019_1
hgs
parents:
diff changeset
    23
#include <hbindicatorinterface.h>
831068540b07 201019_1
hgs
parents:
diff changeset
    24
#include <QTranslator>
831068540b07 201019_1
hgs
parents:
diff changeset
    25
831068540b07 201019_1
hgs
parents:
diff changeset
    26
const QString ConnectedIndicator = ("com.nokia.hb.indicator.usb.device.connected/1.0");
831068540b07 201019_1
hgs
parents:
diff changeset
    27
const QString AddressedIndicator = ("com.nokia.hb.indicator.usb.device.inprogress/1.0" );
831068540b07 201019_1
hgs
parents:
diff changeset
    28
831068540b07 201019_1
hgs
parents:
diff changeset
    29
_LIT(KUSBExe, "USBSettingsApp.exe");
831068540b07 201019_1
hgs
parents:
diff changeset
    30
const TInt KUSBUIUid = 0x2002E70C;
831068540b07 201019_1
hgs
parents:
diff changeset
    31
831068540b07 201019_1
hgs
parents:
diff changeset
    32
/*!
831068540b07 201019_1
hgs
parents:
diff changeset
    33
   USB indicator plugin class. 
831068540b07 201019_1
hgs
parents:
diff changeset
    34
   Main class of USB indicator plugin. 
831068540b07 201019_1
hgs
parents:
diff changeset
    35
 */
831068540b07 201019_1
hgs
parents:
diff changeset
    36
class UsbIndicatorPlugin : public QObject, public HbIndicatorPluginInterface
831068540b07 201019_1
hgs
parents:
diff changeset
    37
{
831068540b07 201019_1
hgs
parents:
diff changeset
    38
    Q_OBJECT
831068540b07 201019_1
hgs
parents:
diff changeset
    39
    Q_INTERFACES(HbIndicatorPluginInterface)
831068540b07 201019_1
hgs
parents:
diff changeset
    40
831068540b07 201019_1
hgs
parents:
diff changeset
    41
public:
831068540b07 201019_1
hgs
parents:
diff changeset
    42
    /*!
831068540b07 201019_1
hgs
parents:
diff changeset
    43
       Constructor
831068540b07 201019_1
hgs
parents:
diff changeset
    44
     */
831068540b07 201019_1
hgs
parents:
diff changeset
    45
    UsbIndicatorPlugin();
831068540b07 201019_1
hgs
parents:
diff changeset
    46
     
831068540b07 201019_1
hgs
parents:
diff changeset
    47
     /*!
831068540b07 201019_1
hgs
parents:
diff changeset
    48
        Destructor
831068540b07 201019_1
hgs
parents:
diff changeset
    49
      */
831068540b07 201019_1
hgs
parents:
diff changeset
    50
    ~UsbIndicatorPlugin();
831068540b07 201019_1
hgs
parents:
diff changeset
    51
    
831068540b07 201019_1
hgs
parents:
diff changeset
    52
    /*!
831068540b07 201019_1
hgs
parents:
diff changeset
    53
       @see HbIndicatorPluginInterface
831068540b07 201019_1
hgs
parents:
diff changeset
    54
     */
831068540b07 201019_1
hgs
parents:
diff changeset
    55
    QStringList indicatorTypes() const;
831068540b07 201019_1
hgs
parents:
diff changeset
    56
    
831068540b07 201019_1
hgs
parents:
diff changeset
    57
    /*!
831068540b07 201019_1
hgs
parents:
diff changeset
    58
       @see HbIndicatorPluginInterface
831068540b07 201019_1
hgs
parents:
diff changeset
    59
     */
831068540b07 201019_1
hgs
parents:
diff changeset
    60
    inline bool accessAllowed(const QString &indicatorType,
831068540b07 201019_1
hgs
parents:
diff changeset
    61
            const QVariantMap &securityInfo) const;   
831068540b07 201019_1
hgs
parents:
diff changeset
    62
    /*!
831068540b07 201019_1
hgs
parents:
diff changeset
    63
       @see HbIndicatorPluginInterface
831068540b07 201019_1
hgs
parents:
diff changeset
    64
     */
831068540b07 201019_1
hgs
parents:
diff changeset
    65
    HbIndicatorInterface* createIndicator(const QString &indicatorType);
831068540b07 201019_1
hgs
parents:
diff changeset
    66
    
831068540b07 201019_1
hgs
parents:
diff changeset
    67
    /*!
831068540b07 201019_1
hgs
parents:
diff changeset
    68
       @see HbIndicatorPluginInterface
831068540b07 201019_1
hgs
parents:
diff changeset
    69
     */
831068540b07 201019_1
hgs
parents:
diff changeset
    70
    inline int error() const;
831068540b07 201019_1
hgs
parents:
diff changeset
    71
    
831068540b07 201019_1
hgs
parents:
diff changeset
    72
private:
831068540b07 201019_1
hgs
parents:
diff changeset
    73
    Q_DISABLE_COPY(UsbIndicatorPlugin)
831068540b07 201019_1
hgs
parents:
diff changeset
    74
    
831068540b07 201019_1
hgs
parents:
diff changeset
    75
    /*!
831068540b07 201019_1
hgs
parents:
diff changeset
    76
       Error value
831068540b07 201019_1
hgs
parents:
diff changeset
    77
     */
831068540b07 201019_1
hgs
parents:
diff changeset
    78
    int mError;
831068540b07 201019_1
hgs
parents:
diff changeset
    79
    
831068540b07 201019_1
hgs
parents:
diff changeset
    80
    /*!
831068540b07 201019_1
hgs
parents:
diff changeset
    81
       Indicator types 
831068540b07 201019_1
hgs
parents:
diff changeset
    82
       supported indicator types. 
831068540b07 201019_1
hgs
parents:
diff changeset
    83
     */
831068540b07 201019_1
hgs
parents:
diff changeset
    84
    QStringList mIndicatorTypes;
831068540b07 201019_1
hgs
parents:
diff changeset
    85
    
831068540b07 201019_1
hgs
parents:
diff changeset
    86
    bool mTranslatorLoaded;
831068540b07 201019_1
hgs
parents:
diff changeset
    87
    
831068540b07 201019_1
hgs
parents:
diff changeset
    88
    QTranslator mTranslator;
831068540b07 201019_1
hgs
parents:
diff changeset
    89
};
831068540b07 201019_1
hgs
parents:
diff changeset
    90
831068540b07 201019_1
hgs
parents:
diff changeset
    91
// ----------------------------------------------------------------------------
831068540b07 201019_1
hgs
parents:
diff changeset
    92
// UsbIndicatorPlugin::accessAllowed
831068540b07 201019_1
hgs
parents:
diff changeset
    93
// ----------------------------------------------------------------------------
831068540b07 201019_1
hgs
parents:
diff changeset
    94
bool UsbIndicatorPlugin::accessAllowed(const QString &indicatorType,
831068540b07 201019_1
hgs
parents:
diff changeset
    95
    const QVariantMap &securityInfo) const
831068540b07 201019_1
hgs
parents:
diff changeset
    96
{
831068540b07 201019_1
hgs
parents:
diff changeset
    97
    Q_UNUSED(indicatorType)
831068540b07 201019_1
hgs
parents:
diff changeset
    98
    Q_UNUSED(securityInfo)
831068540b07 201019_1
hgs
parents:
diff changeset
    99
831068540b07 201019_1
hgs
parents:
diff changeset
   100
    // This plugin doesn't perform operations that may compromise security.
831068540b07 201019_1
hgs
parents:
diff changeset
   101
    // All clients are allowed to use.
831068540b07 201019_1
hgs
parents:
diff changeset
   102
    return true;
831068540b07 201019_1
hgs
parents:
diff changeset
   103
}
831068540b07 201019_1
hgs
parents:
diff changeset
   104
831068540b07 201019_1
hgs
parents:
diff changeset
   105
// ----------------------------------------------------------------------------
831068540b07 201019_1
hgs
parents:
diff changeset
   106
// UsbIndicatorPlugin::error
831068540b07 201019_1
hgs
parents:
diff changeset
   107
// ----------------------------------------------------------------------------
831068540b07 201019_1
hgs
parents:
diff changeset
   108
inline int UsbIndicatorPlugin::error() const
831068540b07 201019_1
hgs
parents:
diff changeset
   109
{
831068540b07 201019_1
hgs
parents:
diff changeset
   110
    return mError;
831068540b07 201019_1
hgs
parents:
diff changeset
   111
}
831068540b07 201019_1
hgs
parents:
diff changeset
   112
831068540b07 201019_1
hgs
parents:
diff changeset
   113
831068540b07 201019_1
hgs
parents:
diff changeset
   114
#endif /* USBIndicatorPlugin_H */