~l3on/ubuntu/oneiric/qwt/fix-921430

« back to all changes in this revision

Viewing changes to qwt-5.0.2/doc/man/man3/QwtWheel.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
* 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:
 
1
.TH "QwtWheel" 3 "11 Jun 2007" "Version 5.0.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtWheel \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
Inherits \fBQwtAbstractSlider\fP.
 
10
.PP
 
11
.SH "Detailed Description"
 
12
.PP 
 
13
The Wheel Widget. 
 
14
 
 
15
The wheel widget can be used to change values over a very large range in very small steps. Using the setMass member, it can be configured as a flywheel.
 
16
.PP
 
17
\fBSee also:\fP
 
18
.RS 4
 
19
The radio example. 
 
20
.RE
 
21
.PP
 
22
 
 
23
.PP
 
24
Definition at line 25 of file qwt_wheel.h.
 
25
.SS "Public Member Functions"
 
26
 
 
27
.in +1c
 
28
.ti -1c
 
29
.RI "\fBQwtWheel\fP (QWidget *parent=NULL)"
 
30
.br
 
31
.ti -1c
 
32
.RI "virtual \fB~QwtWheel\fP ()"
 
33
.br
 
34
.ti -1c
 
35
.RI "virtual void \fBsetOrientation\fP (Qt::Orientation)"
 
36
.br
 
37
.ti -1c
 
38
.RI "double \fBtotalAngle\fP () const "
 
39
.br
 
40
.ti -1c
 
41
.RI "double \fBviewAngle\fP () const "
 
42
.br
 
43
.ti -1c
 
44
.RI "int \fBtickCnt\fP () const "
 
45
.br
 
46
.ti -1c
 
47
.RI "int \fBinternalBorder\fP () const "
 
48
.br
 
49
.ti -1c
 
50
.RI "double \fBmass\fP () const "
 
51
.br
 
52
.ti -1c
 
53
.RI "void \fBsetTotalAngle\fP (double angle)"
 
54
.br
 
55
.ti -1c
 
56
.RI "void \fBsetTickCnt\fP (int cnt)"
 
57
.br
 
58
.ti -1c
 
59
.RI "void \fBsetViewAngle\fP (double angle)"
 
60
.br
 
61
.ti -1c
 
62
.RI "void \fBsetInternalBorder\fP (int width)"
 
63
.br
 
64
.ti -1c
 
65
.RI "void \fBsetMass\fP (double val)"
 
66
.br
 
67
.ti -1c
 
68
.RI "void \fBsetWheelWidth\fP (int w)"
 
69
.br
 
70
.ti -1c
 
71
.RI "virtual QSize \fBsizeHint\fP () const "
 
72
.br
 
73
.ti -1c
 
74
.RI "virtual QSize \fBminimumSizeHint\fP () const "
 
75
.br
 
76
.in -1c
 
77
.SS "Protected Member Functions"
 
78
 
 
79
.in +1c
 
80
.ti -1c
 
81
.RI "virtual void \fBresizeEvent\fP (QResizeEvent *e)"
 
82
.br
 
83
.ti -1c
 
84
.RI "virtual void \fBpaintEvent\fP (QPaintEvent *e)"
 
85
.br
 
86
.ti -1c
 
87
.RI "void \fBlayoutWheel\fP (bool update=true)"
 
88
.br
 
89
.ti -1c
 
90
.RI "void \fBdraw\fP (QPainter *p, const QRect &update_rect)"
 
91
.br
 
92
.ti -1c
 
93
.RI "void \fBdrawWheel\fP (QPainter *p, const QRect &r)"
 
94
.br
 
95
.ti -1c
 
96
.RI "void \fBdrawWheelBackground\fP (QPainter *p, const QRect &r)"
 
97
.br
 
98
.ti -1c
 
99
.RI "void \fBsetColorArray\fP ()"
 
100
.br
 
101
.ti -1c
 
102
.RI "virtual void \fBvalueChange\fP ()"
 
103
.br
 
104
.ti -1c
 
105
.RI "virtual void \fBpaletteChange\fP (const QPalette &)"
 
