← Back to branch summary

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

« back to all changes in this revision

Viewing changes to qwt-5.1.1/doc/man/man3/QwtKnob.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2008-05-26 10:26:31 UTC
  • mfrom: (1.1.3 upstream) (2.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20080526102631-bp95mfccnrb957nx
Tags: 5.1.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.1.1/doc/man/man3/QwtKnob.3
 
1
.TH "QwtKnob" 3 "24 May 2008" "Version 5.1.1" "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 "void QwtKnob::setKnobWidth (int w)"
 
138
.PP
 
139
Change the knob's width. 
 
140
.PP
 
141
The specified width must be >= 5, or it will be clipped. 
 
142
.PP
 
143
\fBParameters:\fP
 
144
.RS 4
 
145
\fIw\fP New width 
 
146
.RE
 
147
.PP
 
148
 
 
149
.PP
 
150
Definition at line 453 of file qwt_knob.cpp.
 
151
.SS "int QwtKnob::knobWidth () const"
 
152
.PP
 
153
Return the width of the knob. 
 
154
.PP
 
155
Definition at line 460 of file qwt_knob.cpp.
 
156
.SS "void QwtKnob::setTotalAngle (double angle)"
 
157
.PP
 
158
Set the total angle by which the knob can be turned. 
 
159
.PP
 
160
\fBParameters:\fP
 
161
.RS 4
 
162
\fIangle\fP Angle in degrees.
 
163
.RE
 
164
.PP
 
165
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. 
 
166
.PP
 
167
Definition at line 134 of file qwt_knob.cpp.
 
168
.PP
 
169
References scaleDraw(), and QwtRoundScaleDraw::setAngleRange().
 
170
.PP
 
171
Referenced by setScaleDraw().
 
172
.SS "double QwtKnob::totalAngle () const"
 
173
.PP
 
174
Return the total angle. 
 
175
.PP
 
176
Definition at line 147 of file qwt_knob.cpp.
 
177
.SS "void QwtKnob::setBorderWidth (int bw)"
 
178
.PP
 
179
Set the knob's border width. 
 
180
.PP
 
181
\fBParameters:\fP
 
182
.RS 4
 
183
\fIbw\fP new border width 
 
184
.RE
 
185
.PP
 
186
 
 
187
.PP
 
188
Definition at line 469 of file qwt_knob.cpp.
 
189
.SS "int QwtKnob::borderWidth () const"
 
190
.PP
 
191
Return the border width. 
 
192
.PP
 
193
Definition at line 476 of file qwt_knob.cpp.
 
194
.SS "void QwtKnob::setSymbol (\fBQwtKnob::Symbol\fP s)"
 
195
.PP
 
196
Set the symbol of the knob. 
 
197
.PP
 
198
\fBSee also:\fP
 
199
.RS 4
 
200
\fBsymbol()\fP 
 
201
.RE
 
202
.PP
 
203
 
 
204
.PP
 
205
Definition at line 108 of file qwt_knob.cpp.
 
206
.SS "\fBQwtKnob::Symbol\fP QwtKnob::symbol () const"
 
207
.PP
 
208
\fBReturns:\fP
 
209
.RS 4
 
210
symbol of the knob 
 
211
.RE
 
212
.PP
 
213
\fBSee also:\fP
 
214
.RS 4
 
215
\fBsetSymbol()\fP 
 
216
.RE
 
217
.PP
 
218
 
 
219
.PP
 
220
Definition at line 121 of file qwt_knob.cpp.
 
221
.SS "QSize QwtKnob::sizeHint () const\fC [virtual]\fP"
 
222
.PP
 
223
\fBReturns:\fP
 
224
.RS 4
 
225
\fBminimumSizeHint()\fP 
 
226
.RE
 
227
.PP
 
228
 
 
229
.PP
 
230
Definition at line 527 of file qwt_knob.cpp.
 
231
.PP
 
232
References minimumSizeHint().
 
233
.SS "QSize QwtKnob::minimumSizeHint () const\fC [virtual]\fP"
 
234
.PP
 
235
Return a minimum size hint. 
 
236
.PP
 
237
\fBWarning:\fP
 
238
.RS 4
 
239
The return value of \fBQwtKnob::minimumSizeHint()\fP depends on the font and the scale. 
 
240
.RE
 
241
.PP
 
242
 
 
243
.PP
 
244
Definition at line 537 of file qwt_knob.cpp.
 
245
.PP
 
246
References QwtRoundScaleDraw::extent(), and scaleDraw().
 
247
.PP
 
248
Referenced by sizeHint().
 
249
.SS "void QwtKnob::setScaleDraw (\fBQwtRoundScaleDraw\fP * scaleDraw)"
 
250
.PP
 
251
Change the scale draw of the knob
 
252
.PP
 
253
For changing the labels of the scales, it is necessary to derive from \fBQwtRoundScaleDraw\fP and overload \fBQwtRoundScaleDraw::label()\fP.
 
254
.PP
 
255
\fBSee also:\fP
 
256
.RS 4
 
257
\fBscaleDraw()\fP 
 
258
.RE
 
259
.PP
 
260
 
 
261
.PP
 
262
Definition at line 161 of file qwt_knob.cpp.
 
263
.PP
 
264
References scaleDraw(), QwtAbstractScale::setAbstractScaleDraw(), and setTotalAngle().
 
265
.SS "const \fBQwtRoundScaleDraw\fP * QwtKnob::scaleDraw () const"
 
266
.PP
 
267
\fBReturns:\fP
 
268
.RS 4
 
269
the scale draw of the knob 
 
270
.RE
 
271
.PP
 
272
\fBSee also:\fP
 
273
.RS 4
 
274
\fBsetScaleDraw()\fP 
 
275
.RE
 
276
.PP
 
277
 
 
278
.PP
 
279
Definition at line 171 of file qwt_knob.cpp.
 
280
.PP
 
281
References QwtAbstractScale::abstractScaleDraw().
 
282
.PP
 
283
Referenced by draw(), minimumSizeHint(), setScaleDraw(), and setTotalAngle().
 
284
.SS "\fBQwtRoundScaleDraw\fP * QwtKnob::scaleDraw ()"
 
285
.PP
 
286
\fBReturns:\fP
 
287
.RS 4
 
288
the scale draw of the knob 
 
289
.RE
 
290
.PP
 
291
\fBSee also:\fP
 
292
.RS 4
 
293
\fBsetScaleDraw()\fP 
 
294
.RE
 
295
.PP
 
296
 
 
297
.PP
 
298
Definition at line 180 of file qwt_knob.cpp.
 
299
.PP
 
300
References QwtAbstractScale::abstractScaleDraw().
 
301
.SS "void QwtKnob::paintEvent (QPaintEvent * e)\fC [protected, virtual]\fP"
 
302
.PP
 
303
Repaint the knob. 
 
304
.PP
 
305
Definition at line 363 of file qwt_knob.cpp.
 
306
.PP
 
307
References draw().
 
308
.SS "void QwtKnob::resizeEvent (QResizeEvent * e)\fC [protected, virtual]\fP"
 
309
.PP
 
310
Qt Resize Event. 
 
311
.PP
 
312
Definition at line 332 of file qwt_knob.cpp.
 
313
.SS "void QwtKnob::draw (QPainter * p, const QRect & ur)\fC [protected]\fP"
 
314
.PP
 
315
Repaint the knob. 
 
316
.PP
 
317
Definition at line 383 of file qwt_knob.cpp.
 
318
.PP
 
319
References QwtAbstractScaleDraw::draw(), QwtPainter::drawFocusRect(), drawKnob(), and scaleDraw().
 
320
.PP
 
321
Referenced by paintEvent().
 
322
.SS "void QwtKnob::drawKnob (QPainter * painter, const QRect & r)\fC [protected]\fP"
 
323
.PP
 
324
Draw the knob. 
 
325
.PP
 
326
\fBParameters:\fP
 
327
.RS 4
 
328
\fIpainter\fP painter 
 
329
.br
 
330
\fIr\fP Bounding rectangle of the knob (without scale) 
 
331
.RE
 
332
.PP
 
333
 
 
334
.PP
 
335
Definition at line 190 of file qwt_knob.cpp.
 
336
.PP
 
337
References drawMarker(), and QwtAbstractSlider::isValid().
 
338
.PP
 
339
Referenced by draw().
 
340
.SS "void QwtKnob::drawMarker (QPainter * p, double arc, const QColor & c)\fC [protected]\fP"
 
341
.PP
 
342
Draw the marker at the knob's front. 
 
343
.PP
 
344
\fBParameters:\fP
 
345
.RS 4
 
346
\fIp\fP Painter 
 
347
.br
 
348
\fIarc\fP Angle of the marker 
 
349
.br
 
350
\fIc\fP Marker color 
 
351
.RE
 
352
.PP
 
353
 
 
354
.PP
 
355
Definition at line 406 of file qwt_knob.cpp.
 
356
.PP
 
357
Referenced by drawKnob().
 
358
 
 
359
.SH "Author"
 
360
.PP 
 
361
Generated automatically by Doxygen for Qwt User's Guide from the source code.