← Back to branch summary

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

« back to all changes in this revision

Viewing changes to qwt-5.0.1/doc/man/man3/QwtRoundScaleDraw.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/QwtRoundScaleDraw.3
1
 
.TH "QwtRoundScaleDraw" 3 "26 Feb 2007" "Version 5.0.1" "Qwt User's Guide" \" -*- nroff -*-
2
 
.ad l
3
 
.nh
4
 
.SH NAME
5
 
QwtRoundScaleDraw \- 
6
 
.SH SYNOPSIS
7
 
.br
8
 
.PP
9
 
Inherits \fBQwtAbstractScaleDraw\fP.
10
 
.PP
11
 
Inherited by \fBQwtDialScaleDraw\fP.
12
 
.PP
13
 
.SH "Detailed Description"
14
 
.PP 
15
 
A class for drawing round scales. 
16
 
 
17
 
\fBQwtRoundScaleDraw\fP can be used to draw round scales. The circle segment can be adjusted by \fBQwtRoundScaleDraw::setAngleRange()\fP. The geometry of the scale can be specified with \fBQwtRoundScaleDraw::moveCenter()\fP and \fBQwtRoundScaleDraw::setRadius()\fP.
18
 
.PP
19
 
After a scale division has been specified as a \fBQwtScaleDiv\fP object using \fBQwtAbstractScaleDraw::setScaleDiv(const QwtScaleDiv &s)\fP, the scale can be drawn with the \fBQwtAbstractScaleDraw::draw()\fP member. 
20
 
.PP
21
 
Definition at line 32 of file qwt_round_scale_draw.h.
22
 
.SS "Public Member Functions"
23
 
 
24
 
.in +1c
25
 
.ti -1c
26
 
.RI "\fBQwtRoundScaleDraw\fP ()"
27
 
.br
28
 
.ti -1c
29
 
.RI "\fBQwtRoundScaleDraw\fP (const \fBQwtRoundScaleDraw\fP &)"
30
 
.br
31
 
.ti -1c
32
 
.RI "virtual \fB~QwtRoundScaleDraw\fP ()"
33
 
.br
34
 
.ti -1c
35
 
.RI "\fBQwtRoundScaleDraw\fP & \fBoperator=\fP (const \fBQwtRoundScaleDraw\fP &other)"
36
 
.br
37
 
.ti -1c
38
 
.RI "void \fBsetRadius\fP (int radius)"
39
 
.br
40
 
.ti -1c
41
 
.RI "int \fBradius\fP () const "
42
 
.br
43
 
.ti -1c
44
 
.RI "void \fBmoveCenter\fP (int x, int y)"
45
 
.br
46
 
.ti -1c
47
 
.RI "void \fBmoveCenter\fP (const QPoint &)"
48
 
.br
49
 
.ti -1c
50
 
.RI "QPoint \fBcenter\fP () const "
51
 
.br
52
 
.ti -1c
53
 
.RI "void \fBsetAngleRange\fP (double angle1, double angle2)"
54
 
.br
55
 
.ti -1c
56
 
.RI "virtual int \fBextent\fP (const QPen &, const QFont &) const "
57
 
.br
58
 
.in -1c
59
 
.SS "Protected Member Functions"
60
 
 
61
 
.in +1c
62
 
.ti -1c
63
 
.RI "virtual void \fBdrawTick\fP (QPainter *p, double val, int len) const "
64
 
.br
65
 
.ti -1c
66
 
.RI "virtual void \fBdrawBackbone\fP (QPainter *p) const "
67
 
.br
68
 
.ti -1c
69
 
.RI "virtual void \fBdrawLabel\fP (QPainter *p, double val) const "
70
 
.br
71
 
.in -1c
72
 
.SH "Constructor & Destructor Documentation"
73
 
.PP 
74
 
.SS "QwtRoundScaleDraw::QwtRoundScaleDraw ()"
75
 
.PP
76
 
Constructor. 
77
 
.PP
78
 
The range of the scale is initialized to [0, 100], The center is set to (50, 50) with a radius of 50. The angle range is set to [-135, 135]. 
79
 
.PP
80
 
Definition at line 46 of file qwt_round_scale_draw.cpp.
81
 
.PP
82
 
References QwtAbstractScaleDraw::scaleMap(), QwtScaleMap::setPaintInterval(), and setRadius().
83
 
.SS "QwtRoundScaleDraw::QwtRoundScaleDraw (const \fBQwtRoundScaleDraw\fP &)"
84
 
.PP
85
 
Copy constructor. 
86
 
.PP
87
 
Definition at line 55 of file qwt_round_scale_draw.cpp.
88
 
.PP
89
 
References d_data.
90
 
