← Back to branch summary

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

« back to all changes in this revision

Viewing changes to qwt-5.0.2/doc/man/man3/QwtKnob.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.2/doc/man/man3/QwtKnob.3
 
1
.TH "QwtKnob" 3 "11 Jun 2007" "Version 5.0.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtKnob \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
Inherits \fBQwtAbstractSlider\fP, and \fBQwtAbstractScale\fP.
 
10
.PP
 
11
.SH "Detailed Description"
 
12
.PP 
 
13
The Knob Widget. 
 
14
 
 
15
The \fBQwtKnob\fP widget imitates look and behaviour of a volume knob on a radio. It contains a scale around the knob which is set up automatically or can be configured manually (see \fBQwtAbstractScale\fP). Automatic scrolling is enabled when the user presses a mouse button on the scale. For a description of signals, slots and other members, see \fBQwtAbstractSlider\fP.
 
16
.PP
 
17
 
 
18
.PP
 
19
\fBSee also:\fP
 
20
.RS 4
 
21
\fBQwtAbstractSlider\fP and \fBQwtAbstractScale\fP for the descriptions of the inherited members. 
 
22
.RE
 
23
.PP
 
24
 
 
25
.PP
 
26
Definition at line 34 of file qwt_knob.h.
 
27
.SS "Public Types"
 
28
 
 
29
.in +1c
 
30
.ti -1c
 
31
.RI "enum \fBSymbol\fP { \fBLine\fP, \fBDot\fP }"
 
32
.br
 
33
.in -1c
 
34
.SS "Public Member Functions"
 
35
 
 
36
.in +1c
 
37
.ti -1c
 
38
.RI "\fBQwtKnob\fP (QWidget *parent=NULL)"
 
39
.br
 
40
.ti -1c
 
41
.RI "virtual \fB~QwtKnob\fP ()"
 
42
.br
 
43
.ti -1c
 
44
.RI "void \fBsetKnobWidth\fP (int w)"
 
45
.br
 
46
.ti -1c
 
47
.RI "int \fBknobWidth\fP () const "
 
48
.br
 
49
.ti -1c
 
50
.RI "void \fBsetTotalAngle\fP (double angle)"
 
51
.br
 
52
.ti -1c
 
53
.RI "double \fBtotalAngle\fP () const "
 
54
.br
 
55
.ti -1c
 
56
.RI "void \fBsetBorderWidth\fP (int bw)"
 
57
.br
 
58
.ti -1c
 
59
.RI "int \fBborderWidth\fP () const "
 
60
.br
 
61
.ti -1c
 
62
.RI "void \fBsetSymbol\fP (\fBSymbol\fP)"
 
63
.br
 
64
.ti -1c
 
65
.RI "\fBSymbol\fP \fBsymbol\fP () const "
 
66
.br
 
67
.ti -1c
 
68
.RI "virtual QSize \fBsizeHint\fP () const "
 
69
.br
 
70
.ti -1c
 
71
.RI "virtual QSize \fBminimumSizeHint\fP () const "
 
72
.br
 
73
.ti -1c
 
74
.RI "void \fBsetScaleDraw\fP (\fBQwtRoundScaleDraw\fP *)"
 
75
.br
 
76
.ti -1c
 
77
.RI "const \fBQwtRoundScaleDraw\fP * \fBscaleDraw\fP () const "
 
78
.br
 
79
.ti -1c
 
80
.RI "\fBQwtRoundScaleDraw\fP * \fBscaleDraw\fP ()"
 
81
.br
 
82
.in -1c
 
83
.SS "Protected Member Functions"
 
84
 
 
85
.in +1c
 
86
.ti -1c
 
87
.RI "virtual void \fBpaintEvent\fP (QPaintEvent *e)"
 
88
.br
 
89
.ti -1c
 
90
.RI "virtual void \fBresizeEvent\fP (QResizeEvent *e)"
 
91
.br
 
92
.ti -1c
 
93
.RI "void \fBdraw\fP (QPainter *p, const QRect &ur)"
 
94
.br
 
95
.ti -1c
 
96
.RI "void \fBdrawKnob\fP (QPainter *p, const QRect &r)"
 
97
.br
 
98
.ti -1c
 
99
.RI "void \fBdrawMarker\fP (QPainter *p, double arc, const QColor &c)"
 
100
.br
 
101
.in -1c
 
102
.SH "Member Enumeration Documentation"
 
103
.PP 
 
104
.SS "enum \fBQwtKnob::Symbol\fP"
 
105
.PP
 
106
Symbol 
 
107
.PP
 
108
\fBSee also:\fP
 
109
.RS 4
 
110
\fBQwtKnob::QwtKnob()\fP 
 
111
.RE
 
112
.PP
 
113
 
 
114
.PP
 
