← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2007-10-05 15:20:41 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20071005152041-qmybqh4fj9jejyo2
Tags: 5.0.2-2
http://bugs.debian.org/437877
http://bugs.debian.org/443110
* Handle nostrip build option. (Closes: #437877)
* Build libqwt5-doc package in binary-indep target. (Closes: #443110)

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.0.1/doc/man/man3/QwtPanner.3
1
 
.TH "QwtPanner" 3 "26 Feb 2007" "Version 5.0.1" "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 "virtual bool \fBeventFilter\fP (QObject *, QEvent *)"
67
 
.br
68
 
.in -1c
69
 
.SS "Protected Member Functions"
70
 
 
71
 
.in +1c
72
 
.ti -1c
73
 
.RI "virtual void \fBwidgetMousePressEvent\fP (QMouseEvent *)"
74
 
.br
75
 
.ti -1c
76
 
.RI "virtual void \fBwidgetMouseReleaseEvent\fP (QMouseEvent *)"
77
 
.br
78
 
.ti -1c
79
 
.RI "virtual void \fBwidgetMouseMoveEvent\fP (QMouseEvent *)"
80
 
.br
81
 
.ti -1c
82
 
.RI "virtual void \fBwidgetKeyPressEvent\fP (QKeyEvent *)"
83
 
.br
84
 
.ti -1c
85
 
.RI "virtual void \fBwidgetKeyReleaseEvent\fP (QKeyEvent *)"
86
 
.br
87
 
.ti -1c
88
 
.RI "virtual void \fBpaintEvent\fP (QPaintEvent *)"
89
 
.br
90
 
.in -1c
91
 
.SH "Constructor & Destructor Documentation"
92
 
.PP 
93
 
.SS "QwtPanner::QwtPanner (QWidget * parent)"
94
 
.PP
95
 
Creates an panner that is enabled for the left mouse button.
96
 
.PP
97
 
\fBParameters:\fP
98
 
.RS 4
99
 
\fIparent\fP Parent widget to be panned 
100
 
.RE
101
 
.PP
102
 
 
103
 
.PP
104
 
Definition at line 64 of file qwt_panner.cpp.
105
 
.PP
106
 
References setEnabled().
107
 
.SS "QwtPanner::~QwtPanner ()\fC [virtual]\fP"
108
 
.PP
109
 
Destructor. 
110
 
.PP
111
 
Definition at line 86 of file qwt_panner.cpp.
112
 
.SH "Member Function Documentation"
113
 
.PP 
114
 
.SS "const QCursor QwtPanner::cursor () const"
115
 
.PP
116
 
\fBReturns:\fP
117
 
.RS 4
118
 
Cursor that is active while panning 
119
 
.RE
120
 
.PP
121
 
\fBSee also:\fP
122
 
.RS 4
123
 
\fBsetCursor()\fP 
124
 
.RE
125
 
.PP
126
 
 
127
 
.PP
128
 
Definition at line 145 of file qwt_panner.cpp.
129
 
.SS "bool QwtPanner::eventFilter (QObject * o, QEvent * e)\fC [virtual]\fP"
130
 
.PP
131
 
Event filter. 
132
 
.PP
133
 
When \fBisEnabled()\fP the mouse events of the observed widget are filtered.
134
 
.PP
135
 
\fBSee also:\fP
136
 
.RS 4
137
 
\fBwidgetMousePressEvent()\fP, \fBwidgetMouseReleaseEvent()\fP, \fBwidgetMouseMoveEvent()\fP 
138
 
.RE
139
 
.PP
140
 
 
141
 
.PP
142
 
Definition at line 246 of file qwt_panner.cpp.
143
 
.PP
144
 
References widgetMousePressEvent().
145
 
.SS "void QwtPanner::getAbortKey (int & key, int & state) const"
146
 
.PP
147
 
Get the abort key. 
148
 
.PP
149
 
Definition at line 119 of file qwt_panner.cpp.
150
 
.SS "void QwtPanner::getMouseButton (int & button, int & buttonState) const"
151
 
.PP
152
 
Get the mouse button. 
153
 
.PP
154
 
Definition at line 102 of file qwt_panner.cpp.
155
 
.SS "bool QwtPanner::isEnabled () const"
156
 
.PP
157
 
\fBReturns:\fP
158
 
.RS 4
159
 
true when enabled, false otherwise 
160
 
.RE
161
 
.PP
162
 
\fBSee also:\fP
163
 
.RS 4
164
 
\fBsetEnabled\fP, \fBeventFilter()\fP 
165
 
.RE
166
 
.PP
167
 
 
168
 
.PP
169
 
Definition at line 192 of file qwt_panner.cpp.
170
 
.SS "void QwtPanner::moved (int dx, int dy)\fC [signal]\fP"
171
 
.PP
172
 
Signal emitted, while the widget moved, but panning is not finished.
173
 
.PP
174
 
\fBParameters:\fP
175
 
.RS 4
176
 
\fIdx\fP Offset in horizontal direction 
177
 
.br
178
 
\fIdy\fP Offset in vertical direction 
179
 
.RE
180
 
.PP
181
 
 
182
 
.PP
183
 
Referenced by widgetMouseMoveEvent().
184
 
.SS "void QwtPanner::paintEvent (QPaintEvent * pe)\fC [protected, virtual]\fP"
185
 
.PP
186
 
Paint event. 
187
 
.PP
188
 
Repaint the grabbed pixmap on its current position and fill the empty spaces by the background of the parent widget.
189
 
.PP
190
 
\fBParameters:\fP
191
 
.RS 4
192
 
\fIpe\fP Paint event 
193
 
.RE
194
 
.PP
195
 
 
196
 
.PP
197
 
Definition at line 205 of file qwt_panner.cpp.
198
 
.SS "void QwtPanner::panned (int dx, int dy)\fC [signal]\fP"
199
 
.PP
200
 
Signal emitted, when panning is done
201
 
.PP
202
 
\fBParameters:\fP
203
 
.RS 4
204
 
\fIdx\fP Offset in horizontal direction 
205
 
.br
206
 
\fIdy\fP Offset in vertical direction 
207
 
.RE
208
 
.PP
209
 
 
210
 
.PP
211
 
Referenced by QwtPlotPanner::QwtPlotPanner(), and widgetMouseReleaseEvent().
212
 
.SS "void QwtPanner::setAbortKey (int key, int state = \fCQt::NoButton\fP)"
213
 
.PP
214
 
Change the abort key The defaults are Qt::Key_Escape and Qt::NoButton 
215
 
.PP
216
 
Definition at line 112 of file qwt_panner.cpp.
217
 
.SS "void QwtPanner::setCursor (const QCursor & cursor)"
218
 
.PP
219
 
Change the cursor, that is active while panning The default is the cursor of the parent widget.
220
 
.PP
221
 
\fBParameters:\fP
222
 
.RS 4
223
 
\fIcursor\fP New cursor
224
 
.RE
225
 
.PP
226
 
\fBSee also:\fP
227
 
.RS 4
228
 
\fBsetCursor()\fP 
229
 
.RE
230
 
.PP
231
 
 
232
 
.PP
233
 
Definition at line 134 of file qwt_panner.cpp.
234
 
.SS "void QwtPanner::setEnabled (bool on)"
235
 
.PP
236
 
En/disable the panner. 
237
 
.PP
238
 
When enabled is true an event filter is installed for the observed widget, otherwise the event filter is removed.
239
 
.PP
240
 
\fBParameters:\fP
241
 
.RS 4
242
 
\fIon\fP true or false 
243
 
.RE
244
 
.PP
245
 
\fBSee also:\fP
246
 
.RS 4
247
 
\fBisEnabled()\fP, \fBeventFilter()\fP 
248
 
.RE
249
 
.PP
250
 
 
251
 
.PP
252
 
Definition at line 166 of file qwt_panner.cpp.
253
 
.PP
254
 
Referenced by QwtPanner().
255
 
.SS "void QwtPanner::setMouseButton (int button, int buttonState = \fCQt::NoButton\fP)"
256
 
.PP
257
 
Change the mouse button The defaults are Qt::LeftButton and Qt::NoButton 
258
 
.PP
259
 
Definition at line 95 of file qwt_panner.cpp.
260
 
.SS "void QwtPanner::widgetKeyPressEvent (QKeyEvent * ke)\fC [protected, virtual]\fP"
261
 
.PP
262
 
Handle a key press event for the observed widget.
263
 
.PP
264
 
\fBParameters:\fP
265
 
.RS 4
266
 
\fIke\fP Key event 
267
 
.RE
268
 
.PP
269
 
\fBSee also:\fP
270
 
.RS 4
271
 
\fBeventFilter()\fP, \fBwidgetKeyReleaseEvent()\fP 
272
 
.RE
273
 
.PP
274
 
 
275
 
.PP
276
 
Definition at line 379 of file qwt_panner.cpp.
277
 
.SS "void QwtPanner::widgetKeyReleaseEvent (QKeyEvent *)\fC [protected, virtual]\fP"
278
 
.PP
279
 
Handle a key release event for the observed widget.
280
 
.PP
281
 
\fBParameters:\fP
282
 
.RS 4
283
 
\fIke\fP Key event 
284
 
.RE
285
 
.PP
286
 
\fBSee also:\fP
287
 
.RS 4
288
 
\fBeventFilter()\fP, \fBwidgetKeyReleaseEvent()\fP 
289
 
.RE
290
 
.PP
291
 
 
292
 
.PP
293
 
Definition at line 408 of file qwt_panner.cpp.
294
 
.SS "void QwtPanner::widgetMouseMoveEvent (QMouseEvent * me)\fC [protected, virtual]\fP"
295
 
.PP
296
 
Handle a mouse release event for the observed widget.
297
 
.PP
298
 
\fBParameters:\fP
299
 
.RS 4
300
 
\fIme\fP Mouse event 
301
 
.RE
302
 
.PP
303
 
\fBSee also:\fP
304
 
.RS 4
305
 
\fBeventFilter()\fP, \fBwidgetMousePressEvent()\fP, \fBwidgetMouseMoveEvent()\fP, 
306
 
.RE
307
 
.PP
308
 
 
309
 
.PP
310
 
Definition at line 336 of file qwt_panner.cpp.
311
 
.PP
312
 
References moved().
313
 
.SS "void QwtPanner::widgetMousePressEvent (QMouseEvent * me)\fC [protected, virtual]\fP"
314
 
.PP
315
 
Handle a mouse press event for the observed widget.
316
 
.PP
317
 
\fBParameters:\fP
318
 
.RS 4
319
 
\fIme\fP Mouse event 
320
 
.RE
321
 
.PP
322
 
\fBSee also:\fP
323
 
.RS 4
324
 
\fBeventFilter()\fP, \fBwidgetMouseReleaseEvent()\fP, \fBwidgetMouseMoveEvent()\fP, 
325
 
.RE
326
 
.PP
327
 
 
328
 
.PP
329
 
Definition at line 291 of file qwt_panner.cpp.
330
 
.PP
331
 
Referenced by eventFilter().
332
 
.SS "void QwtPanner::widgetMouseReleaseEvent (QMouseEvent * me)\fC [protected, virtual]\fP"
333
 
.PP
334
 
Handle a mouse move event for the observed widget.
335
 
.PP
336
 
\fBSee also:\fP
337
 
.RS 4
338
 
\fBeventFilter()\fP, \fBwidgetMousePressEvent()\fP, \fBwidgetMouseReleaseEvent()\fP, 
339
 
.RE
340
 
.PP
341
 
 
342
 
.PP
343
 
Definition at line 353 of file qwt_panner.cpp.
344
 
.PP
345
 
References panned().
346
 
 
347
 
.SH "Author"
348
 
.PP 
349
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.