Differential D3040 Diff 11803 util/zoomcontroller.cpp

Changeset View

Standalone View

util/zoomcontroller.cpp

This file was added.

1		/*
2		* Copyright 2016 Igor Kushnir <igorkuo@gmail.com>
3		*
4		* This program is free software; you can redistribute it and/or
5		* modify it under the terms of the GNU General Public License as
6		* published by the Free Software Foundation; either version 2 of
7		* the License or (at your option) version 3 or any later version
8		* accepted by the membership of KDE e.V. (or its successor approved
9		* by the membership of KDE e.V.), which shall act as a proxy
10		* defined in Section 14 of version 3 of the license.
11		*
12		* This program is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		* GNU General Public License for more details.
16		*
17		* You should have received a copy of the GNU General Public License
18		* along with this program. If not, see <http://www.gnu.org/licenses/>.
19		*
20		*/
21
22		#include "zoomcontroller.h"
23
24		#include "debug.h"
	mwolffUnsubmitted Done newline before mwolff: newline before
25
	mwolffUnsubmitted Done newline before mwolff: newline before
26		#include <KConfigGroup>
27
	mwolffUnsubmitted Done newline before mwolff: newline before
28		#include <QPoint>
29		#include <QKeyEvent>
30		#include <QWheelEvent>
	mwolffUnsubmitted Done newline before i.e. we want to group includes #include "file.h" #include "..." #include <K...> #include <K...> #include <Q...> #include <Q...> #include <c...> mwolff: newline before i.e. we want to group includes ``` #include "file.h" #include "..." #include…
31
32		#include <cmath>
33
34
35		namespace {
36
37		constexpr const char* factorConfigEntryKey() { return "Zoom Factor"; }
38
39		constexpr double defaultFactor{1};
40		constexpr double defaultMultiplier{1.1};
41
42		double multiplier(double scale)
43		{
44		// Allow finer-grained control over zoom factor compared to defaultMultiplier
45		constexpr double smallMultiplier{1.05};
46		return std::pow(smallMultiplier, scale);
47		}
48
49		} // namespace
50
51
52		using KDevelop::ZoomControllerPrivate;
53		using KDevelop::ZoomController;
54
55		class KDevelop::ZoomControllerPrivate
56		{
57		public:
58		explicit ZoomControllerPrivate(const KConfigGroup& configGroup);
59		void writeConfig();
60
61		KConfigGroup m_configGroup;
62		double m_factor{defaultFactor};
63		};
64
65		ZoomControllerPrivate::ZoomControllerPrivate(const KConfigGroup& configGroup)
66		: m_configGroup{configGroup}
67		{
68		m_factor = m_configGroup.readEntry(factorConfigEntryKey(), defaultFactor);
69		}
70
71		void ZoomControllerPrivate::writeConfig()
72		{
73		m_configGroup.writeEntry(factorConfigEntryKey(), m_factor);
74		m_configGroup.sync();
75		}
76
77		ZoomController::ZoomController(const KConfigGroup& configGroup, QObject* parent)
	mwolffUnsubmitted Done join next line mwolff: join next line
78		: QObject(parent)
79		, d{new ZoomControllerPrivate(configGroup)}
80		{
81		}
82
83		ZoomController::~ZoomController() = default;
84
85		double ZoomController::factor() const
86		{
87		return d->m_factor;
88		}
89
90		void ZoomController::setFactor(double factor)
91		{
92		factor = qBound(0.1, factor, 10.0);
93		if (d->m_factor == factor) {
94		return;
95		}
96		d->m_factor = factor;
97		d->writeConfig();
98		emit factorChanged(d->m_factor);
99		}
100
101		void ZoomController::zoomBy(double scale)
102		{
103		setFactor(d->m_factor * multiplier(scale));
104		}
105
106		bool ZoomController::handleKeyPressEvent(QKeyEvent* event)
107		{
108		if (Q_UNLIKELY(!event)) {
	mwolffUnsubmitted Done this doesn't actually happen, right? Imo you can simply replace this with a `Q_ASSERT`, or remove it altogether mwolff: this doesn't actually happen, right? Imo you can simply replace this with a `Q_ASSERT`, or…
109		qCWarning(UTIL) << "ZoomController::handleKeyPressEvent: null event.";
110		return false;
111		}
112
113		const auto requiredModifiers = Qt::ControlModifier;
114		if (!(event->modifiers() & requiredModifiers)) {
115		return false;
116		}
117		// Qt::ShiftModifier is required for the 0 key in some keyboard layouts
118		// (such as Programmer Dvorak). Allow Qt::KeypadModifier to support numpad keys.
119		// Don't allow other modifiers, such as Alt and Meta, to minimize shortcut conflicts.
120		const auto allowedModifiers = Qt::ControlModifier \| Qt::ShiftModifier \| Qt::KeypadModifier;
121		if (event->modifiers() & ~allowedModifiers) {
122		return false;
123		}
124
125		if (event->key() == Qt::Key_0) {
126		resetZoom();
127		event->accept();
128		return true;
129		}
130
131		return false;
132		}
133
134		bool ZoomController::handleWheelEvent(QWheelEvent* event)
135		{
136		if (Q_UNLIKELY(!event)) {
	mwolffUnsubmitted Done dito above mwolff: dito above
137		qCWarning(UTIL) << "ZoomController::handleWheelEvent: null event.";
138		return false;
139		}
140		if (!(event->modifiers() & Qt::ControlModifier)) {
141		return false;
142		}
143
144		constexpr double minStandardDelta{120};
145		const QPoint delta = event->angleDelta();
146		const double scale{(delta.x() + delta.y()) / minStandardDelta};
147
148		zoomBy(scale);
149		event->accept();
150		return true;
151		}
152
153		void ZoomController::zoomIn()
154		{
155		setFactor(d->m_factor * defaultMultiplier);
156		}
157
158		void ZoomController::zoomOut()
159		{
160		setFactor(d->m_factor / defaultMultiplier);
161		}
162
	mwolffUnsubmitted Done this shouldn't be required, or is it? mwolff: this shouldn't be required, or is it?
	igorkushnirAuthorUnsubmitted Not Done You are right, including the moc file is not needed. Removed. igorkushnir: You are right, including the moc file is not needed. Removed.
163		void ZoomController::resetZoom()
164		{
165		setFactor(defaultFactor);
166		}
167
168		#include "moc_zoomcontroller.cpp"