← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/qwt/oneiric-proposed

« back to all changes in this revision

Viewing changes to doc/man/man3/QwtMagnifier.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2011-06-10 11:22:47 UTC
  • mfrom: (1.1.6 upstream) (2.1.4 sid)
  • Revision ID: james.westby@ubuntu.com-20110610112247-0i1019vvmzaq6p86
Tags: 6.0.0-1
http://bugs.debian.org/624107
http://bugs.debian.org/604379
http://bugs.debian.org/626868
http://bugs.debian.org/626567
* New upstream release (Closes: #624107):
  - drop Qt3 support. (Closes: #604379, #626868)
* Register documentation with doc-base. (Closes: #626567)
* Drop patches:
  - 01_makefiles.diff
  - 02_add_missing_warnings.diff
  - 03_qwt_branch_pull_r544.diff
* Add qwt_install_paths.patch to fix the hardcoded installation paths.
* Update debian/control:
  - drop libqt3-mt-dev build dependency.
  - bump Standards-Version to 3.9.2 (no changes).
  - drop Qt3 related packages.
  - due to bump soname (and as we dropper Qt3 support):
    - libqwt5-qt4-dev -> libqwt-dev
    - libqwt5-qt4 -> libqwt6
    - libqwt5-doc -> libqwt-doc
* Update debian/copyright file.
* Update debian/rules: drop Qt3 packages support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/man3/QwtMagnifier.3
 
1
.TH "QwtMagnifier" 3 "Fri Apr 15 2011" "Version 6.0.0" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtMagnifier \- 
 
6
.PP
 
7
\fBQwtMagnifier\fP provides zooming, by magnifying in steps.  
 
8
 
 
9
.SH SYNOPSIS
 
10
.br
 
11
.PP
 
12
.PP
 
13
\fC#include <qwt_magnifier.h>\fP
 
14
.PP
 
15
Inherited by \fBQwtPlotMagnifier\fP.
 
16
.SS "Public Member Functions"
 
17
 
 
18
.in +1c
 
19
.ti -1c
 
20
.RI "\fBQwtMagnifier\fP (QWidget *)"
 
21
.br
 
22
.ti -1c
 
23
.RI "virtual \fB~QwtMagnifier\fP ()"
 
24
.br
 
25
.ti -1c
 
26
.RI "QWidget * \fBparentWidget\fP ()"
 
27
.br
 
28
.ti -1c
 
29
.RI "const QWidget * \fBparentWidget\fP () const "
 
30
.br
 
31
.ti -1c
 
32
.RI "void \fBsetEnabled\fP (bool)"
 
33
.br
 
34
.ti -1c
 
35
.RI "bool \fBisEnabled\fP () const "
 
36
.br
 
37
.ti -1c
 
38
.RI "void \fBsetMouseFactor\fP (double)"
 
39
.br
 
40
.ti -1c
 
41
.RI "double \fBmouseFactor\fP () const "
 
42
.br
 
43
.ti -1c
 
44
.RI "void \fBsetMouseButton\fP (int button, int buttonState=Qt::NoButton)"
 
45
.br
 
46
.ti -1c
 
47
.RI "void \fBgetMouseButton\fP (int &button, int &buttonState) const "
 
48
.br
 
49
.ti -1c
 
50
.RI "void \fBsetWheelFactor\fP (double)"
 
51
.br
 
52
.ti -1c
 
53
.RI "double \fBwheelFactor\fP () const "
 
54
.br
 
55
.ti -1c
 
56
.RI "void \fBsetWheelButtonState\fP (int buttonState)"
 
57
.br
 
58
.ti -1c
 
59
.RI "int \fBwheelButtonState\fP () const "
 
60
.br
 
61
.ti -1c
 
62
.RI "void \fBsetKeyFactor\fP (double)"
 
63
.br
 
64
.ti -1c
 
65
.RI "double \fBkeyFactor\fP () const "
 
66
.br
 
67
.ti -1c
 
68
.RI "void \fBsetZoomInKey\fP (int key, int modifiers)"
 
69
.br
 
70
.ti -1c
 
71
.RI "void \fBgetZoomInKey\fP (int &key, int &modifiers) const "
 
72
.br
 
73
.ti -1c
 
74
.RI "void \fBsetZoomOutKey\fP (int key, int modifiers)"
 
75
.br
 
76
.ti -1c
 
77
.RI "void \fBgetZoomOutKey\fP (int &key, int &modifiers) const "
 
78
.br
 
79
.ti -1c
 
80
.RI "virtual bool \fBeventFilter\fP (QObject *, QEvent *)"
 
81
.br
 
82
.in -1c
 
83
.SS "Protected Member Functions"
 
84
 
 
85
.in +1c
 
86
.ti -1c
 
87
.RI "virtual void \fBrescale\fP (double factor)=0"
 
88
.br
 
89
.ti -1c
 
90
.RI "virtual void \fBwidgetMousePressEvent\fP (QMouseEvent *)"
 
91
.br
 
92
.ti -1c
 
93
.RI "virtual void \fBwidgetMouseReleaseEvent\fP (QMouseEvent *)"
 
94
.br
 
95
.ti -1c
 
96
.RI "virtual void \fBwidgetMouseMoveEvent\fP (QMouseEvent *)"
 
97
.br
 
98
.ti -1c
 
99
.RI "virtual void \fBwidgetWheelEvent\fP (QWheelEvent *)"
 
100
.br
 
101
.ti -1c
 
102
.RI "virtual void \fBwidgetKeyPressEvent\fP (QKeyEvent *)"
 
103
.br
 
104
.ti -1c
 
105
.RI "virtual void \fBwidgetKeyReleaseEvent\fP (QKeyEvent *)"
 
106
.br
 
107
.in -1c
 
108
.SH "Detailed Description"
 
109
.PP 
 
110
\fBQwtMagnifier\fP provides zooming, by magnifying in steps. 
 
111
 
 
112
Using \fBQwtMagnifier\fP a plot can be zoomed in/out in steps using keys, the mouse wheel or moving a mouse button in vertical direction. 
 
113
.SH "Constructor & Destructor Documentation"
 
114
.PP 
 
115
.SS "QwtMagnifier::QwtMagnifier (QWidget *parent)\fC [explicit]\fP"Constructor 
 
116
.PP
 
117
\fBParameters:\fP
 
118
.RS 4
 
119
\fIparent\fP Widget to be magnified 
 
120
.RE
 
121
.PP
 
122
 
 
123
.SS "QwtMagnifier::~QwtMagnifier ()\fC [virtual]\fP"
 
124
.PP
 
125
Destructor. 
 
126
.SH "Member Function Documentation"
 
127
.PP 
 
128
.SS "bool QwtMagnifier::eventFilter (QObject *o, QEvent *e)\fC [virtual]\fP"
 
129
.PP
 
130
Event filter. When \fBisEnabled()\fP the mouse events of the observed widget are filtered.
 
131
.PP
 
132
\fBSee also:\fP
 
133
.RS 4
 
134
\fBwidgetMousePressEvent()\fP, \fBwidgetMouseReleaseEvent()\fP, \fBwidgetMouseMoveEvent()\fP, \fBwidgetWheelEvent()\fP, \fBwidgetKeyPressEvent()\fP \fBwidgetKeyReleaseEvent()\fP 
 
135
.RE
 
136
.PP
 
137
 
 
138
.SS "void QwtMagnifier::getMouseButton (int &button, int &buttonState) const"\fBSee also:\fP
 
139
.RS 4
 
140
\fBsetMouseButton()\fP 
 
141
.RE
 
142
.PP
 
143
 
 
144
.SS "void QwtMagnifier::getZoomInKey (int &key, int &modifiers) const"\fBSee also:\fP
 
145
.RS 4
 
146
\fBsetZoomInKey()\fP 
 
147
.RE
 
148
.PP
 
149
 
 
150
.SS "void QwtMagnifier::getZoomOutKey (int &key, int &modifiers) const"\fBSee also:\fP
 
151
.RS 4
 
152
\fBsetZoomOutKey()\fP 
 
153
.RE
 
154
.PP
 
155
 
 
156
.SS "bool QwtMagnifier::isEnabled () const"\fBReturns:\fP
 
157
.RS 4
 
158
true when enabled, false otherwise 
 
159
.RE
 
160
.PP
 
161
\fBSee also:\fP
 
162
.RS 4
 
163
\fBsetEnabled()\fP, \fBeventFilter()\fP 
 
164
.RE
 
165
.PP
 
166
 
 
167
.SS "double QwtMagnifier::keyFactor () const"\fBReturns:\fP
 
168
.RS 4
 
169
Key factor 
 
170
.RE
 
171
.PP
 
172
\fBSee also:\fP
 
173
.RS 4
 
174
\fBsetKeyFactor()\fP 
 
175
.RE
 
176
.PP
 
177
 
 
178
.SS "double QwtMagnifier::mouseFactor () const"\fBReturns:\fP
 
179
.RS 4
 
180
Mouse factor 
 
181
.RE
 
182
.PP
 
183
\fBSee also:\fP
 
184
.RS 4
 
185
\fBsetMouseFactor()\fP 
 
186
.RE
 
187
.PP
 
188
 
 
189
.SS "QWidget * QwtMagnifier::parentWidget ()"\fBReturns:\fP
 
190
.RS 4
 
191
Parent widget, where the rescaling happens 
 
192
.RE
 
193
.PP
 
194
 
 
195
.SS "const QWidget * QwtMagnifier::parentWidget () const"\fBReturns:\fP
 
196
.RS 4
 
197
Parent widget, where the rescaling happens 
 
198
.RE
 
199
.PP
 
200
 
 
201
.SS "virtual void QwtMagnifier::rescale (doublefactor)\fC [protected, pure virtual]\fP"Rescale the parent widget 
 
202
.PP
 
203
\fBParameters:\fP
 
204
.RS 4
 
205
\fIfactor\fP Scale factor 
 
206
.RE
 
207
.PP
 
208
 
 
209
.PP
 
210
Implemented in \fBQwtPlotMagnifier\fP.
 
211
.SS "void QwtMagnifier::setEnabled (boolon)"
 
212
.PP
 
213
En/disable the magnifier. When enabled is true an event filter is installed for the observed widget, otherwise the event filter is removed.
 
214
.PP
 
215
\fBParameters:\fP
 
216
.RS 4
 
217
\fIon\fP true or false 
 
218
.RE
 
219
.PP
 
220
\fBSee also:\fP
 
221
.RS 4
 
222
\fBisEnabled()\fP, \fBeventFilter()\fP 
 
223
.RE
 
224
.PP
 
225
 
 
226
.SS "void QwtMagnifier::setKeyFactor (doublefactor)"
 
227
.PP
 
228
Change the key factor. The key factor defines the ratio between the current range on the parent widget and the zoomed range for each key press of the zoom in/out keys. The default value is 0.9.
 
229
.PP
 
230
\fBParameters:\fP
 
231
.RS 4
 
232
\fIfactor\fP Key factor 
 
233
.RE
 
234
.PP
 
235
\fBSee also:\fP
 
236
.RS 4
 
237
\fBkeyFactor()\fP, \fBsetZoomInKey()\fP, \fBsetZoomOutKey()\fP, \fBsetWheelFactor\fP, \fBsetMouseFactor()\fP 
 
238
.RE
 
239
.PP
 
240
 
 
241
.SS "void QwtMagnifier::setMouseButton (intbutton, intbuttonState = \fCQt::NoButton\fP)"Assign the mouse button, that is used for zooming in/out. The default value is Qt::RightButton.
 
242
.PP
 
243
\fBParameters:\fP
 
244
.RS 4
 
245
\fIbutton\fP Button 
 
246
.br
 
247
\fIbuttonState\fP Button state 
 
248
.RE
 
249
.PP
 
250
\fBSee also:\fP
 
251
.RS 4
 
252
\fBgetMouseButton()\fP 
 
253
.RE
 
254
.PP
 
255
 
 
256
.SS "void QwtMagnifier::setMouseFactor (doublefactor)"
 
257
.PP
 
258
Change the mouse factor. The mouse factor defines the ratio between the current range on the parent widget and the zoomed range for each vertical mouse movement. The default value is 0.95.
 
259
.PP
 
260
\fBParameters:\fP
 
261
.RS 4
 
262
\fIfactor\fP Wheel factor 
 
263
.RE
 
264
.PP
 
265
\fBSee also:\fP
 
266
.RS 4
 
267
\fBmouseFactor()\fP, \fBsetMouseButton()\fP, \fBsetWheelFactor()\fP, \fBsetKeyFactor()\fP 
 
268
.RE
 
269
.PP
 
270
 
 
271
.SS "void QwtMagnifier::setWheelButtonState (intbuttonState)"Assign a mandatory button state for zooming in/out using the wheel. The default button state is Qt::NoButton.
 
272
.PP
 
273
\fBParameters:\fP
 
274
.RS 4
 
275
\fIbuttonState\fP Button state 
 
276
.RE
 
277
.PP
 
278
\fBSee also:\fP
 
279
.RS 4
 
280
\fBwheelButtonState()\fP 
 
281
.RE
 
282
.PP
 
283
 
 
284
.SS "void QwtMagnifier::setWheelFactor (doublefactor)"
 
285
.PP
 
286
Change the wheel factor. The wheel factor defines the ratio between the current range on the parent widget and the zoomed range for each step of the wheel. The default value is 0.9.
 
287
.PP
 
288
\fBParameters:\fP
 
289
.RS 4
 
290
\fIfactor\fP Wheel factor 
 
291
.RE
 
292
.PP
 
293
\fBSee also:\fP
 
294
.RS 4
 
295
\fBwheelFactor()\fP, \fBsetWheelButtonState()\fP, \fBsetMouseFactor()\fP, \fBsetKeyFactor()\fP 
 
296
.RE
 
297
.PP
 
298
 
 
299
.SS "void QwtMagnifier::setZoomInKey (intkey, intmodifiers)"Assign the key, that is used for zooming in. The default combination is Qt::Key_Plus + Qt::NoModifier.
 
300
.PP
 
301
\fBParameters:\fP
 
302
.RS 4
 
303
\fIkey\fP 
 
304
.br
 
305
\fImodifiers\fP 
 
306
.RE
 
307
.PP
 
308
\fBSee also:\fP
 
309
.RS 4
 
310
\fBgetZoomInKey()\fP, \fBsetZoomOutKey()\fP 
 
311
.RE
 
312
.PP
 
313
 
 
314
.SS "void QwtMagnifier::setZoomOutKey (intkey, intmodifiers)"Assign the key, that is used for zooming out. The default combination is Qt::Key_Minus + Qt::NoModifier.
 
315
.PP
 
316
\fBParameters:\fP
 
317
.RS 4
 
318
\fIkey\fP 
 
319
.br
 
320
\fImodifiers\fP 
 
321
.RE
 
322
.PP
 
323
\fBSee also:\fP
 
324
.RS 4
 
325
\fBgetZoomOutKey()\fP, \fBsetZoomOutKey()\fP 
 
326
.RE
 
327
.PP
 
328
 
 
329
.SS "int QwtMagnifier::wheelButtonState () const"\fBReturns:\fP
 
330
.RS 4
 
331
Wheel button state 
 
332
.RE
 
333
.PP
 
334
\fBSee also:\fP
 
335
.RS 4
 
336
\fBsetWheelButtonState()\fP 
 
337
.RE
 
338
.PP
 
339
 
 
340
.SS "double QwtMagnifier::wheelFactor () const"\fBReturns:\fP
 
341
.RS 4
 
342
Wheel factor 
 
343
.RE
 
344
.PP
 
345
\fBSee also:\fP
 
346
.RS 4
 
347
\fBsetWheelFactor()\fP 
 
348
.RE
 
349
.PP
 
350
 
 
351
.SS "void QwtMagnifier::widgetKeyPressEvent (QKeyEvent *keyEvent)\fC [protected, virtual]\fP"Handle a key press event for the observed widget.
 
352
.PP
 
353
\fBParameters:\fP
 
354
.RS 4
 
355
\fIkeyEvent\fP Key event 
 
356
.RE
 
357
.PP
 
358
\fBSee also:\fP
 
359
.RS 4
 
360
\fBeventFilter()\fP, \fBwidgetKeyReleaseEvent()\fP 
 
361
.RE
 
362
.PP
 
363
 
 
364
.SS "void QwtMagnifier::widgetKeyReleaseEvent (QKeyEvent *keyEvent)\fC [protected, virtual]\fP"Handle a key release event for the observed widget.
 
365
.PP
 
366
\fBParameters:\fP
 
367
.RS 4
 
368
\fIkeyEvent\fP Key event 
 
369
.RE
 
370
.PP
 
371
\fBSee also:\fP
 
372
.RS 4
 
373
\fBeventFilter()\fP, \fBwidgetKeyReleaseEvent()\fP 
 
374
.RE
 
375
.PP
 
376
 
 
377
.SS "void QwtMagnifier::widgetMouseMoveEvent (QMouseEvent *me)\fC [protected, virtual]\fP"Handle a mouse move event for the observed widget.
 
378
.PP
 
379
\fBParameters:\fP
 
380
.RS 4
 
381
\fIme\fP Mouse event 
 
382
.RE
 
383
.PP
 
384
\fBSee also:\fP
 
385
.RS 4
 
386
\fBeventFilter()\fP, \fBwidgetMousePressEvent()\fP, \fBwidgetMouseReleaseEvent()\fP, 
 
387
.RE
 
388
.PP
 
389
 
 
390
.SS "void QwtMagnifier::widgetMousePressEvent (QMouseEvent *me)\fC [protected, virtual]\fP"Handle a mouse press event for the observed widget.
 
391
.PP
 
392
\fBParameters:\fP
 
393
.RS 4
 
394
\fIme\fP Mouse event 
 
395
.RE
 
396
.PP
 
397
\fBSee also:\fP
 
398
.RS 4
 
399
\fBeventFilter()\fP, \fBwidgetMouseReleaseEvent()\fP, \fBwidgetMouseMoveEvent()\fP 
 
400
.RE
 
401
.PP
 
402
 
 
403
.SS "void QwtMagnifier::widgetMouseReleaseEvent (QMouseEvent *)\fC [protected, virtual]\fP"Handle a mouse release event for the observed widget. 
 
404
.PP
 
405
\fBSee also:\fP
 
406
.RS 4
 
407
\fBeventFilter()\fP, \fBwidgetMousePressEvent()\fP, \fBwidgetMouseMoveEvent()\fP, 
 
408
.RE
 
409
.PP
 
410
 
 
411
.SS "void QwtMagnifier::widgetWheelEvent (QWheelEvent *wheelEvent)\fC [protected, virtual]\fP"Handle a wheel event for the observed widget.
 
412
.PP
 
413
\fBParameters:\fP
 
414
.RS 4
 
415
\fIwheelEvent\fP Wheel event 
 
416
.RE
 
417
.PP
 
418
\fBSee also:\fP
 
419
.RS 4
 
420
\fBeventFilter()\fP 
 
421
.RE
 
422
.PP
 
423
 
 
424
 
 
425
.SH "Author"
 
426
.PP 
 
427
Generated automatically by Doxygen for Qwt User's Guide from the source code.