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
118 lines
3.2 KiB
C++
118 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_TABBOX_SWITCHERITEM_H
|
|
#define KWIN_TABBOX_SWITCHERITEM_H
|
|
|
|
#include <QObject>
|
|
#include <QRect>
|
|
|
|
class QAbstractItemModel;
|
|
|
|
namespace KWin
|
|
{
|
|
namespace TabBox
|
|
{
|
|
|
|
class SwitcherItem : public QObject
|
|
{
|
|
Q_OBJECT
|
|
Q_PROPERTY(QAbstractItemModel *model READ model NOTIFY modelChanged)
|
|
Q_PROPERTY(QRect screenGeometry READ screenGeometry NOTIFY screenGeometryChanged)
|
|
Q_PROPERTY(bool visible READ isVisible NOTIFY visibleChanged)
|
|
Q_PROPERTY(bool allDesktops READ isAllDesktops NOTIFY allDesktopsChanged)
|
|
Q_PROPERTY(int currentIndex READ currentIndex WRITE setCurrentIndex NOTIFY currentIndexChanged)
|
|
Q_PROPERTY(bool noModifierGrab READ noModifierGrab NOTIFY noModifierGrabChanged)
|
|
|
|
/**
|
|
* The main QML item that will be displayed in the Dialog
|
|
*/
|
|
Q_PROPERTY(QObject *item READ item WRITE setItem NOTIFY itemChanged)
|
|
|
|
Q_CLASSINFO("DefaultProperty", "item")
|
|
public:
|
|
SwitcherItem(QObject *parent = nullptr);
|
|
~SwitcherItem() override;
|
|
|
|
QAbstractItemModel *model() const;
|
|
QRect screenGeometry() const;
|
|
bool isVisible() const;
|
|
bool isAllDesktops() const;
|
|
int currentIndex() const;
|
|
void setCurrentIndex(int index);
|
|
QObject *item() const;
|
|
void setItem(QObject *item);
|
|
bool noModifierGrab() const {
|
|
return m_noModifierGrab;
|
|
}
|
|
|
|
// for usage from outside
|
|
void setModel(QAbstractItemModel *model);
|
|
void setAllDesktops(bool all);
|
|
void setVisible(bool visible);
|
|
void setNoModifierGrab(bool set);
|
|
|
|
Q_SIGNALS:
|
|
void visibleChanged();
|
|
void currentIndexChanged(int index);
|
|
void modelChanged();
|
|
void allDesktopsChanged();
|
|
void screenGeometryChanged();
|
|
void itemChanged();
|
|
void noModifierGrabChanged();
|
|
|
|
private:
|
|
QAbstractItemModel *m_model;
|
|
QObject *m_item;
|
|
bool m_visible;
|
|
bool m_allDesktops;
|
|
int m_currentIndex;
|
|
QMetaObject::Connection m_selectedIndexConnection;
|
|
bool m_noModifierGrab = false;
|
|
};
|
|
|
|
inline QAbstractItemModel *SwitcherItem::model() const
|
|
{
|
|
return m_model;
|
|
}
|
|
|
|
inline bool SwitcherItem::isVisible() const
|
|
{
|
|
return m_visible;
|
|
}
|
|
|
|
inline bool SwitcherItem::isAllDesktops() const
|
|
{
|
|
return m_allDesktops;
|
|
}
|
|
|
|
inline int SwitcherItem::currentIndex() const
|
|
{
|
|
return m_currentIndex;
|
|
}
|
|
|
|
inline QObject *SwitcherItem::item() const
|
|
{
|
|
return m_item;
|
|
}
|
|
|
|
} // TabBox
|
|
} // KWin
|
|
|
|
#endif // KWIN_TABBOX_SWITCHERITEM_H
|