115
Definition at line 49 of file qwt_knob.h.
 
116
.SH "Constructor & Destructor Documentation"
 
117
.PP 
 
118
.SS "QwtKnob::QwtKnob (QWidget * parent = \fCNULL\fP)\fC [explicit]\fP"
 
119
.PP
 
120
Constructor 
 
121
.PP
 
122
\fBParameters:\fP
 
123
.RS 4
 
124
\fIparent\fP Parent widget 
 
125
.RE
 
126
.PP
 
127
 
 
128
.PP
 
129
Definition at line 59 of file qwt_knob.cpp.
 
130
.SS "QwtKnob::~QwtKnob ()\fC [virtual]\fP"
 
131
.PP
 
132
Destructor. 
 
133
.PP
 
134
Definition at line 99 of file qwt_knob.cpp.
 
135
.SH "Member Function Documentation"
 
136
.PP 
 
137
.SS "int QwtKnob::borderWidth () const"
 
138
.PP
 
139
Return the border width. 
 
140
.PP
 
141
Definition at line 475 of file qwt_knob.cpp.
 
142
.SS "void QwtKnob::draw (QPainter * p, const QRect & ur)\fC [protected]\fP"
 
143
.PP
 
144
Repaint the knob. 
 
145
.PP
 
146
Definition at line 382 of file qwt_knob.cpp.
 
147
.PP
 
148
References QwtAbstractScaleDraw::draw(), and scaleDraw().
 
149
.PP
 
150
Referenced by paintEvent().
 
151
.SS "void QwtKnob::drawKnob (QPainter * painter, const QRect & r)\fC [protected]\fP"
 
152
.PP
 
153
Draw the knob. 
 
154
.PP
 
155
\fBParameters:\fP
 
156
.RS 4
 
157
\fIpainter\fP painter 
 
158
.br
 
159
\fIr\fP Bounding rectangle of the knob (without scale) 
 
160
.RE
 
161
.PP
 
162
 
 
163
.PP
 
164
Definition at line 189 of file qwt_knob.cpp.
 
165
.PP
 
166
References drawMarker(), and QwtAbstractSlider::isValid().
 
167
.SS "void QwtKnob::drawMarker (QPainter * p, double arc, const QColor & c)\fC [protected]\fP"
 
168
.PP
 
169
Draw the marker at the knob's front. 
 
170
.PP
 
171
\fBParameters:\fP
 
172
.RS 4
 
173
\fIp\fP Painter 
 
174
.br
 
175
\fIarc\fP Angle of the marker 
 
176
.br
 
177
\fIc\fP Marker color 
 
178
.RE
 
179
.PP
 
180
 
 
181
.PP
 
182
Definition at line 405 of file qwt_knob.cpp.
 
183
.PP
 
184
Referenced by drawKnob().
 
185
.SS "int QwtKnob::knobWidth () const"
 
186
.PP
 
187
Return the width of the knob. 
 
188
.PP
 
189
Definition at line 459 of file qwt_knob.cpp.
 
190
.SS "QSize QwtKnob::minimumSizeHint () const\fC [virtual]\fP"
 
191
.PP
 
192
Return a minimum size hint. 
 
193
.PP
 
194
\fBWarning:\fP
 
195
.RS 4
 
196
The return value of \fBQwtKnob::minimumSizeHint()\fP depends on the font and the scale. 
 
197
.RE
 
198
.PP
 
199
 
 
200
.PP
 
201
Definition at line 536 of file qwt_knob.cpp.
 
202
.PP
 
203
References QwtRoundScaleDraw::extent(), and scaleDraw().
 
204
.PP
 
205
Referenced by sizeHint().
 
206
.SS "void QwtKnob::paintEvent (QPaintEvent * e)\fC [protected, virtual]\fP"
 
207
.PP
 
208
Repaint the knob. 
 
209
.PP
 
210
Definition at line 362 of file qwt_knob.cpp.
 
211
.PP
 
212
References draw().
 
213
.SS "void QwtKnob::resizeEvent (QResizeEvent * e)\fC [protected, virtual]\fP"
 
214
.PP
 
215
Qt Resize Event. 
 
216
.PP
 
217
Definition at line 331 of file qwt_knob.cpp.
 
218
.SS "\fBQwtRoundScaleDraw\fP * QwtKnob::scaleDraw ()"
 
219
.PP
 
220
\fBReturns:\fP
 
221
.RS 4
 
222
the scale draw of the knob 
 
223
.RE
 
224
.PP
 
225
\fBSee also:\fP
 
226
.RS 4
 
227
\fBsetScaleDraw()\fP 
 
228
.RE
 
229
.PP
 
230
 
 
231
.PP
 
232
Definition at line 179 of file qwt_knob.cpp.
 
233
.PP
 
234
References QwtAbstractScale::abstractScaleDraw().
 
