kdeconnect-kde/core/kdeconnectplugin.h
2020-03-10 19:49:41 +00:00

77 lines
2.3 KiB
C++

/**
* Copyright 2013 Albert Vaca <albertvaka@gmail.com>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License or (at your option) version 3 or any later version
* accepted by the membership of KDE e.V. (or its successor approved
* by the membership of KDE e.V.), which shall act as a proxy
* defined in Section 14 of version 3 of the license.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#ifndef KDECONNECTPLUGIN_H
#define KDECONNECTPLUGIN_H
#include <QObject>
#include <QVariantList>
#include <kcoreaddons_version.h>
#include "kdeconnectcore_export.h"
#include "kdeconnectpluginconfig.h"
#include "networkpacket.h"
#include "device.h"
#if KCOREADDONS_VERSION < QT_VERSION_CHECK(5,44,0)
#define K_PLUGIN_CLASS_WITH_JSON(classname,jsonFile) K_PLUGIN_FACTORY_WITH_JSON(classname ## Factory, jsonFile, registerPlugin<classname >();)
#endif
struct KdeConnectPluginPrivate;
class KDECONNECTCORE_EXPORT KdeConnectPlugin
: public QObject
{
Q_OBJECT
public:
KdeConnectPlugin(QObject* parent, const QVariantList& args);
~KdeConnectPlugin() override;
const Device* device();
Device const* device() const;
bool sendPacket(NetworkPacket& np) const;
KdeConnectPluginConfig* config() const;
virtual QString dbusPath() const;
QString iconName() const;
public Q_SLOTS:
/**
* Returns true if it has handled the packet in some way
* device.sendPacket can be used to send an answer back to the device
*/
virtual bool receivePacket(const NetworkPacket& np) = 0;
/**
* This method will be called when a device is connected to this computer.
* The plugin could be loaded already, but there is no guarantee we will be able to reach the device until this is called.
*/
virtual void connected() = 0;
private:
QScopedPointer<KdeConnectPluginPrivate> d;
};
#endif