kdeconnect-kde/interfaces/dbusinterfaces.h
Holger Kaelberer 040ad7357b kdeconnect-kde: Add remotekeyboard plugin
Allow to inject keypress events to remote peers (most notably Android devices)

Notes / open issues / possible improvements:

- For the json-payload I used the syntax of the key-events as sent by mousepad-plugin with the addition of a "sendAck"-flag. If "sendAck" is set to true the remote peer should echo a key-event if it could be handled, thus allowing the local client to find out whether the key was accepted. For performance reasons, it's allowed to send multi-char strings in the "key" property (performs much better if you send a whole string via "echo '...' |  kdeconnect-cli ..." e.g.)

- kdeconnect-cli: For now takes a string and transforms it into single key-events for visible characters only. In a first implementation I used a kbhit() helper that used termios.h to catch and relay keypresses interactively (including some special-events), which was not optimal. A better approch might be to use linux input-api directly. Would this be an option regarding cross-platform compatibility or can I assume to develop for Linux only? Being a command-line guy, I'd really like to have a fully featured kdeconnect-cli interface ;-)

- Factor out the Qt::Key-to-internal keymap to some core-helper because it corresponds to the mapping in the mousepad-plugin?

- The plasmoid is not perfect as it is: A single line containing a non-echoing TextField (i.e. it eats all the KeyPress events), and only ack-ed keypress-packets from the peer device are injected if they contain visible keys. Advantage: the user sees whether his key-presses are accepted by the peer device. Disadvantage: The echoed text does not correspond 1:1 to what is shown on the peer's display, user might be confused when typing without success. I played around with different variations each of which with its proper shortcomings:
1. An echoing Textfield for typing: Has the advantage that the user can directly see what he is typing, which makes interaction in the typing field easier, BUT messes up interaction if the Editor on the peer is changed silently and does not notify the user if his keypresses are not handled by the peer.
2. A non-echoing TextField for typing PLUS a readonly one for printing visible echoed keys. Disadvantage: same as for the previous one and uses more space on the plasmoid.
Comments? Ideas?

REVIEW: 129727
BUG: 370919
2017-01-10 21:12:42 +01:00