235
.SS "const \fBQwtRoundScaleDraw\fP * QwtKnob::scaleDraw () const"
 
236
.PP
 
237
\fBReturns:\fP
 
238
.RS 4
 
239
the scale draw of the knob 
 
240
.RE
 
241
.PP
 
242
\fBSee also:\fP
 
243
.RS 4
 
244
\fBsetScaleDraw()\fP 
 
245
.RE
 
246
.PP
 
247
 
 
248
.PP
 
249
Definition at line 170 of file qwt_knob.cpp.
 
250
.PP
 
251
References QwtAbstractScale::abstractScaleDraw().
 
252
.PP
 
253
Referenced by draw(), minimumSizeHint(), setScaleDraw(), and setTotalAngle().
 
254
.SS "void QwtKnob::setBorderWidth (int bw)"
 
255
.PP
 
256
Set the knob's border width. 
 
257
.PP
 
258
\fBParameters:\fP
 
259
.RS 4
 
260
\fIbw\fP new border width 
 
261
.RE
 
262
.PP
 
263
 
 
264
.PP
 
265
Definition at line 468 of file qwt_knob.cpp.
 
266
.SS "void QwtKnob::setKnobWidth (int w)"
 
267
.PP
 
268
Change the knob's width. 
 
269
.PP
 
270
The specified width must be >= 5, or it will be clipped. 
 
271
.PP
 
272
\fBParameters:\fP
 
273
.RS 4
 
274
\fIw\fP New width 
 
275
.RE
 
276
.PP
 
277
 
 
278
.PP
 
279
Definition at line 452 of file qwt_knob.cpp.
 
280
.SS "void QwtKnob::setScaleDraw (\fBQwtRoundScaleDraw\fP * scaleDraw)"
 
281
.PP
 
282
Change the scale draw of the knob
 
283
.PP
 
284
For changing the labels of the scales, it is necessary to derive from \fBQwtRoundScaleDraw\fP and overload \fBQwtRoundScaleDraw::label()\fP.
 
285
.PP
 
286
\fBSee also:\fP
 
287
.RS 4
 
288
\fBscaleDraw()\fP 
 
289
.RE
 
290
.PP
 
291
 
 
292
.PP
 
293
Definition at line 161 of file qwt_knob.cpp.
 
294
.PP
 
295
References scaleDraw(), and QwtAbstractScale::setAbstractScaleDraw().
 
296
.SS "void QwtKnob::setSymbol (\fBQwtKnob::Symbol\fP s)"
 
297
.PP
 
298
Set the symbol of the knob. 
 
299
.PP
 
300
\fBSee also:\fP
 
301
.RS 4
 
302
\fBsymbol()\fP 
 
303
.RE
 
304
.PP
 
305
 
 
306
.PP
 
307
Definition at line 108 of file qwt_knob.cpp.
 
308
.SS "void QwtKnob::setTotalAngle (double angle)"
 
309
.PP
 
310
Set the total angle by which the knob can be turned. 
 
311
.PP
 
312
\fBParameters:\fP
 
313
.RS 4
 
314
\fIangle\fP Angle in degrees.
 
315
.RE
 
316
.PP
 
317
The default angle is 270 degrees. It is possible to specify an angle of more than 360 degrees so that the knob can be turned several times around its axis. 
 
318
.PP
 
319
Definition at line 134 of file qwt_knob.cpp.
 
320
.PP
 
321
References scaleDraw(), and QwtRoundScaleDraw::setAngleRange().
 
322
.SS "QSize QwtKnob::sizeHint () const\fC [virtual]\fP"
 
323
.PP
 
324
\fBReturns:\fP
 
325
.RS 4
 
326
\fBminimumSizeHint()\fP 
 
327
.RE
 
328
.PP
 
329
 
 
330
.PP
 
331
Definition at line 526 of file qwt_knob.cpp.
 
332
.PP
 
333
References minimumSizeHint().
 
334
.SS "\fBQwtKnob::Symbol\fP QwtKnob::symbol () const"
 
335
.PP
 
336
\fBReturns:\fP
 
337
.RS 4
 
338
symbol of the knob 
 
339
.RE
 
340
.PP
 
341
\fBSee also:\fP
 
342
.RS 4
 
343
\fBsetSymbol()\fP 
 
344
.RE
 
345
.PP
 
346
 
 
347
.PP
 
348
Definition at line 121 of file qwt_knob.cpp.
 
349
.SS "double QwtKnob::totalAngle () const"
 
350
.PP
 
351
Return the total angle. 
 
352
.PP
 
353
Definition at line 147 of file qwt_knob.cpp.
 
354
 
 
355
.SH "Author"
 
356
.PP 
 
357
Generated automatically by Doxygen for Qwt User's Guide from the source code.