workspace/libs/solid/control/ifaces/networkmanager.h

   1 /*  This file is part of the KDE project
   2     Copyright (C) 2006 Will Stephenson <wstephenson@kde.org>
   3
   4     This library is free software; you can redistribute it and/or
   5     modify it under the terms of the GNU Library General Public
   6     License version 2 as published by the Free Software Foundation.
   7
   8     This library is distributed in the hope that it will be useful,
   9     but WITHOUT ANY WARRANTY; without even the implied warranty of
  10     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11     Library General Public License for more details.
  12
  13     You should have received a copy of the GNU Library General Public License
  14     along with this library; see the file COPYING.LIB.  If not, write to
  15     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  16     Boston, MA 02110-1301, USA.
  17
  18 */
  19
  20 #ifndef SOLID_IFACES_NETWORKMANAGER
  21 #define SOLID_IFACES_NETWORKMANAGER
  22
  23 #include <QtCore/QObject>
  24 #include <QtCore/QStringList>
  25 #include <solid/networking.h>
  26 #include "../solid_control_export.h"
  27 #include "../networkmanager.h"
  28
  29 namespace Solid
  30 {
  31 namespace Control
  32 {
  33 namespace Ifaces
  34 {
  35     /**
  36      * This class specifies the interface a backend will have to implement in
  37      * order to be used in the system.
  38      *
  39      * A network manager allow to query the underlying platform to discover the
  40      * available network interfaces and reachable network. It has also the
  41      * responsibility to notify when a network interface or a network appear or disappear.
  42      */
  43     class SOLIDCONTROLIFACES_EXPORT NetworkManager : public QObject
  44     {
  45         Q_OBJECT
  46     public:
  47         /**
  48          * Constructs a NetworkManager.
  49          *
  50          * @param parent the parent object
  51          */
  52         NetworkManager(QObject * parent = 0);
  53         /**
  54          * Destructs a NetworkManager object.
  55          */
  56         virtual ~NetworkManager();
  57
  58         /**
  59          * Get the manager connection state
  60          */
  61         virtual Solid::Networking::Status status() const = 0;
  62
  63         /**
  64          * Retrieves the list of all the network interfaces Unique Network Identifiers (UNIs)
  65          * in the system. It includes both hardware and virtual devices.
  66          *
  67          * @return the list of network interfaces available in this system
  68          */
  69         virtual QStringList networkInterfaces() const = 0;
  70
  71         /**
  72          * Instantiates a new NetworkInterface object from this backend given its UNI.
  73          *
  74          * @param uni the identifier of the network interface instantiated
  75          * @returns a new NetworkInterface object if there's a device having the given UNI, 0 otherwise
  76          */
  77         virtual QObject *createNetworkInterface(const QString &uni) = 0;
  78
  79         /**
  80          * Retrieves the activation status of networking (as a whole) in the system.
  81          *
  82          * @return true if this networking is enabled, false otherwise
  83          */
  84         virtual bool isNetworkingEnabled() const = 0;
  85
  86         /**
  87          * Retrieves the activation status of wireless networking in the system.
  88          *
  89          * @return true if this wireless networking is enabled, false otherwise
  90          */
  91         virtual bool isWirelessEnabled() const = 0;
  92
  93         /**
  94          * Retrieves the status of wireless hardware in the system.  This is typically
  95          * controlled by a physical switch so there is no way to set this in software.
  96          *
  97          * @since KDE 4.1
  98          * @return true if this wireless networking is enabled, false otherwise
  99          */
 100         virtual bool isWirelessHardwareEnabled() const = 0;
 101
 102         virtual void activateConnection(const QString & interfaceUni, const QString & connectionUni, const QVariantMap & connectionParameters ) = 0;
 103
 104         virtual void deactivateConnection(const QString & activeConnection) = 0;
 105
 106         /**
 107          * Access the list of active connection UNIs
 108          */
 109         virtual QStringList activeConnections() const = 0;
 110
 111     public Q_SLOTS:
 112         /**
 113          * Activates or deactivates networking (as a whole).
 114          *
 115          * @param enabled true to activate networking, false otherwise
 116          */
 117         virtual void setNetworkingEnabled(bool enabled) = 0;
 118
 119         /**
 120          * Activates or deactivates wireless networking.
 121          *
 122          * @param enabled true to activate wireless networking, false otherwise
 123          */
 124         virtual void setWirelessEnabled(bool enabled) = 0;
 125
 126     Q_SIGNALS:
 127         /**
 128          * This signal is emitted when the system's connection state changes
 129          */
 130         void statusChanged(Solid::Networking::Status status);
 131
 132         /**
 133          * This signal is emitted when a new network interface is available.
 134          *
 135          * @param uni the network interface identifier
 136          */
 137         void networkInterfaceAdded(const QString  & uni);
 138
 139         /**
 140          * This signal is emitted when a network interface is not available anymore.
 141          *
 142          * @param uni the network interface identifier
 143          */
 144         void networkInterfaceRemoved(const QString  & uni);
 145
 146         /**
 147          * This signal is emitted when the status of the wireless changed
 148          */
 149         void wirelessEnabledChanged(bool enabled);
 150
 151         /**
 152          * This signal is emitted when the status of the wireless hardware changed
 153          */
 154         void wirelessHardwareEnabledChanged(bool enabled);
 155
 156         /**
 157          * This signal is emitted when the set of active connections changes
 158          */
 159         void activeConnectionsChanged();
 160     };
 161
 162 } // Ifaces
 163
 164 } // Control
 165
 166 } // Solid
 167
 168 Q_DECLARE_INTERFACE(Solid::Control::Ifaces::NetworkManager, "org.kde.Solid.Control.Ifaces.NetworkManager/0.1")
 169
 170 #endif