684b4b635e
Summary:
So far we were following a bit unique and rare doxygen comment style:
/**
* Contents of the comment.
**/
Doxygen comments with this style look balanced and neat, but many people
that contribute to KWin don't follow this style. Instead, they prefer
more traditional doxygen comment style, i.e.
/**
* Contents of the comment.
*/
Reviewing such changes has been a bit frustrating for me (so selfish!)
and for other contributors.
This change switches doxygen comment style in KWin to a more traditional
style. The main reason for doing this is to make code review process easier
for new contributors as well us.
Reviewers: #kwin, davidedmundson
Reviewed By: #kwin, davidedmundson
Subscribers: kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D22812
95 lines
2.4 KiB
C++
95 lines
2.4 KiB
C++
/********************************************************************
|
|
KWin - the KDE window manager
|
|
This file is part of the KDE project.
|
|
|
|
Copyright (C) 2017 Martin Flöser <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/>.
|
|
*********************************************************************/
|
|
#pragma once
|
|
|
|
#include <QObject>
|
|
|
|
#include <KSharedConfig>
|
|
|
|
#include <kwin_export.h>
|
|
|
|
class QOrientationSensor;
|
|
class OrientationSensorAdaptor;
|
|
class KStatusNotifierItem;
|
|
|
|
namespace KWin
|
|
{
|
|
|
|
class KWIN_EXPORT OrientationSensor : public QObject
|
|
{
|
|
Q_OBJECT
|
|
Q_CLASSINFO("D-Bus Interface", "org.kde.kwin.OrientationSensor")
|
|
Q_PROPERTY(bool userEnabled READ isUserEnabled WRITE setUserEnabled NOTIFY userEnabledChanged)
|
|
public:
|
|
explicit OrientationSensor(QObject *parent = nullptr);
|
|
~OrientationSensor() override;
|
|
|
|
void setEnabled(bool enabled);
|
|
|
|
/**
|
|
* Just like QOrientationReading::Orientation,
|
|
* copied to not leak the QSensors API into internal API.
|
|
*/
|
|
enum class Orientation {
|
|
Undefined,
|
|
TopUp,
|
|
TopDown,
|
|
LeftUp,
|
|
RightUp,
|
|
FaceUp,
|
|
FaceDown
|
|
};
|
|
Q_ENUM(Orientation)
|
|
|
|
Orientation orientation() const {
|
|
return m_orientation;
|
|
}
|
|
|
|
void setConfig(KSharedConfig::Ptr config) {
|
|
m_config = config;
|
|
}
|
|
|
|
bool isUserEnabled() const {
|
|
return m_userEnabled;
|
|
}
|
|
void setUserEnabled(bool enabled);
|
|
|
|
Q_SIGNALS:
|
|
void orientationChanged();
|
|
void userEnabledChanged(bool);
|
|
|
|
private:
|
|
void startStopSensor();
|
|
void loadConfig();
|
|
void refresh();
|
|
void activate();
|
|
void updateState();
|
|
|
|
QOrientationSensor *m_sensor;
|
|
bool m_enabled = false;
|
|
bool m_userEnabled = true;
|
|
Orientation m_orientation = Orientation::Undefined;
|
|
KStatusNotifierItem *m_sni = nullptr;
|
|
KSharedConfig::Ptr m_config;
|
|
OrientationSensorAdaptor *m_adaptor = nullptr;
|
|
|
|
};
|
|
|
|
}
|