libs/flake/KoInputDeviceHandler.h

0001 /* This file is part of the KDE project
0002  * Copyright (c) 2008 Jan Hambrecht <jaham@gmx.net>
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Library General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2 of the License, or (at your option) any later version.
0008  *
0009  * This library is distributed in the hope that it will be useful,
0010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012  * Library General Public License for more details.
0013  *
0014  * You should have received a copy of the GNU Library General Public License
0015  * along with this library; see the file COPYING.LIB.  If not, write to
0016  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0017  * Boston, MA 02110-1301, USA.
0018  */
0019
0020 #ifndef KOINPUTDEVICEHANDLER_H
0021 #define KOINPUTDEVICEHANDLER_H
0022
0023 #include "flake_export.h"
0024 #include <QObject>
0025
0026 /**
0027  * Base class for all custom input devices.
0028  */
0029 class FLAKE_EXPORT KoInputDeviceHandler : public QObject
0030 {
0031     Q_OBJECT
0032 public:
0033     KoInputDeviceHandler(QObject *parent, const QString &id);
0034     ~KoInputDeviceHandler() override;
0035
0036     /**
0037      * Return the id for the device.
0038      * @return the id for the device
0039      */
0040     QString id() const;
0041
0042     /**
0043      * Starts the device.
0044      * @return true if the device was started, false otherwise
0045      */
0046     virtual bool start() = 0;
0047
0048     /**
0049      * Stops the device.
0050      * @return true if the device was stopped, false otherwise
0051      */
0052     virtual bool stop() = 0;
0053
0054 private:
0055     class Private;
0056     Private * const d;
0057 };
0058
0059 #endif // KOINPUTDEVICEHANDLER_H