← Back to branch summary

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

« back to all changes in this revision

Viewing changes to qwt-5.1.2/doc/man/man3/QwtAbstractScale.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2009-04-12 23:25:58 UTC
  • mfrom: (1.1.4 upstream) (2.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090412232558-3bl06x785yr8xm8u
Tags: 5.1.2-1
* New upstream release.
* Bump compat/debhelper to 7.
* Bump Standards-Version to 3.8.1. No changes needed.
* Invert Maintainers and Uploaders field.
* Fix lintian warnings:
  - dh_clean _k deprecated.
  - missing dependency on libc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.1.2/doc/man/man3/QwtAbstractScale.3
 
1
.TH "QwtAbstractScale" 3 "22 Mar 2009" "Version 5.1.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtAbstractScale \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
Inherited by \fBQwtKnob\fP, \fBQwtSlider\fP, and \fBQwtThermo\fP.
 
10
.PP
 
11
.SH "Detailed Description"
 
12
.PP 
 
13
An abstract base class for classes containing a scale. 
 
14
 
 
15
\fBQwtAbstractScale\fP is used to provide classes with a \fBQwtScaleDraw\fP, and a \fBQwtScaleDiv\fP. The \fBQwtScaleDiv\fP might be set explicitely or calculated by a \fBQwtScaleEngine\fP. 
 
16
.PP
 
17
Definition at line 29 of file qwt_abstract_scale.h.
 
18
.SS "Public Member Functions"
 
19
 
 
20
.in +1c
 
21
.ti -1c
 
22
.RI "\fBQwtAbstractScale\fP ()"
 
23
.br
 
24
.ti -1c
 
25
.RI "virtual \fB~QwtAbstractScale\fP ()"
 
26
.br
 
27
.ti -1c
 
28
.RI "void \fBsetScale\fP (double vmin, double vmax, double step=0.0)"
 
29
.br
 
30
.ti -1c
 
31
.RI "void \fBsetScale\fP (const \fBQwtDoubleInterval\fP &, double step=0.0)"
 
32
.br
 
33
.ti -1c
 
34
.RI "void \fBsetScale\fP (const \fBQwtScaleDiv\fP &s)"
 
35
.br
 
36
.ti -1c
 
37
.RI "void \fBsetAutoScale\fP ()"
 
38
.br
 
39
.ti -1c
 
40
.RI "bool \fBautoScale\fP () const"
 
41
.br
 
42
.ti -1c
 
43
.RI "void \fBsetScaleMaxMajor\fP (int ticks)"
 
44
.br
 
45
.ti -1c
 
46
.RI "int \fBscaleMaxMinor\fP () const"
 
47
.br
 
48
.ti -1c
 
49
.RI "void \fBsetScaleMaxMinor\fP (int ticks)"
 
50
.br
 
51
.ti -1c
 
52
.RI "int \fBscaleMaxMajor\fP () const"
 
53
.br
 
54
.ti -1c
 
55
.RI "void \fBsetScaleEngine\fP (\fBQwtScaleEngine\fP *)"
 
56
.br
 
57
.ti -1c
 
58
.RI "const \fBQwtScaleEngine\fP * \fBscaleEngine\fP () const"
 
59
.br
 
60
.ti -1c
 
61
.RI "\fBQwtScaleEngine\fP * \fBscaleEngine\fP ()"
 
62
.br
 
63
.ti -1c
 
64
.RI "const \fBQwtScaleMap\fP & \fBscaleMap\fP () const"
 
65
.br
 
66
.in -1c
 
67
.SS "Protected Member Functions"
 
68
 
 
69
.in +1c
 
70
.ti -1c
 
71
.RI "void \fBrescale\fP (double vmin, double vmax, double step=0.0)"
 
72
.br
 
73
.ti -1c
 
74
.RI "void \fBsetAbstractScaleDraw\fP (\fBQwtAbstractScaleDraw\fP *)"
 
75
.br
 
76
.ti -1c
 
77
.RI "const \fBQwtAbstractScaleDraw\fP * \fBabstractScaleDraw\fP () const"
 
78
.br
 
79
.ti -1c
 
80
.RI "\fBQwtAbstractScaleDraw\fP * \fBabstractScaleDraw\fP ()"
 
81
.br
 
82
.ti -1c
 
83
.RI "virtual void \fBscaleChange\fP ()"
 
84
.br
 
85
.in -1c
 
86
.SH "Constructor & Destructor Documentation"
 
87
.PP 
 
88
.SS "QwtAbstractScale::QwtAbstractScale ()"
 
89
.PP
 
90
Constructor
 
91
.PP
 
92
Creates a default \fBQwtScaleDraw\fP and a \fBQwtLinearScaleEngine\fP. Autoscaling is enabled, and the stepSize is initialized by 0.0. 
 
93
.PP
 
94
Definition at line 53 of file qwt_abstract_scale.cpp.
 
95
.PP
 
96
References rescale().
 
97
.SS "QwtAbstractScale::~QwtAbstractScale ()\fC [virtual]\fP"
 
98
.PP
 
99
Destructor. 
 
100
.PP
 
101
Definition at line 60 of file qwt_abstract_scale.cpp.
 
102
.SH "Member Function Documentation"
 
103
.PP 
 
104
.SS "void QwtAbstractScale::setScale (double vmin, double vmax, double stepSize = \fC0.0\fP)"
 
105
.PP
 
106
Specify a scale. 
 
107
.PP
 
108
Disable autoscaling and define a scale by an interval and a step size
 
109
.PP
 
110
\fBParameters:\fP
 
111
.RS 4
 
112
\fIvmin\fP lower limit of the scale interval 
 
113
.br
 
114
\fIvmax\fP upper limit of the scale interval 
 
115
.br
 
116
\fIstepSize\fP major step size 
 
117
.RE
 
118
.PP
 
119
\fBSee also:\fP
 
120
.RS 4
 
121
\fBsetAutoScale()\fP 
 
122
.RE
 
123
.PP
 
124
 
 
125
.PP
 
126
Definition at line 75 of file qwt_abstract_scale.cpp.
 
127
.PP
 
128
References rescale().
 
129
.PP
 
130
Referenced by setScale().
 
131
.SS "void QwtAbstractScale::setScale (const \fBQwtDoubleInterval\fP & interval, double stepSize = \fC0.0\fP)"
 
132
.PP
 
133
Specify a scale. 
 
134
.PP
 
135
Disable autoscaling and define a scale by an interval and a step size
 
136
.PP
 
137
\fBParameters:\fP
 
138
.RS 4
 
139
\fIinterval\fP Interval 
 
140
.br
 
141
\fIstepSize\fP major step size 
 
142
.RE
 
143
.PP
 
144
\fBSee also:\fP
 
145
.RS 4
 
146
\fBsetAutoScale()\fP 
 
147
.RE
 
148
.PP
 
149
 
 
150
.PP
 
151
Definition at line 92 of file qwt_abstract_scale.cpp.
 
152
.PP
 
153
References QwtDoubleInterval::maxValue(), QwtDoubleInterval::minValue(), and setScale().
 
154
.SS "void QwtAbstractScale::setScale (const \fBQwtScaleDiv\fP & scaleDiv)"
 
155
.PP
 
156
Specify a scale. 
 
157
.PP
 
158
Disable autoscaling and define a scale by a scale division
 
159
.PP
 
160
\fBParameters:\fP
 
161
.RS 4
 
162
\fIscaleDiv\fP Scale division 
 
163
.RE
 
164
.PP
 
165
\fBSee also:\fP
 
166
.RS 4
 
167
\fBsetAutoScale()\fP 
 
168
.RE
 
169
.PP
 
170
 
 
171
.PP
 
172
Definition at line 107 of file qwt_abstract_scale.cpp.
 
173
.PP
 
174
References scaleChange().
 
175
.SS "void QwtAbstractScale::setAutoScale ()"
 
176
.PP
 
177
Advise the widget to control the scale range internally. 
 
178
.PP
 
179
Autoscaling is on by default. 
 
180
.PP
 
181
\fBSee also:\fP
 
182
.RS 4
 
183
\fBsetScale()\fP, \fBautoScale()\fP 
 
184
.RE
 
185
.PP
 
186
 
 
187
.PP
 
188
Definition at line 147 of file qwt_abstract_scale.cpp.
 
189
.PP
 
190
References scaleChange().
 
191
.SS "bool QwtAbstractScale::autoScale () const"
 
192
.PP
 
193
\fBReturns:\fP
 
194
.RS 4
 
195
\fCtrue\fP if autoscaling is enabled 
 
196
.RE
 
197
.PP
 
198
 
 
199
.PP
 
200
Definition at line 159 of file qwt_abstract_scale.cpp.
 
201
.PP
 
202
Referenced by QwtSlider::rangeChange(), and QwtThermo::setRange().
 
203
.SS "void QwtAbstractScale::setScaleMaxMajor (int ticks)"
 
204
.PP
 
205
Set the maximum number of major tick intervals. 
 
206
.PP
 
207
The scale's major ticks are calculated automatically such that the number of major intervals does not exceed ticks. The default value is 5. 
 
208
.PP
 
209
\fBParameters:\fP
 
210
.RS 4
 
211
\fIticks\fP maximal number of major ticks. 
 
212
.RE
 
213
.PP
 
214
\fBSee also:\fP
 
215
.RS 4
 
216
\fBQwtAbstractScaleDraw\fP 
 
217
.RE
 
218
.PP
 
219
 
 
220
.PP
 
221
Definition at line 173 of file qwt_abstract_scale.cpp.
 
222
.SS "int QwtAbstractScale::scaleMaxMinor () const"
 
223
.PP
 
224
\fBReturns:\fP
 
225
.RS 4
 
226
Max. number of minor tick intervals The default value is 3. 
 
227
.RE
 
228
.PP
 
229
 
 
230
.PP
 
231
Definition at line 204 of file qwt_abstract_scale.cpp.
 
232
.SS "void QwtAbstractScale::setScaleMaxMinor (int ticks)"
 
233
.PP
 
234
Set the maximum number of minor tick intervals. 
 
235
.PP
 
236
The scale's minor ticks are calculated automatically such that the number of minor intervals does not exceed ticks. The default value is 3. 
 
237
.PP
 
238
\fBParameters:\fP
 
239
.RS 4
 
240
\fIticks\fP 
 
241
.RE
 
242
.PP
 
243
\fBSee also:\fP
 
244
.RS 4
 
245
\fBQwtAbstractScaleDraw\fP 
 
246
.RE
 
247
.PP
 
248
 
 
249
.PP
 
250
Definition at line 191 of file qwt_abstract_scale.cpp.
 
251
.SS "int QwtAbstractScale::scaleMaxMajor () const"
 
252
.PP
 
253
\fBReturns:\fP
 
254
.RS 4
 
255
Max. number of major tick intervals The default value is 5. 
 
256
.RE
 
257
.PP
 
258
 
 
259
.PP
 
260
Definition at line 213 of file qwt_abstract_scale.cpp.
 
261
.SS "void QwtAbstractScale::setScaleEngine (\fBQwtScaleEngine\fP * scaleEngine)"
 
262
.PP
 
263
Set a scale engine. 
 
264
.PP
 
265
The scale engine is responsible for calculating the scale division, and in case of auto scaling how to align the scale.
 
266
.PP
 
267
scaleEngine has to be created with new and will be deleted in ~QwtAbstractScale or the next call of setScaleEngine. 
 
268
.PP
 
269
Definition at line 269 of file qwt_abstract_scale.cpp.
 
270
.PP
 
271
References scaleEngine().
 
272
.PP
 
273
Referenced by QwtThermo::setRange().
 
274
.SS "const \fBQwtScaleEngine\fP * QwtAbstractScale::scaleEngine () const"
 
275
.PP
 
276
\fBReturns:\fP
 
277
.RS 4
 
278
Scale engine 
 
279
.RE
 
280
.PP
 
281
\fBSee also:\fP
 
282
.RS 4
 
283
\fBsetScaleEngine()\fP 
 
284
.RE
 
285
.PP
 
286
 
 
287
.PP
 
288
Definition at line 282 of file qwt_abstract_scale.cpp.
 
289
.PP
 
290
Referenced by QwtThermo::setRange(), and setScaleEngine().
 
291
.SS "\fBQwtScaleEngine\fP * QwtAbstractScale::scaleEngine ()"
 
292
.PP
 
293
\fBReturns:\fP
 
294
.RS 4
 
295
Scale engine 
 
296
.RE
 
297
.PP
 
298
\fBSee also:\fP
 
299
.RS 4
 
300
\fBsetScaleEngine()\fP 
 
301
.RE
 
302
.PP
 
303
 
 
304
.PP
 
305
Definition at line 291 of file qwt_abstract_scale.cpp.
 
306
.SS "const \fBQwtScaleMap\fP & QwtAbstractScale::scaleMap () const"
 
307
.PP
 
308
\fBReturns:\fP
 
309
.RS 4
 
310
\fBabstractScaleDraw()\fP->\fBscaleMap()\fP 
 
311
.RE
 
312
.PP
 
313
 
 
314
.PP
 
315
Definition at line 308 of file qwt_abstract_scale.cpp.
 
316
.SS "void QwtAbstractScale::rescale (double vmin, double vmax, double stepSize = \fC0.0\fP)\fC [protected]\fP"
 
317
.PP
 
318
Recalculate the scale division and update the scale draw.
 
319
.PP
 
320
\fBParameters:\fP
 
321
.RS 4
 
322
\fIvmin\fP Lower limit of the scale interval 
 
323
.br
 
324
\fIvmax\fP Upper limit of the scale interval 
 
325
.br
 
326
\fIstepSize\fP Major step size
 
327
.RE
 
328
.PP
 
329
\fBSee also:\fP
 
330
.RS 4
 
331
\fBscaleChange()\fP 
 
332
.RE
 
333
.PP
 
334
 
 
335
.PP
 
336
Definition at line 127 of file qwt_abstract_scale.cpp.
 
337
.PP
 
338
References scaleChange().
 
339
.PP
 
340
Referenced by QwtAbstractScale(), QwtSlider::rangeChange(), QwtThermo::setRange(), and setScale().
 
341
.SS "void QwtAbstractScale::setAbstractScaleDraw (\fBQwtAbstractScaleDraw\fP * scaleDraw)\fC [protected]\fP"
 
342
.PP
 
343
Set a scale draw. 
 
344
.PP
 
345
scaleDraw has to be created with new and will be deleted in ~QwtAbstractScale or the next call of setAbstractScaleDraw. 
 
346
.PP
 
347
Definition at line 224 of file qwt_abstract_scale.cpp.
 
348
.PP
 
349
References QwtAbstractScaleDraw::setScaleDiv().
 
350
.PP
 
351
Referenced by QwtThermo::setScaleDraw(), QwtSlider::setScaleDraw(), and QwtKnob::setScaleDraw().
 
352
.SS "const \fBQwtAbstractScaleDraw\fP * QwtAbstractScale::abstractScaleDraw () const\fC [protected]\fP"
 
353
.PP
 
354
\fBReturns:\fP
 
355
.RS 4
 
356
Scale draw 
 
357
.RE
 
358
.PP
 
359
\fBSee also:\fP
 
360
.RS 4
 
361
\fBsetAbstractScaleDraw()\fP 
 
362
.RE
 
363
.PP
 
364
 
 
365
.PP
 
366
Definition at line 249 of file qwt_abstract_scale.cpp.
 
367
.PP
 
368
Referenced by QwtThermo::scaleDraw(), QwtSlider::scaleDraw(), and QwtKnob::scaleDraw().
 
369
.SS "\fBQwtAbstractScaleDraw\fP * QwtAbstractScale::abstractScaleDraw ()\fC [protected]\fP"
 
370
.PP
 
371
\fBReturns:\fP
 
372
.RS 4
 
373
Scale draw 
 
374
.RE
 
375
.PP
 
376
\fBSee also:\fP
 
377
.RS 4
 
378
\fBsetAbstractScaleDraw()\fP 
 
379
.RE
 
380
.PP
 
381
 
 
382
.PP
 
383
Definition at line 240 of file qwt_abstract_scale.cpp.
 
384
.SS "void QwtAbstractScale::scaleChange ()\fC [protected, virtual]\fP"
 
385
.PP
 
386
Notify changed scale. 
 
387
.PP
 
388
Dummy empty implementation, intended to be overloaded by derived classes 
 
389
.PP
 
390
Reimplemented in \fBQwtSlider\fP, and \fBQwtThermo\fP.
 
391
.PP
 
392
Definition at line 301 of file qwt_abstract_scale.cpp.
 
393
.PP
 
394
Referenced by rescale(), setAutoScale(), and setScale().
 
395
 
 
396
.SH "Author"
 
397
.PP 
 
398
Generated automatically by Doxygen for Qwt User's Guide from the source code.