106
.br
 
107
.ti -1c
 
108
.RI "virtual double \fBgetValue\fP (const QPoint &p)"
 
109
.br
 
110
.ti -1c
 
111
.RI "virtual void \fBgetScrollMode\fP (const QPoint &p, int &scrollMode, int &direction)"
 
112
.br
 
113
.in -1c
 
114
.SH "Constructor & Destructor Documentation"
 
115
.PP 
 
116
.SS "QwtWheel::QwtWheel (QWidget * parent = \fCNULL\fP)\fC [explicit]\fP"
 
117
.PP
 
118
Constructor. 
 
119
.PP
 
120
Definition at line 51 of file qwt_wheel.cpp.
 
121
.SS "QwtWheel::~QwtWheel ()\fC [virtual]\fP"
 
122
.PP
 
123
Destructor. 
 
124
.PP
 
125
Definition at line 86 of file qwt_wheel.cpp.
 
126
.SH "Member Function Documentation"
 
127
.PP 
 
128
.SS "void QwtWheel::draw (QPainter * p, const QRect & update_rect)\fC [protected]\fP"
 
129
.PP
 
130
Redraw panel and wheel. 
 
131
.PP
 
132
Definition at line 564 of file qwt_wheel.cpp.
 
133
.PP
 
134
References QwtPainter::drawFocusRect(), and drawWheel().
 
135
.PP
 
136
Referenced by paintEvent().
 
137
.SS "void QwtWheel::drawWheel (QPainter * p, const QRect & r)\fC [protected]\fP"
 
138
.PP
 
139
Redraw the wheel. 
 
140
.PP
 
141
\fBParameters:\fP
 
142
.RS 4
 
143
\fIp\fP painter 
 
144
.br
 
145
\fIr\fP contents rectangle 
 
146
.RE
 
147
.PP
 
148
 
 
149
.PP
 
150
Definition at line 375 of file qwt_wheel.cpp.
 
151
.PP
 
152
References drawWheelBackground(), QwtDoubleRange::maxValue(), QwtDoubleRange::minValue(), QwtAbstractSlider::orientation(), and QwtDoubleRange::value().
 
153
.PP
 
154
Referenced by draw().
 
155
.SS "void QwtWheel::drawWheelBackground (QPainter * p, const QRect & r)\fC [protected]\fP"
 
156
.PP
 
157
Draw the Wheel's background gradient. 
 
158
.PP
 
159
Definition at line 197 of file qwt_wheel.cpp.
 
160
.PP
 
161
References QwtAbstractSlider::orientation(), and setColorArray().
 
162
.PP
 
163
Referenced by drawWheel().
 
164
.SS "void QwtWheel::getScrollMode (const QPoint & p, int & scrollMode, int & direction)\fC [protected, virtual]\fP"
 
165
.PP
 
166
Determine the scrolling mode and direction corresponding to a specified point. 
 
167
.PP
 
168
\fBParameters:\fP
 
169
.RS 4
 
170
\fIp\fP point 
 
171
.br
 
172
\fIscrollMode\fP scrolling mode 
 
173
.br
 
174
\fIdirection\fP direction 
 
175
.RE
 
176
.PP
 
177
 
 
178
.PP
 
179
Implements \fBQwtAbstractSlider\fP.
 
180
.PP
 
181
Definition at line 596 of file qwt_wheel.cpp.
 
182
.SS "double QwtWheel::getValue (const QPoint & p)\fC [protected, virtual]\fP"
 
183
.PP
 
184
Determine the value corresponding to a specified point. 
 
185
.PP
 
186
Implements \fBQwtAbstractSlider\fP.
 
187
.PP
 
188
Definition at line 494 of file qwt_wheel.cpp.
 
189
.PP
 
190
References QwtDoubleRange::maxValue(), QwtDoubleRange::minValue(), and QwtAbstractSlider::orientation().
 
191
.SS "void QwtWheel::layoutWheel (bool update = \fCtrue\fP)\fC [protected]\fP"
 
192
.PP
 
193
Recalculate the slider's geometry and layout based on. 
 
194
.PP
 