193 lines
6.4 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 <http://www.gnu.org/licenses/>.
*/
#ifndef DBUSINTERFACES_H
#define DBUSINTERFACES_H
#include "interfaces/kdeconnectinterfaces_export.h"
#include "interfaces/daemoninterface.h"
#include "interfaces/deviceinterface.h"
#include "interfaces/devicebatteryinterface.h"
#include "interfaces/devicesftpinterface.h"
#include "interfaces/devicefindmyphoneinterface.h"
#include "interfaces/devicenotificationsinterface.h"
#include "interfaces/notificationinterface.h"
#include "interfaces/mprisremoteinterface.h"
#include "interfaces/remotecontrolinterface.h"
#include "interfaces/lockdeviceinterface.h"
#include "interfaces/remotecommandsinterface.h"
#include "interfaces/remotekeyboardinterface.h"
/**
* Using these "proxy" classes just in case we need to rename the
* interface, so we can change the class name in a single place.
*/
class KDECONNECTINTERFACES_EXPORT DaemonDbusInterface
: public OrgKdeKdeconnectDaemonInterface
{
Q_OBJECT
public:
explicit DaemonDbusInterface(QObject* parent = nullptr);
~DaemonDbusInterface() override;
static QString activatedService();
Q_SIGNALS:
void deviceAdded(const QString &id);
};
class KDECONNECTINTERFACES_EXPORT DeviceDbusInterface
: public OrgKdeKdeconnectDeviceInterface
{
Q_OBJECT
// TODO: Workaround because OrgKdeKdeconnectDeviceInterface is not generating
// the signals for the properties
Q_PROPERTY(bool isReachable READ isReachable NOTIFY reachableChangedProxy)
Q_PROPERTY(bool isTrusted READ isTrusted NOTIFY trustedChangedProxy)
Q_PROPERTY(QString name READ name NOTIFY nameChangedProxy)
public:
explicit DeviceDbusInterface(const QString& deviceId, QObject* parent = nullptr);
~DeviceDbusInterface() override;
Q_SCRIPTABLE QString id() const;
Q_SCRIPTABLE void pluginCall(const QString &plugin, const QString &method);
Q_SIGNALS:
void nameChangedProxy(const QString &name);
void trustedChangedProxy(bool paired);
void reachableChangedProxy(bool reachable);
private:
const QString m_id;
};
class KDECONNECTINTERFACES_EXPORT DeviceBatteryDbusInterface
: public OrgKdeKdeconnectDeviceBatteryInterface
{
Q_OBJECT
public:
explicit DeviceBatteryDbusInterface(const QString& deviceId, QObject* parent = nullptr);
~DeviceBatteryDbusInterface() override;
};
class KDECONNECTINTERFACES_EXPORT DeviceNotificationsDbusInterface
: public OrgKdeKdeconnectDeviceNotificationsInterface
{
Q_OBJECT
public:
explicit DeviceNotificationsDbusInterface(const QString& deviceId, QObject* parent = nullptr);
~DeviceNotificationsDbusInterface() override;
};
class KDECONNECTINTERFACES_EXPORT NotificationDbusInterface
: public OrgKdeKdeconnectDeviceNotificationsNotificationInterface
{
Q_OBJECT
public:
NotificationDbusInterface(const QString& deviceId, const QString& notificationId, QObject* parent = nullptr);
~NotificationDbusInterface() override;
QString notificationId() { return id; }
private:
const QString id;
};
class KDECONNECTINTERFACES_EXPORT SftpDbusInterface
: public OrgKdeKdeconnectDeviceSftpInterface
{
Q_OBJECT
public:
explicit SftpDbusInterface(const QString& deviceId, QObject* parent = nullptr);
~SftpDbusInterface() override;
};
class KDECONNECTINTERFACES_EXPORT MprisDbusInterface
: public OrgKdeKdeconnectDeviceMprisremoteInterface
{
Q_OBJECT
// TODO: Workaround because qdbusxml2cpp is not generating
// the signals for the properties
Q_PROPERTY(bool isPlaying READ isPlaying NOTIFY propertiesChangedProxy)
Q_PROPERTY(int length READ length NOTIFY propertiesChangedProxy)
Q_PROPERTY(QString nowPlaying READ nowPlaying NOTIFY propertiesChangedProxy)
Q_PROPERTY(QStringList playerList READ playerList NOTIFY propertiesChangedProxy)
Q_PROPERTY(int volume READ volume WRITE setVolume NOTIFY propertiesChangedProxy)
Q_PROPERTY(int position READ position WRITE setPosition NOTIFY propertiesChangedProxy)
public:
explicit MprisDbusInterface(const QString& deviceId, QObject* parent = nullptr);
~MprisDbusInterface() override;
Q_SIGNALS:
void propertiesChangedProxy();
};
class KDECONNECTINTERFACES_EXPORT RemoteControlDbusInterface
: public OrgKdeKdeconnectDeviceRemotecontrolInterface
{
Q_OBJECT
public:
explicit RemoteControlDbusInterface(const QString& deviceId, QObject* parent = nullptr);
~RemoteControlDbusInterface() override;
};
class KDECONNECTINTERFACES_EXPORT LockDeviceDbusInterface
: public OrgKdeKdeconnectDeviceLockdeviceInterface
{
Q_OBJECT
Q_PROPERTY(bool isLocked READ isLocked WRITE setIsLocked NOTIFY lockedChangedProxy)
public:
explicit LockDeviceDbusInterface(const QString& deviceId, QObject* parent = nullptr);
~LockDeviceDbusInterface() override;
Q_SIGNALS:
void lockedChangedProxy(bool isLocked);
};
class KDECONNECTINTERFACES_EXPORT FindMyPhoneDeviceDbusInterface
: public OrgKdeKdeconnectDeviceFindmyphoneInterface
{
Q_OBJECT
public:
explicit FindMyPhoneDeviceDbusInterface(const QString& deviceId, QObject* parent = nullptr);
~FindMyPhoneDeviceDbusInterface() override;
};
class KDECONNECTINTERFACES_EXPORT RemoteCommandsDbusInterface
: public OrgKdeKdeconnectDeviceRemotecommandsInterface
{
Q_OBJECT
public:
explicit RemoteCommandsDbusInterface(const QString& deviceId, QObject* parent = nullptr);
~RemoteCommandsDbusInterface() override;
};
class KDECONNECTINTERFACES_EXPORT RemoteKeyboardDbusInterface
: public OrgKdeKdeconnectDeviceRemotekeyboardInterface
{
Q_OBJECT
public:
explicit RemoteKeyboardDbusInterface(const QString& deviceId, QObject* parent = nullptr);
~RemoteKeyboardDbusInterface() override;
};
#endif