[effects/showpaint] Use a shortcut to toggle the effect
Summary:
The Show Paint effect is useful when debugging repaint regions issued by
effects. The only headache with it is necessity to enable/disable it.
Consider the following workflow:
* Do some change to an effect;
* Compile KWin (or the effect);
* Go to System Settings and enable the Show Paint effect;
* Test effect, check repaint regions, etc;
* Disable the Show Paint effect;
* Go to the step 1.
This workflow is really exhausting. Also, when testing repaints in a
nested compositor, things become quite messy.
Because purpose of this effect is to debug repaints (and because this
effect is not meant for daily usage), I think that's fine to change
how it's activated.
This patch improves the workflow by changing the way how this effect
gets activated. Instead of enabling/disabling it, one can just use a shortcut
to activate or deactivate the effect.
Reviewers: #kwin, davidedmundson
Reviewed By: #kwin, davidedmundson
Subscribers: broulik, davidedmundson, kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D15703
2018-09-23 07:49:17 +00:00
|
|
|
/********************************************************************
|
|
|
|
KWin - the KDE window manager
|
|
|
|
This file is part of the KDE project.
|
|
|
|
|
2020-01-14 16:17:18 +00:00
|
|
|
Copyright (C) 2018 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
|
[effects/showpaint] Use a shortcut to toggle the effect
Summary:
The Show Paint effect is useful when debugging repaint regions issued by
effects. The only headache with it is necessity to enable/disable it.
Consider the following workflow:
* Do some change to an effect;
* Compile KWin (or the effect);
* Go to System Settings and enable the Show Paint effect;
* Test effect, check repaint regions, etc;
* Disable the Show Paint effect;
* Go to the step 1.
This workflow is really exhausting. Also, when testing repaints in a
nested compositor, things become quite messy.
Because purpose of this effect is to debug repaints (and because this
effect is not meant for daily usage), I think that's fine to change
how it's activated.
This patch improves the workflow by changing the way how this effect
gets activated. Instead of enabling/disabling it, one can just use a shortcut
to activate or deactivate the effect.
Reviewers: #kwin, davidedmundson
Reviewed By: #kwin, davidedmundson
Subscribers: broulik, davidedmundson, kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D15703
2018-09-23 07:49:17 +00:00
|
|
|
|
|
|
|
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/>.
|
|
|
|
*********************************************************************/
|
|
|
|
|
|
|
|
#include "showpaint_config.h"
|
|
|
|
|
|
|
|
#include <KAboutData>
|
|
|
|
#include <KActionCollection>
|
|
|
|
#include <KGlobalAccel>
|
|
|
|
#include <KLocalizedString>
|
|
|
|
#include <KPluginFactory>
|
|
|
|
#include <KShortcutsEditor>
|
|
|
|
|
|
|
|
#include <QAction>
|
|
|
|
|
|
|
|
K_PLUGIN_FACTORY_WITH_JSON(ShowPaintEffectConfigFactory,
|
|
|
|
"showpaint_config.json",
|
|
|
|
registerPlugin<KWin::ShowPaintEffectConfig>();)
|
|
|
|
|
|
|
|
namespace KWin
|
|
|
|
{
|
|
|
|
|
|
|
|
ShowPaintEffectConfig::ShowPaintEffectConfig(QWidget *parent, const QVariantList &args)
|
|
|
|
: KCModule(KAboutData::pluginData(QStringLiteral("showpaint")), parent, args)
|
|
|
|
, m_ui(new Ui::ShowPaintEffectConfig)
|
|
|
|
{
|
|
|
|
m_ui->setupUi(this);
|
|
|
|
|
|
|
|
auto *actionCollection = new KActionCollection(this, QStringLiteral("kwin"));
|
|
|
|
|
|
|
|
actionCollection->setComponentDisplayName(i18n("KWin"));
|
|
|
|
actionCollection->setConfigGroup(QStringLiteral("ShowPaint"));
|
|
|
|
actionCollection->setConfigGlobal(true);
|
|
|
|
|
|
|
|
QAction *toggleAction = actionCollection->addAction(QStringLiteral("Toggle"));
|
|
|
|
toggleAction->setText(i18n("Toggle Show Paint"));
|
|
|
|
toggleAction->setProperty("isConfigurationAction", true);
|
|
|
|
KGlobalAccel::self()->setDefaultShortcut(toggleAction, {});
|
|
|
|
KGlobalAccel::self()->setShortcut(toggleAction, {});
|
|
|
|
|
|
|
|
m_ui->shortcutsEditor->addCollection(actionCollection);
|
|
|
|
|
|
|
|
connect(m_ui->shortcutsEditor, &KShortcutsEditor::keyChange,
|
|
|
|
this, qOverload<>(&ShowPaintEffectConfig::changed));
|
|
|
|
|
|
|
|
load();
|
|
|
|
}
|
|
|
|
|
|
|
|
ShowPaintEffectConfig::~ShowPaintEffectConfig()
|
|
|
|
{
|
|
|
|
// If save() is called, undoChanges() has no effect.
|
|
|
|
m_ui->shortcutsEditor->undoChanges();
|
|
|
|
|
|
|
|
delete m_ui;
|
|
|
|
}
|
|
|
|
|
|
|
|
void ShowPaintEffectConfig::save()
|
|
|
|
{
|
|
|
|
KCModule::save();
|
|
|
|
m_ui->shortcutsEditor->save();
|
|
|
|
}
|
|
|
|
|
|
|
|
void ShowPaintEffectConfig::defaults()
|
|
|
|
{
|
|
|
|
m_ui->shortcutsEditor->allDefault();
|
|
|
|
KCModule::defaults();
|
|
|
|
}
|
|
|
|
|
|
|
|
} // namespace KWin
|
|
|
|
|
|
|
|
#include "showpaint_config.moc"
|