195
Definition at line 533 of file qwt_wheel.cpp.
 
196
.PP
 
197
Referenced by resizeEvent(), setInternalBorder(), setOrientation(), and setWheelWidth().
 
198
.SS "double QwtWheel::mass () const\fC [virtual]\fP"
 
199
.PP
 
200
\fBReturns:\fP
 
201
.RS 4
 
202
mass 
 
203
.RE
 
204
.PP
 
205
 
 
206
.PP
 
207
Reimplemented from \fBQwtAbstractSlider\fP.
 
208
.PP
 
209
Definition at line 168 of file qwt_wheel.cpp.
 
210
.PP
 
211
References QwtAbstractSlider::mass().
 
212
.SS "QSize QwtWheel::minimumSizeHint () const\fC [virtual]\fP"
 
213
.PP
 
214
Return a minimum size hint. 
 
215
.PP
 
216
\fBWarning:\fP
 
217
.RS 4
 
218
The return value is based on the wheel width. 
 
219
.RE
 
220
.PP
 
221
 
 
222
.PP
 
223
Definition at line 642 of file qwt_wheel.cpp.
 
224
.PP
 
225
References QwtAbstractSlider::orientation().
 
226
.PP
 
227
Referenced by sizeHint().
 
228
.SS "void QwtWheel::paintEvent (QPaintEvent * e)\fC [protected, virtual]\fP"
 
229
.PP
 
230
Qt Paint Event. 
 
231
.PP
 
232
Definition at line 547 of file qwt_wheel.cpp.
 
233
.PP
 
234
References draw().
 
235
.SS "void QwtWheel::paletteChange (const QPalette &)\fC [protected, virtual]\fP"
 
236
.PP
 
237
Call update() when the palette changes. 
 
238
.PP
 
239
Definition at line 654 of file qwt_wheel.cpp.
 
240
.SS "void QwtWheel::resizeEvent (QResizeEvent * e)\fC [protected, virtual]\fP"
 
241
.PP
 
242
Qt Resize Event. 
 
243
.PP
 
244
Definition at line 524 of file qwt_wheel.cpp.
 
245
.PP
 
246
References layoutWheel().
 
247
.SS "void QwtWheel::setColorArray ()\fC [protected]\fP"
 
248
.PP
 
249
Set up the color array for the background pixmap. 
 
250
.PP
 
251
Definition at line 96 of file qwt_wheel.cpp.
 
252
.PP
 
253
Referenced by drawWheelBackground().
 
254
.SS "void QwtWheel::setInternalBorder (int w)"
 
255
.PP
 
256
Set the internal border width of the wheel. 
 
257
.PP
 
258
The internal border must not be smaller than 1 and is limited in dependence on the wheel's size. Values outside the allowed range will be clipped.
 
259
.PP
 
260
The internal border defaults to 2. 
 
261
.PP
 
262
\fBParameters:\fP
 
263
.RS 4
 
264
\fIw\fP border width 
 
265
.RE
 
266
.PP
 
267
 
 
268
.PP
 
269
Definition at line 183 of file qwt_wheel.cpp.
 
270
.PP
 
271
References layoutWheel().
 
272
.SS "void QwtWheel::setMass (double val)\fC [virtual]\fP"
 
273
.PP
 
274
Set the mass of the wheel. 
 
275
.PP
 
276
Assigning a mass turns the wheel into a flywheel. 
 
277
.PP
 
278
\fBParameters:\fP
 
279
.RS 4
 
280
\fIval\fP the wheel's mass 
 
281
.RE
 
282
.PP
 
283
 
 
284
.PP
 
285
Reimplemented from \fBQwtAbstractSlider\fP.
 
286
.PP
 
287
Definition at line 612 of file qwt_wheel.cpp.
 
288
.PP
 
289
References QwtAbstractSlider::setMass().
 
290
.SS "void QwtWheel::setOrientation (Qt::Orientation o)\fC [virtual]\fP"
 
291
.PP
 
292
Set the wheel's orientation. 
 
293
.PP
 
294
\fBParameters:\fP
 
295
.RS 4
 
