btservices_plat/bt_remote_device_setting_api/inc/btdevsettinginterface.h
branchRCL_3
changeset 22 613943a21004
equal deleted inserted replaced
21:0ba996a9b75d 22:613943a21004
       
     1 /*
       
     2 * Copyright (c) 2010 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 plugin interface of Bluetooth device setting ui 
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef BTDEVSETTINGINTERFACE_H
       
    19 #define BTDEVSETTINGINTERFACE_H
       
    20 
       
    21 #include <QtPlugin>
       
    22 #include <btdevsettingglobal.h>
       
    23 #include <btabstractdevsetting.h>
       
    24 
       
    25 /*!
       
    26     \class BtDeviceSettingInterface
       
    27     \brief The class BtDeviceSettingInterface is an interface 
       
    28     for creating a BT device setting plugin instance.
       
    29  */
       
    30 class BTDEVSETTINGINTERFACE_EXPORT BtDevSettingInterface
       
    31 {
       
    32 public:
       
    33     
       
    34     /*!
       
    35      Destructor of BtDeviceSettingPlugin.
       
    36      */
       
    37     virtual ~BtDevSettingInterface() {}
       
    38 
       
    39     /*!
       
    40      Creates a \code BtDeviceSettingPlugin \endcode instance from a 
       
    41      specific plugin. 
       
    42     
       
    43      \param address the BD_ADDR of the remote device which this setting 
       
    44      plugin is provided for. Its format is XXXXXXXXXXXX, where X is a 
       
    45      hexadecimal digit. Case is insensitive.
       
    46      
       
    47      \parent the parent of this object.
       
    48             
       
    49      \return an \code BtDeviceSettingPlugin \endcode instance the ownership of which is 
       
    50                transferred to the plugin loader.
       
    51      */
       
    52     virtual BtAbstractDevSetting *createDevSetting(
       
    53             const QString &address, QObject *parent = 0) = 0;
       
    54 };
       
    55 
       
    56 Q_DECLARE_INTERFACE(BtDevSettingInterface, "com.nokia.bt.devsettinginterface/1.0");
       
    57 
       
    58 #endif /* BTDEVSETTINGINTERFACE_H */