kwin/scripting/screenedgeitem.h
Martin Gräßlin 63b1138307 Add support for new touch screen edge actions to declarative KWin scripts
Summary:
This change introduces a new property mode in ScreenEdgeItem to switch
between Pointer and Touch mode. The touch mode interacts with the new
touch screen edge gestures through a QAction.

Test Plan: New test case added

Reviewers: #kwin, #plasma

Subscribers: plasma-devel

Tags: #plasma

Differential Revision: https://phabricator.kde.org/D5272
2017-04-07 16:17:48 +02:00

129 lines
3.2 KiB
C++

/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2013 Martin Gräßlin <mgraesslin@kde.org>
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) any later version.
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 KWIN_SCREENEDGEITEM_H
#define KWIN_SCREENEDGEITEM_H
#include <QObject>
#include <kwinglobals.h>
class QAction;
namespace KWin
{
/**
* @brief Qml export for reserving a Screen Edge.
*
* The edge is controlled by the @c enabled property and the @c edge
* property. If the edge is enabled and gets triggered the @link activated()
* signal gets emitted.
*
* Example usage:
* @code
* ScreenEdgeItem {
* edge: ScreenEdgeItem.LeftEdge
* onActivated: doSomething()
* }
* @endcode
*
*/
class ScreenEdgeItem : public QObject
{
Q_OBJECT
Q_ENUMS(Edge)
Q_ENUMS(Mode)
/**
* @brief Whether the edge is currently enabled, that is reserved. Default value is @c true.
*
*/
Q_PROPERTY(bool enabled READ isEnabled WRITE setEnabled NOTIFY enabledChanged)
/**
* @brief Which of the screen edges is to be reserved. Default value is @c NoEdge.
*
*/
Q_PROPERTY(Edge edge READ edge WRITE setEdge NOTIFY edgeChanged)
/**
* @brief The operation mode for this edge. Default value is @c Mode::Pointer
**/
Q_PROPERTY(Mode mode READ mode WRITE setMode NOTIFY modeChanged)
public:
enum Edge {
TopEdge,
TopRightEdge,
RightEdge,
BottomRightEdge,
BottomEdge,
BottomLeftEdge,
LeftEdge,
TopLeftEdge,
EDGE_COUNT,
NoEdge
};
/**
* Enum describing the operation modes of the edge.
**/
enum class Mode {
Pointer,
Touch
};
explicit ScreenEdgeItem(QObject *parent = 0);
virtual ~ScreenEdgeItem();
bool isEnabled() const;
Edge edge() const;
Mode mode() const {
return m_mode;
}
public Q_SLOTS:
void setEnabled(bool enabled);
void setEdge(Edge edge);
void setMode(Mode mode);
Q_SIGNALS:
void enabledChanged();
void edgeChanged();
void modeChanged();
void activated();
private Q_SLOTS:
bool borderActivated(ElectricBorder edge);
private:
void enableEdge();
void disableEdge();
bool m_enabled;
Edge m_edge;
Mode m_mode = Mode::Pointer;
QAction *m_action;
};
inline bool ScreenEdgeItem::isEnabled() const
{
return m_enabled;
}
inline ScreenEdgeItem::Edge ScreenEdgeItem::edge() const
{
return m_edge;
}
} // namespace KWin
#endif // KWIN_SCREENEDGEITEM_H