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
86 lines
2 KiB
C++
86 lines
2 KiB
C++
/********************************************************************
|
|
KWin - the KDE window manager
|
|
This file is part of the KDE project.
|
|
|
|
Copyright (C) 2014 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_DECORATION_RENDERER_H
|
|
#define KWIN_DECORATION_RENDERER_H
|
|
|
|
#include <QObject>
|
|
#include <QRegion>
|
|
|
|
#include <kwin_export.h>
|
|
|
|
namespace KWin
|
|
{
|
|
|
|
class Deleted;
|
|
|
|
namespace Decoration
|
|
{
|
|
|
|
class DecoratedClientImpl;
|
|
|
|
class KWIN_EXPORT Renderer : public QObject
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
~Renderer() override;
|
|
|
|
void schedule(const QRect &rect);
|
|
|
|
/**
|
|
* Reparents this Renderer to the @p deleted.
|
|
* After this call the Renderer is no longer able to render
|
|
* anything, client() returns a nullptr.
|
|
*/
|
|
virtual void reparent(Deleted *deleted);
|
|
|
|
Q_SIGNALS:
|
|
void renderScheduled(const QRect &geo);
|
|
|
|
protected:
|
|
explicit Renderer(DecoratedClientImpl *client);
|
|
/**
|
|
* @returns the scheduled paint region and resets
|
|
*/
|
|
QRegion getScheduled();
|
|
|
|
virtual void render() = 0;
|
|
|
|
DecoratedClientImpl *client() {
|
|
return m_client;
|
|
}
|
|
|
|
bool areImageSizesDirty() const {
|
|
return m_imageSizesDirty;
|
|
}
|
|
void resetImageSizesDirty() {
|
|
m_imageSizesDirty = false;
|
|
}
|
|
QImage renderToImage(const QRect &geo);
|
|
|
|
private:
|
|
DecoratedClientImpl *m_client;
|
|
QRegion m_scheduled;
|
|
bool m_imageSizesDirty;
|
|
};
|
|
|
|
}
|
|
}
|
|
|
|
#endif
|