← Back to branch summary

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

« back to all changes in this revision

Viewing changes to qwt-5.1.2/doc/man/man3/QwtPanner.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2009-04-12 23:25:58 UTC
  • mfrom: (1.1.4 upstream) (2.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090412232558-3bl06x785yr8xm8u
Tags: 5.1.2-1
* New upstream release.
* Bump compat/debhelper to 7.
* Bump Standards-Version to 3.8.1. No changes needed.
* Invert Maintainers and Uploaders field.
* Fix lintian warnings:
  - dh_clean _k deprecated.
  - missing dependency on libc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.1.2/doc/man/man3/QwtPanner.3
 
1
.TH "QwtPanner" 3 "22 Mar 2009" "Version 5.1.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtPanner \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
Inherited by \fBQwtPlotPanner\fP.
 
10
.PP
 
11
.SH "Detailed Description"
 
12
.PP 
 
13
\fBQwtPanner\fP provides panning of a widget. 
 
14
 
 
15
\fBQwtPanner\fP grabs the contents of a widget, that can be dragged in all directions. The offset between the start and the end position is emitted by the panned signal.
 
16
.PP
 
17
\fBQwtPanner\fP grabs the content of the widget into a pixmap and moves the pixmap around, without initiating any repaint events for the widget. Areas, that are not part of content are not painted while panning in in process. This makes panning fast enough for widgets, where repaints are too slow for mouse movements.
 
18
.PP
 
19
For widgets, where repaints are very fast it might be better to implement panning manually by mapping mouse events into paint events. 
 
20
.PP
 
21
Definition at line 35 of file qwt_panner.h.
 
22
.SS "Signals"
 
23
 
 
24
.in +1c
 
25
.ti -1c
 
26
.RI "void \fBpanned\fP (int dx, int dy)"
 
27
.br
 
28
.ti -1c
 
29
.RI "void \fBmoved\fP (int dx, int dy)"
 
30
.br
 
31
.in -1c
 
32
.SS "Public Member Functions"
 
33
 
 
34
.in +1c
 
35
.ti -1c
 
36
.RI "\fBQwtPanner\fP (QWidget *parent)"
 
37
.br
 
38
.ti -1c
 
39
.RI "virtual \fB~QwtPanner\fP ()"
 
40
.br
 
41
.ti -1c
 
42
.RI "void \fBsetEnabled\fP (bool)"
 
43
.br
 
44
.ti -1c
 
45
.RI "bool \fBisEnabled\fP () const"
 
46
.br
 
47
.ti -1c
 
48
.RI "void \fBsetMouseButton\fP (int button, int buttonState=Qt::NoButton)"
 
49
.br
 
50
.ti -1c
 
51
.RI "void \fBgetMouseButton\fP (int &button, int &buttonState) const "
 
52
.br
 
53
.ti -1c
 
54
.RI "void \fBsetAbortKey\fP (int key, int state=Qt::NoButton)"
 
55
.br
 
56
.ti -1c
 
57
.RI "void \fBgetAbortKey\fP (int &key, int &state) const "
 
58
.br
 
59
.ti -1c
 
60
.RI "void \fBsetCursor\fP (const QCursor &)"
 
61
.br
 
62
.ti -1c
 
63
.RI "const QCursor \fBcursor\fP () const"
 
64
.br
 
65
.ti -1c
 
66
.RI "void \fBsetOrientations\fP (Qt::Orientations)"
 
67
.br
 
68
.ti -1c
 
69
.RI "Qt::Orientations \fBorientations\fP () const"
 
70
.br
 
71
.ti -1c
 
72
.RI "bool \fBisOrientationEnabled\fP (Qt::Orientation) const"
 
73
.br
 
74
.ti -1c
 
75
.RI "virtual bool \fBeventFilter\fP (QObject *, QEvent *)"
 
76
.br
 
77
.in -1c
 
78
.SS "Protected Member Functions"
 
79
 
 
80
.in +1c
 
81
.ti -1c
 
82
.RI "virtual void \fBwidgetMousePressEvent\fP (QMouseEvent *)"
 
83
.br
 
84
.ti -1c
 
85
.RI "virtual void \fBwidgetMouseReleaseEvent\fP (QMouseEvent *)"
 
86
.br
 
87
.ti -1c
 
88
.RI "virtual void \fBwidgetMouseMoveEvent\fP (QMouseEvent *)"
 
89
.br
 
90
.ti -1c
 
91
.RI "virtual void \fBwidgetKeyPressEvent\fP (QKeyEvent *)"
 
92
.br
 
93
.ti -1c
 
94
.RI "virtual void \fBwidgetKeyReleaseEvent\fP (QKeyEvent *)"
 
95
.br
 
96
.ti -1c
 
97
.RI "virtual void \fBpaintEvent\fP (QPaintEvent *)"
 
98
.br
 
99
.in -1c
 
100
.SH "Constructor & Destructor Documentation"
 
101
.PP 
 
102
.SS "QwtPanner::QwtPanner (QWidget * parent)"
 
103
.PP
 
104
Creates an panner that is enabled for the left mouse button.
 
105
.PP
 
106
\fBParameters:\fP
 
107
.RS 4
 
108
\fIparent\fP Parent widget to be panned 
 
109
.RE
 
110
.PP
 
111
 
 
112
.PP
 
113
Definition at line 121 of file qwt_panner.cpp.
 
114
.PP
 
115
References setEnabled().
 
116
.SS "QwtPanner::~QwtPanner ()\fC [virtual]\fP"
 
117
.PP
 
118
Destructor. 
 
119
.PP
 
120
Definition at line 140 of file qwt_panner.cpp.
 
121
.SH "Member Function Documentation"
 
122
.PP 
 
123
.SS "void QwtPanner::setEnabled (bool on)"
 
124
.PP
 
125
En/disable the panner. 
 
126
.PP
 
127
When enabled is true an event filter is installed for the observed widget, otherwise the event filter is removed.
 
128
.PP
 
129
\fBParameters:\fP
 
130
.RS 4
 
131
\fIon\fP true or false 
 
132
.RE
 
133
.PP
 
134
\fBSee also:\fP
 
135
.RS 4
 
136
\fBisEnabled()\fP, \fBeventFilter()\fP 
 
137
.RE
 
138
.PP
 
139
 
 
140
.PP
 
141
Definition at line 220 of file qwt_panner.cpp.
 
142
.PP
 
143
Referenced by QwtPanner(), and widgetMousePressEvent().
 
144
.SS "bool QwtPanner::isEnabled () const"
 
145
.PP
 
146
\fBReturns:\fP
 
147
.RS 4
 
148
true when enabled, false otherwise 
 
149
.RE
 
150
.PP
 
151
\fBSee also:\fP
 
152
.RS 4
 
153
\fBsetEnabled\fP, \fBeventFilter()\fP 
 
154
.RE
 
155
.PP
 
156
 
 
157
.PP
 
158
Definition at line 287 of file qwt_panner.cpp.
 
159
.SS "void QwtPanner::setMouseButton (int button, int buttonState = \fCQt::NoButton\fP)"
 
160
.PP
 
161
Change the mouse button The defaults are Qt::LeftButton and Qt::NoButton 
 
162
.PP
 
163
Definition at line 149 of file qwt_panner.cpp.
 
164
.SS "void QwtPanner::getMouseButton (int & button, int & buttonState) const"
 
165
.PP
 
166
Get the mouse button. 
 
167
.PP
 
168
Definition at line 156 of file qwt_panner.cpp.
 
169
.SS "void QwtPanner::setAbortKey (int key, int state = \fCQt::NoButton\fP)"
 
170
.PP
 
171
Change the abort key The defaults are Qt::Key_Escape and Qt::NoButton 
 
172
.PP
 
173
Definition at line 166 of file qwt_panner.cpp.
 
174
.SS "void QwtPanner::getAbortKey (int & key, int & state) const"
 
175
.PP
 
176
Get the abort key. 
 
177
.PP
 
178
Definition at line 173 of file qwt_panner.cpp.
 
179
.SS "void QwtPanner::setCursor (const QCursor & cursor)"
 
180
.PP
 
181
Change the cursor, that is active while panning The default is the cursor of the parent widget.
 
182
.PP
 
183
\fBParameters:\fP
 
184
.RS 4
 
185
\fIcursor\fP New cursor
 
186
.RE
 
187
.PP
 
188
\fBSee also:\fP
 
189
.RS 4
 
190
\fBsetCursor()\fP 
 
191
.RE
 
192
.PP
 
193
 
 
194
.PP
 
195
Definition at line 188 of file qwt_panner.cpp.
 
196
.SS "const QCursor QwtPanner::cursor () const"
 
197
.PP
 
198
\fBReturns:\fP
 
199
.RS 4
 
200
Cursor that is active while panning 
 
201
.RE
 
202
.PP
 
203
\fBSee also:\fP
 
204
.RS 4
 
205
\fBsetCursor()\fP 
 
206
.RE
 
207
.PP
 
208
 
 
209
.PP
 
210
Definition at line 199 of file qwt_panner.cpp.
 
211
.SS "void QwtPanner::setOrientations (Qt::Orientations o)"
 
212
.PP
 
213
Set the orientations, where panning is enabled The default value is in both directions: Qt::Horizontal | Qt::Vertical
 
214
.PP
 
215
/param o Orientation 
 
216
.PP
 
217
Definition at line 249 of file qwt_panner.cpp.
 
218
.SS "Qt::Orientations QwtPanner::orientations () const"
 
219
.PP
 
220
Return the orientation, where paning is enabled. 
 
221
.PP
 
222
Definition at line 255 of file qwt_panner.cpp.
 
223
.SS "bool QwtPanner::isOrientationEnabled (Qt::Orientation o) const"
 
224
.PP
 
225
Return true if a orientatio is enabled 
 
226
.PP
 
227
\fBSee also:\fP
 
228
.RS 4
 
229
\fBorientations()\fP, \fBsetOrientations()\fP 
 
230
.RE
 
231
.PP
 
232
 
 
233
.PP
 
234
Definition at line 272 of file qwt_panner.cpp.
 
235
.PP
 
236
Referenced by widgetMouseMoveEvent(), and widgetMouseReleaseEvent().
 
237
.SS "bool QwtPanner::eventFilter (QObject * o, QEvent * e)\fC [virtual]\fP"
 
238
.PP
 
239
Event filter. 
 
240
.PP
 
241
When \fBisEnabled()\fP the mouse events of the observed widget are filtered.
 
242
.PP
 
243
\fBSee also:\fP
 
244
.RS 4
 
245
\fBwidgetMousePressEvent()\fP, \fBwidgetMouseReleaseEvent()\fP, \fBwidgetMouseMoveEvent()\fP 
 
246
.RE
 
247
.PP
 
248
 
 
249
.PP
 
250
Definition at line 341 of file qwt_panner.cpp.
 
251
.PP
 
252
References widgetKeyPressEvent(), widgetKeyReleaseEvent(), widgetMouseMoveEvent(), widgetMousePressEvent(), and widgetMouseReleaseEvent().
 
253
.SS "void QwtPanner::panned (int dx, int dy)\fC [signal]\fP"
 
254
.PP
 
255
Signal emitted, when panning is done
 
256
.PP
 
257
\fBParameters:\fP
 
258
.RS 4
 
259
\fIdx\fP Offset in horizontal direction 
 
260
.br
 
261
\fIdy\fP Offset in vertical direction 
 
262
.RE
 
263
.PP
 
264
 
 
265
.PP
 
266
Referenced by QwtPlotPanner::QwtPlotPanner(), and widgetMouseReleaseEvent().
 
267
.SS "void QwtPanner::moved (int dx, int dy)\fC [signal]\fP"
 
268
.PP
 
269
Signal emitted, while the widget moved, but panning is not finished.
 
270
.PP
 
271
\fBParameters:\fP
 
272
.RS 4
 
273
\fIdx\fP Offset in horizontal direction 
 
274
.br
 
275
\fIdy\fP Offset in vertical direction 
 
276
.RE
 
277
.PP
 
278
 
 
279
.PP
 
280
Referenced by widgetMouseMoveEvent().
 
281
.SS "void QwtPanner::widgetMousePressEvent (QMouseEvent * me)\fC [protected, virtual]\fP"
 
282
.PP
 
283
Handle a mouse press event for the observed widget.
 
284
.PP
 
285
\fBParameters:\fP
 
286
.RS 4
 
287
\fIme\fP Mouse event 
 
288
.RE
 
289
.PP
 
290
\fBSee also:\fP
 
291
.RS 4
 
292
\fBeventFilter()\fP, \fBwidgetMouseReleaseEvent()\fP, \fBwidgetMouseMoveEvent()\fP, 
 
293
.RE
 
294
.PP
 
295
 
 
296
.PP
 
297
Definition at line 392 of file qwt_panner.cpp.
 
298
.PP
 
299
References setEnabled().
 
300
.PP
 
301
Referenced by eventFilter().
 
302
.SS "void QwtPanner::widgetMouseReleaseEvent (QMouseEvent * me)\fC [protected, virtual]\fP"
 
303
.PP
 
304
Handle a mouse release event for the observed widget.
 
305
.PP
 
306
\fBParameters:\fP
 
307
.RS 4
 
308
\fIme\fP Mouse event 
 
309
.RE
 
310
.PP
 
311
\fBSee also:\fP
 
312
.RS 4
 
313
\fBeventFilter()\fP, \fBwidgetMousePressEvent()\fP, \fBwidgetMouseMoveEvent()\fP, 
 
314
.RE
 
315
.PP
 
316
 
 
317
.PP
 
318
Definition at line 474 of file qwt_panner.cpp.
 
319
.PP
 
320
References isOrientationEnabled(), and panned().
 
321
.PP
 
322
Referenced by eventFilter().
 
323
.SS "void QwtPanner::widgetMouseMoveEvent (QMouseEvent * me)\fC [protected, virtual]\fP"
 
324
.PP
 
325
Handle a mouse move event for the observed widget.
 
326
.PP
 
327
\fBParameters:\fP
 
328
.RS 4
 
329
\fIme\fP Mouse event 
 
330
.RE
 
331
.PP
 
332
\fBSee also:\fP
 
333
.RS 4
 
334
\fBeventFilter()\fP, \fBwidgetMousePressEvent()\fP, \fBwidgetMouseReleaseEvent()\fP 
 
335
.RE
 
336
.PP
 
337
 
 
338
.PP
 
339
Definition at line 446 of file qwt_panner.cpp.
 
340
.PP
 
341
References isOrientationEnabled(), and moved().
 
342
.PP
 
343
Referenced by eventFilter().
 
344
.SS "void QwtPanner::widgetKeyPressEvent (QKeyEvent * ke)\fC [protected, virtual]\fP"
 
345
.PP
 
346
Handle a key press event for the observed widget.
 
347
.PP
 
348
\fBParameters:\fP
 
349
.RS 4
 
350
\fIke\fP Key event 
 
351
.RE
 
352
.PP
 
353
\fBSee also:\fP
 
354
.RS 4
 
355
\fBeventFilter()\fP, \fBwidgetKeyReleaseEvent()\fP 
 
356
.RE
 
357
.PP
 
358
 
 
359
.PP
 
360
Definition at line 506 of file qwt_panner.cpp.
 
361
.PP
 
362
Referenced by eventFilter().
 
363
.SS "void QwtPanner::widgetKeyReleaseEvent (QKeyEvent *)\fC [protected, virtual]\fP"
 
364
.PP
 
365
Handle a key release event for the observed widget.
 
366
.PP
 
367
\fBParameters:\fP
 
368
.RS 4
 
369
\fIke\fP Key event 
 
370
.RE
 
371
.PP
 
372
\fBSee also:\fP
 
373
.RS 4
 
374
\fBeventFilter()\fP, \fBwidgetKeyReleaseEvent()\fP 
 
375
.RE
 
376
.PP
 
377
 
 
378
.PP
 
379
Definition at line 535 of file qwt_panner.cpp.
 
380
.PP
 
381
Referenced by eventFilter().
 
382
.SS "void QwtPanner::paintEvent (QPaintEvent * pe)\fC [protected, virtual]\fP"
 
383
.PP
 
384
Paint event. 
 
385
.PP
 
386
Repaint the grabbed pixmap on its current position and fill the empty spaces by the background of the parent widget.
 
387
.PP
 
388
\fBParameters:\fP
 
389
.RS 4
 
390
\fIpe\fP Paint event 
 
391
.RE
 
392
.PP
 
393
 
 
394
.PP
 
395
Definition at line 300 of file qwt_panner.cpp.
 
396
 
 
397
.SH "Author"
 
398
.PP 
 
399
Generated automatically by Doxygen for Qwt User's Guide from the source code.