.SS "QwtRoundScaleDraw::~QwtRoundScaleDraw ()\fC [virtual]\fP"
91
 
.PP
92
 
Destructor. 
93
 
.PP
94
 
Definition at line 63 of file qwt_round_scale_draw.cpp.
95
 
.SH "Member Function Documentation"
96
 
.PP 
97
 
.SS "QPoint QwtRoundScaleDraw::center () const"
98
 
.PP
99
 
Get the center of the scale. 
100
 
.PP
101
 
Definition at line 113 of file qwt_round_scale_draw.cpp.
102
 
.SS "void QwtRoundScaleDraw::drawBackbone (QPainter * painter) const\fC [protected, virtual]\fP"
103
 
.PP
104
 
Draws the baseline of the scale 
105
 
.PP
106
 
\fBParameters:\fP
107
 
.RS 4
108
 
\fIpainter\fP Painter
109
 
.RE
110
 
.PP
111
 
\fBSee also:\fP
112
 
.RS 4
113
 
\fBdrawTick()\fP, \fBdrawLabel()\fP 
114
 
.RE
115
 
.PP
116
 
 
117
 
.PP
118
 
Implements \fBQwtAbstractScaleDraw\fP.
119
 
.PP
120
 
Definition at line 241 of file qwt_round_scale_draw.cpp.
121
 
.PP
122
 
References QwtAbstractScaleDraw::map(), and radius().
123
 
.SS "void QwtRoundScaleDraw::drawLabel (QPainter * painter, double value) const\fC [protected, virtual]\fP"
124
 
.PP
125
 
Draws the label for a major scale tick
126
 
.PP
127
 
\fBParameters:\fP
128
 
.RS 4
129
 
\fIpainter\fP Painter 
130
 
.br
131
 
\fIvalue\fP Value
132
 
.RE
133
 
.PP
134
 
\fBSee also:\fP
135
 
.RS 4
136
 
\fBdrawTick()\fP, \fBdrawBackbone()\fP 
137
 
.RE
138
 
.PP
139
 
 
140
 
.PP
141
 
Implements \fBQwtAbstractScaleDraw\fP.
142
 
.PP
143
 
Definition at line 162 of file qwt_round_scale_draw.cpp.
144
 
.PP
145
 
References QwtText::draw(), QwtAbstractScaleDraw::hasComponent(), QwtText::isEmpty(), QwtAbstractScaleDraw::label(), QwtAbstractScaleDraw::majTickLength(), QwtAbstractScaleDraw::map(), radius(), QwtAbstractScaleDraw::spacing(), QwtText::textSize(), QwtAbstractScaleDraw::tickLabel(), and QwtScaleMap::transform().
146
 
.SS "void QwtRoundScaleDraw::drawTick (QPainter * painter, double value, int len) const\fC [protected, virtual]\fP"
147
 
.PP
148
 
Draw a tick
149
 
.PP
150
 
\fBParameters:\fP
151
 
.RS 4
152
 
\fIpainter\fP Painter 
153
 
.br
154
 
\fIvalue\fP Value of the tick 
155
 
.br
156
 
\fIlen\fP Lenght of the tick
157
 
.RE
158
 
.PP
159
 
\fBSee also:\fP
160
 
.RS 4
161
 
\fBdrawBackbone()\fP, \fBdrawLabel()\fP 
162
 
.RE
163
 
.PP
164
 
 
165
 
.PP
166
 
Implements \fBQwtAbstractScaleDraw\fP.
167
 
.PP
168
 
Definition at line 207 of file qwt_round_scale_draw.cpp.
169
 
.PP
170
 
References QwtPainter::drawLine(), QwtAbstractScaleDraw::map(), radius(), and QwtScaleMap::transform().
171
 
.SS "int QwtRoundScaleDraw::extent (const QPen & pen, const QFont & font) const\fC [virtual]\fP"
172
 
.PP
173
 
Calculate the extent of the scale
174
 
.PP
175
 
The extent is the distcance between the baseline to the outermost pixel of the scale draw. \fBradius()\fP + \fBextent()\fP is an upper limit for the radius of the bounding circle.
176
 
.PP
177
 
\fBParameters:\fP
178
 
.RS 4
179
 
\fIpen\fP Pen that is used for painting backbone and ticks 
180
 
.br
181
 
\fIfont\fP Font used for painting the labels
182
 
.RE
183
 
.PP
184
 
\fBSee also:\fP
185
 
.RS 4
186
 
\fBsetMinimumExtent()\fP, \fBminimumExtent()\fP 
187
 
.RE
188
 
.PP
189
 
\fBWarning:\fP
190
 
.RS 4
191
 
The implemented algo is not too smart and calculates only an upper limit, that might be a few pixels too large 
192
 