296
\fIo\fP Orientation. Allowed values are Qt::Horizontal and Qt::Vertical. Defaults to Qt::Horizontal. 
 
297
.RE
 
298
.PP
 
299
\fBSee also:\fP
 
300
.RS 4
 
301
\fBQwtAbstractSlider::orientation()\fP 
 
302
.RE
 
303
.PP
 
304
 
 
305
.PP
 
306
Reimplemented from \fBQwtAbstractSlider\fP.
 
307
.PP
 
308
Definition at line 325 of file qwt_wheel.cpp.
 
309
.PP
 
310
References layoutWheel(), QwtAbstractSlider::orientation(), and QwtAbstractSlider::setOrientation().
 
311
.SS "void QwtWheel::setTickCnt (int cnt)"
 
312
.PP
 
313
Adjust the number of grooves in the wheel's surface. 
 
314
.PP
 
315
The number of grooves is limited to 6 <= cnt <= 50. Values outside this range will be clipped. The default value is 10. 
 
316
.PP
 
317
\fBParameters:\fP
 
318
.RS 4
 
319
\fIcnt\fP Number of grooves per 360 degrees 
 
320
.RE
 
321
.PP
 
322
 
 
323
.PP
 
324
Definition at line 154 of file qwt_wheel.cpp.
 
325
.SS "void QwtWheel::setTotalAngle (double angle)"
 
326
.PP
 
327
Set the total angle which the wheel can be turned. 
 
328
.PP
 
329
One full turn of the wheel corresponds to an angle of 360 degrees. A total angle of n*360 degrees means that the wheel has to be turned n times around its axis to get from the minimum value to the maximum value.
 
330
.PP
 
331
The default setting of the total angle is 360 degrees. 
 
332
.PP
 
333
\fBParameters:\fP
 
334
.RS 4
 
335
\fIangle\fP total angle in degrees 
 
336
.RE
 
337
.PP
 
338
 
 
339
.PP
 
340
Definition at line 304 of file qwt_wheel.cpp.
 
341
.SS "void QwtWheel::setViewAngle (double angle)"
 
342
.PP
 
343
Specify the visible portion of the wheel. 
 
344
.PP
 
345
You may use this function for fine-tuning the appearance of the wheel. The default value is 175 degrees. The value is limited from 10 to 175 degrees. 
 
346
.PP
 
347
\fBParameters:\fP
 
348
.RS 4
 
349
\fIangle\fP Visible angle in degrees 
 
350
.RE
 
351
.PP
 
352
 
 
353
.PP
 
354
Definition at line 359 of file qwt_wheel.cpp.
 
355
.SS "void QwtWheel::setWheelWidth (int w)"
 
356
.PP
 
357
Set the width of the wheel. 
 
358
.PP
 
359
Corresponds to the wheel height for horizontal orientation, and the wheel width for vertical orientation. 
 
360
.PP
 
361
\fBParameters:\fP
 
362
.RS 4
 
363
\fIw\fP the wheel's width 
 
364
.RE
 
365
.PP
 
366
 
 
367
.PP
 
368
Definition at line 624 of file qwt_wheel.cpp.
 
369
.PP
 
370
References layoutWheel().
 
371
.SS "QSize QwtWheel::sizeHint () const\fC [virtual]\fP"
 
372
.PP
 
373
\fBReturns:\fP
 
374
.RS 4
 
375
a size hint 
 
376
.RE
 
377
.PP
 
378
 
 
379
.PP
 
380
Definition at line 633 of file qwt_wheel.cpp.
 
381
.PP
 
382
References minimumSizeHint().
 
383
.SS "void QwtWheel::valueChange ()\fC [protected, virtual]\fP"
 
384
.PP
 
385
Notify value change. 
 
386
.PP
 
387
Reimplemented from \fBQwtAbstractSlider\fP.
 
388
.PP
 
389
Definition at line 582 of file qwt_wheel.cpp.
 
390
.PP
 
391
References QwtAbstractSlider::valueChange().
 
392
 
 
393
.SH "Author"
 
394
.PP 
 
395
Generated automatically by Doxygen for Qwt User's Guide from the source code.