kwin/scripting/screenedgeitem.h
Vlad Zahorodnii 62a7db7028 Use nullptr everywhere
Summary:
Because KWin is a very old project, we use three kinds of null pointer
literals: 0, NULL, and nullptr. Since C++11, it's recommended to use
nullptr keyword.

This change converts all usages of 0 and NULL literal to nullptr. Even
though it breaks git history, we need to do it in order to have consistent
code as well to ease code reviews (it's very tempting for some people to
add unrelated changes to their patches, e.g. converting NULL to nullptr).

Test Plan: Compiles.

Reviewers: #kwin, davidedmundson, romangg

Reviewed By: #kwin, davidedmundson, romangg

Subscribers: romangg, kwin

Tags: #kwin

Differential Revision: https://phabricator.kde.org/D23618
2019-09-19 17:48:21 +03:00

126 lines
3.1 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 @ref 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 = nullptr);
~ScreenEdgeItem() override;
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