.RE
193
 
.PP
194
 
 
195
 
.PP
196
 
Implements \fBQwtAbstractScaleDraw\fP.
197
 
.PP
198
 
Definition at line 269 of file qwt_round_scale_draw.cpp.
199
 
.PP
200
 
References QwtScaleDiv::contains(), QwtAbstractScaleDraw::hasComponent(), QwtText::isEmpty(), QwtAbstractScaleDraw::label(), QwtAbstractScaleDraw::map(), QwtAbstractScaleDraw::scaleDiv(), QwtText::textSize(), QwtAbstractScaleDraw::tickLabel(), QwtScaleDiv::ticks(), and QwtScaleMap::transform().
201
 
.PP
202
 
Referenced by QwtKnob::minimumSizeHint().
203
 
.SS "void QwtRoundScaleDraw::moveCenter (const QPoint & center)"
204
 
.PP
205
 
Move the center of the scale draw, leaving the radius unchanged
206
 
.PP
207
 
\fBParameters:\fP
208
 
.RS 4
209
 
\fIcenter\fP New center 
210
 
.RE
211
 
.PP
212
 
\fBSee also:\fP
213
 
.RS 4
214
 
\fBsetRadius\fP 
215
 
.RE
216
 
.PP
217
 
 
218
 
.PP
219
 
Definition at line 107 of file qwt_round_scale_draw.cpp.
220
 
.SS "\fBQwtRoundScaleDraw\fP & QwtRoundScaleDraw::operator= (const \fBQwtRoundScaleDraw\fP & other)"
221
 
.PP
222
 
Assignment operator. 
223
 
.PP
224
 
Definition at line 69 of file qwt_round_scale_draw.cpp.
225
 
.PP
226
 
References d_data.
227
 
.SS "int QwtRoundScaleDraw::radius () const"
228
 
.PP
229
 
Get the radius
230
 
.PP
231
 
Radius is the radius of the backbone without ticks and labels.
232
 
.PP
233
 
\fBSee also:\fP
234
 
.RS 4
235
 
\fBsetRadius()\fP, \fBextent()\fP 
236
 
.RE
237
 
.PP
238
 
 
239
 
.PP
240
 
Definition at line 96 of file qwt_round_scale_draw.cpp.
241
 
.PP
242
 
Referenced by drawBackbone(), drawLabel(), and drawTick().
243
 
.SS "void QwtRoundScaleDraw::setAngleRange (double angle1, double angle2)"
244
 
.PP
245
 
Adjust the baseline circle segment for round scales. 
246
 
.PP
247
 
The baseline will be drawn from min(angle1,angle2) to max(angle1, angle2). The default setting is [ -135, 135 ]. An angle of 0 degrees corresponds to the 12 o'clock position, and positive angles count in a clockwise direction. 
248
 
.PP
249
 
\fBParameters:\fP
250
 
.RS 4
251
 
\fIangle1\fP 
252
 
.br
253
 
\fIangle2\fP boundaries of the angle interval in degrees. 
254
 
.RE
255
 
.PP
256
 
\fBWarning:\fP
257
 
.RS 4
258
 
.PD 0
259
 
.IP "\(bu" 2
260
 
The angle range is limited to [-360, 360] degrees. Angles exceeding this range will be clipped. 
261
 
.IP "\(bu" 2
262
 
For angles more than 359 degrees above or below min(angle1, angle2), scale marks will not be drawn. 
263
 
.IP "\(bu" 2
264
 
If you need a counterclockwise scale, use QwtScaleDiv::setRange 
265
 
.PP
266
 
.RE
267
 
.PP
268
 
 
269
 
.PP
270
 
Definition at line 135 of file qwt_round_scale_draw.cpp.
271
 
.PP
272
 
References QwtAbstractScaleDraw::scaleMap(), and QwtScaleMap::setPaintInterval().
273
 
.PP
274
 
Referenced by QwtKnob::setTotalAngle().
275
 
.SS "void QwtRoundScaleDraw::setRadius (int radius)"
276
 
.PP
277
 
Change of radius the scale
278
 
.PP
279
 
Radius is the radius of the backbone without ticks and labels.
280
 
.PP
281
 
\fBParameters:\fP
282
 
.RS 4
283
 
\fIradius\fP New Radius 
284
 
.RE
285
 
.PP
286
 
\fBSee also:\fP
287
 
.RS 4
288
 
\fBmoveCenter\fP 
289
 
.RE
290
 
.PP
291
 
 
292
 
.PP
293
 
Definition at line 84 of file qwt_round_scale_draw.cpp.
294
 
.PP
295
 
Referenced by QwtRoundScaleDraw().
296
 
 
297
 
.SH "Author"
298
 
.PP 
299
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.