1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/* This file is part of the KDE libraries
Copyright (C) 2004 Ariya Hidayat <ariya@kde.org>
Copyright (C) 2006 Peter Simonsson <peter.simonsson@gmail.com>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KOZOOMACTION_H
#define KOZOOMACTION_H
#include <kselectaction.h>
#include <KoZoomMode.h>
#include "kowidgets_export.h"
/**
* Class KoZoomAction implements an action to provide zoom values.
* In a toolbar, KoZoomAction will show a dropdown list (combobox), also with
* the possibility for the user to enter arbritrary zoom value
* (must be an integer). The values shown on the list are always
* sorted.
* In a statusbar it provides a scale (slider) plus an editable value plus
* some buttons for special zoommodes
*/
class KOWIDGETS_EXPORT KoZoomAction : public KSelectAction
{
Q_OBJECT
Q_PROPERTY(qreal effectiveZoom READ effectiveZoom NOTIFY zoomChanged)
public:
/**
* Creates a new zoom action.
* @param zoomModes which zoom modes that should be shown
* @param text The text that will be displayed.
* @param parent The action's parent object.
*/
KoZoomAction( KoZoomMode::Modes zoomModes, const QString& text, QObject *parent);
~KoZoomAction() override;
/**
* Reimplemented from QWidgetAction.
*/
QWidget* createWidget(QWidget* parent) override;
enum SpecialButton {
AspectMode = 1, ///< changing aspect mode
ZoomToSelection = 2, ///< zooms to current selection
ZoomToAll = 4 ///< zooms to the whole content of the document
};
Q_DECLARE_FLAGS(SpecialButtons, SpecialButton)
/**
* Enables specified special buttons.
* This should be called immediately after calling the constructor.
* @param buttons mask of the special button flags to enable
*/
void setSpecialButtons( SpecialButtons buttons );
qreal effectiveZoom() const;
public Q_SLOTS:
/**
* Sets the zoom. If zoom not yet on the list of zoom values, it will be inserted
* into the list at proper place so that the values remain sorted.
* emits zoomChanged
*/
void setZoom( qreal zoom );
/**
* Change the zoom modes that should be shown
*/
void setZoomModes( KoZoomMode::Modes zoomModes );
/**
* Change the zoom to a closer look than current
* Zoom mode will be CONSTANT afterwards
* emits zoomChanged
*/
void zoomIn( );
/**
* Change the zoom to a wider look than current
* Zoom mode will be CONSTANT afterwards
* emits zoomChanged
*/
void zoomOut( );
/**
* Set the actual zoom value used in the app. This is needed when using @ref zoomIn() , @ref zoomOut() and/or when
* plugged into the viewbar.
*/
void setEffectiveZoom(qreal zoom);
/**
* Change the selected zoom mode.
*/
void setSelectedZoomMode( KoZoomMode::Mode mode );
/**
* Change status of "Use same aspect as pixels" button
* (emits aspectModeChanged(bool) after the change, ALWAYS)
*/
void setAspectMode(bool status);
/**
* Returns next preferred zoom level that should be used for
* zoom in operations.
*
* This can be used by the caller, when it needs some special
* mode of zooming (e.g. relative to point) and needs
* KoCanvasControllerWidget to accomplish this.
*/
qreal nextZoomLevel() const;
/**
* Returns previous preferred zoom level that should be used for
* zoom out operations.
*
* This can be used by the caller, when it needs some special
* mode of zooming (e.g. relative to point) and needs
* KoCanvasControllerWidget to accomplish this.
*/
qreal prevZoomLevel() const;
protected Q_SLOTS:
void triggered( const QString& text );
void sliderValueChanged(int value);
Q_SIGNALS:
/**
* Signal zoomChanged is triggered when user changes the zoom value, either by
* choosing it from the list or by entering new value.
* @param mode The selected zoom mode
* @param zoom the zoom, only defined if @p mode is KoZoomMode::ZOOM_CONSTANT
*/
void zoomChanged( KoZoomMode::Mode mode, qreal zoom );
/**
* Signal aspectModeChanged is triggered when the user toggles the widget.
* Nothing else happens except that this signal is emitted.
* @param status Whether the special aspect mode is on
*/
void aspectModeChanged( bool status );
/**
* Signal is triggered when the user clicks the zoom to selection button.
* Nothing else happens except that this signal is emitted.
*/
void zoomedToSelection();
/**
* Signal is triggered when the user clicks the zoom to all button.
* Nothing else happens except that this signal is emitted.
*/
void zoomedToAll();
void zoomLevelsChanged(const QStringList &values);
void currentZoomLevelChanged(const QString &valueString);
void sliderChanged(int value);
public:
/**
* Return the minimum zoom possible for documents.
*
* \return The minimum zoom possible.
*/
qreal minimumZoom();
/**
* Return the maximum zoom possible for documents.
*
* \return The maximum zoom possible.
*/
qreal maximumZoom();
/**
* Clamp the zoom value so that mimimumZoom <= zoom <= maximumZoom.
*
* \param zoom The value to clamp.
*
* \return minimumZoom if zoom < minimumZoom, maximumZoom if zoom >
* maximumZoom, zoom if otherwise.
*/
qreal clampZoom(qreal zoom);
/**
* Set the minimum zoom possible for documents.
*
* Note that after calling this, any existing KoZoomAction instances
* should be recreated.
*
* \param zoom The minimum zoom to use.
*/
void setMinimumZoom(qreal zoom);
/**
* Set the maximum zoom possible for documents.
*
* Note that after calling this, any existing KoZoomAction instances
* should be recreated.
*
* \param zoom The maximum zoom to use.
*/
void setMaximumZoom(qreal zoom);
protected:
/// Regenerates the action's items
void regenerateItems( const qreal zoom, bool asCurrent = false );
private:
void syncSliderWithZoom();
Q_DISABLE_COPY( KoZoomAction )
class Private;
Private * const d;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(KoZoomAction::SpecialButtons)
#endif
|
