File: QwtScaleDiv.3

package info (click to toggle)
qwt 6.1.2-6
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,848 kB
  • ctags: 15,811
  • sloc: cpp: 57,382; makefile: 41
file content (414 lines) | stat: -rw-r--r-- 8,162 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
.TH "QwtScaleDiv" 3 "Thu Dec 11 2014" "Version 6.1.2" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtScaleDiv \- 
.PP
A class representing a scale division\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <qwt_scale_div\&.h>\fP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBTickType\fP { \fBNoTick\fP = -1, \fBMinorTick\fP, \fBMediumTick\fP, \fBMajorTick\fP, \fBNTickTypes\fP }"
.br
.RI "\fIScale tick types\&. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQwtScaleDiv\fP (double \fBlowerBound\fP=0\&.0, double \fBupperBound\fP=0\&.0)"
.br
.ti -1c
.RI "\fBQwtScaleDiv\fP (const \fBQwtInterval\fP &, QList< double >[\fBNTickTypes\fP])"
.br
.ti -1c
.RI "\fBQwtScaleDiv\fP (double \fBlowerBound\fP, double \fBupperBound\fP, QList< double >[\fBNTickTypes\fP])"
.br
.ti -1c
.RI "\fBQwtScaleDiv\fP (double \fBlowerBound\fP, double \fBupperBound\fP, const QList< double > &minorTicks, const QList< double > &mediumTicks, const QList< double > &majorTicks)"
.br
.ti -1c
.RI "bool \fBoperator==\fP (const \fBQwtScaleDiv\fP &) const "
.br
.RI "\fIEquality operator\&. \fP"
.ti -1c
.RI "bool \fBoperator!=\fP (const \fBQwtScaleDiv\fP &) const "
.br
.RI "\fIInequality\&. \fP"
.ti -1c
.RI "void \fBsetInterval\fP (double \fBlowerBound\fP, double \fBupperBound\fP)"
.br
.ti -1c
.RI "void \fBsetInterval\fP (const \fBQwtInterval\fP &)"
.br
.ti -1c
.RI "\fBQwtInterval\fP \fBinterval\fP () const "
.br
.ti -1c
.RI "void \fBsetLowerBound\fP (double)"
.br
.ti -1c
.RI "double \fBlowerBound\fP () const "
.br
.ti -1c
.RI "void \fBsetUpperBound\fP (double)"
.br
.ti -1c
.RI "double \fBupperBound\fP () const "
.br
.ti -1c
.RI "double \fBrange\fP () const "
.br
.ti -1c
.RI "bool \fBcontains\fP (double value) const "
.br
.ti -1c
.RI "void \fBsetTicks\fP (int tickType, const QList< double > &)"
.br
.ti -1c
.RI "QList< double > \fBticks\fP (int tickType) const "
.br
.ti -1c
.RI "bool \fBisEmpty\fP () const "
.br
.RI "\fICheck if the scale division is empty( \fBlowerBound()\fP == \fBupperBound()\fP ) \fP"
.ti -1c
.RI "bool \fBisIncreasing\fP () const "
.br
.RI "\fICheck if the scale division is increasing( \fBlowerBound()\fP <= \fBupperBound()\fP ) \fP"
.ti -1c
.RI "void \fBinvert\fP ()"
.br
.ti -1c
.RI "\fBQwtScaleDiv\fP \fBinverted\fP () const "
.br
.ti -1c
.RI "\fBQwtScaleDiv\fP \fBbounded\fP (double \fBlowerBound\fP, double \fBupperBound\fP) const "
.br
.in -1c
.SH "Detailed Description"
.PP 
A class representing a scale division\&. 

A Qwt scale is defined by its boundaries and 3 list for the positions of the major, medium and minor ticks\&.
.PP
The upperLimit() might be smaller than the lowerLimit() to indicate inverted scales\&.
.PP
Scale divisions can be calculated from a \fBQwtScaleEngine\fP\&.
.PP
\fBSee Also:\fP
.RS 4
\fBQwtScaleEngine::divideScale()\fP, \fBQwtPlot::setAxisScaleDiv()\fP, QwtAbstractSlider::setScaleDiv() 
.RE
.PP

.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBQwtScaleDiv::TickType\fP"

.PP
Scale tick types\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fINoTick \fP\fP
No ticks\&. 
.TP
\fB\fIMinorTick \fP\fP
Minor ticks\&. 
.TP
\fB\fIMediumTick \fP\fP
Medium ticks\&. 
.TP
\fB\fIMajorTick \fP\fP
Major ticks\&. 
.TP
\fB\fINTickTypes \fP\fP
Number of valid tick types\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "QwtScaleDiv::QwtScaleDiv (doublelowerBound = \fC0\&.0\fP, doubleupperBound = \fC0\&.0\fP)\fC [explicit]\fP"
Construct a division without ticks
.PP
\fBParameters:\fP
.RS 4
\fIlowerBound\fP First boundary 
.br
\fIupperBound\fP Second boundary
.RE
.PP
\fBNote:\fP
.RS 4
lowerBound might be greater than upperBound for inverted scales 
.RE
.PP

.SS "QwtScaleDiv::QwtScaleDiv (const \fBQwtInterval\fP &interval, QList< double >ticks[NTickTypes])\fC [explicit]\fP"
Construct a scale division
.PP
\fBParameters:\fP
.RS 4
\fIinterval\fP Interval 
.br
\fIticks\fP List of major, medium and minor ticks 
.RE
.PP

.SS "QwtScaleDiv::QwtScaleDiv (doublelowerBound, doubleupperBound, QList< double >ticks[NTickTypes])\fC [explicit]\fP"
Construct a scale division
.PP
\fBParameters:\fP
.RS 4
\fIlowerBound\fP First boundary 
.br
\fIupperBound\fP Second boundary 
.br
\fIticks\fP List of major, medium and minor ticks
.RE
.PP
\fBNote:\fP
.RS 4
lowerBound might be greater than upperBound for inverted scales 
.RE
.PP

.SS "QwtScaleDiv::QwtScaleDiv (doublelowerBound, doubleupperBound, const QList< double > &minorTicks, const QList< double > &mediumTicks, const QList< double > &majorTicks)\fC [explicit]\fP"
Construct a scale division
.PP
\fBParameters:\fP
.RS 4
\fIlowerBound\fP First boundary 
.br
\fIupperBound\fP Second boundary 
.br
\fIminorTicks\fP List of minor ticks 
.br
\fImediumTicks\fP List medium ticks 
.br
\fImajorTicks\fP List of major ticks
.RE
.PP
\fBNote:\fP
.RS 4
lowerBound might be greater than upperBound for inverted scales 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBQwtScaleDiv\fP QwtScaleDiv::bounded (doublelowerBound, doubleupperBound) const"
Return a scale division with an interval [lowerBound, upperBound] where all ticks outside this interval are removed
.PP
\fBParameters:\fP
.RS 4
\fIlowerBound\fP Lower bound 
.br
\fIupperBound\fP Upper bound
.RE
.PP
\fBReturns:\fP
.RS 4
Scale division with all ticks inside of the given interval
.RE
.PP
\fBNote:\fP
.RS 4
lowerBound might be greater than upperBound for inverted scales 
.RE
.PP

.SS "bool QwtScaleDiv::contains (doublevalue) const"
Return if a value is between \fBlowerBound()\fP and \fBupperBound()\fP
.PP
\fBParameters:\fP
.RS 4
\fIvalue\fP Value 
.RE
.PP
\fBReturns:\fP
.RS 4
true/false 
.RE
.PP

.SS "\fBQwtInterval\fP QwtScaleDiv::interval () const"

.PP
\fBReturns:\fP
.RS 4
lowerBound -> upperBound 
.RE
.PP

.SS "void QwtScaleDiv::invert ()"
Invert the scale division 
.PP
\fBSee Also:\fP
.RS 4
\fBinverted()\fP 
.RE
.PP

.SS "\fBQwtScaleDiv\fP QwtScaleDiv::inverted () const"

.PP
\fBReturns:\fP
.RS 4
A scale division with inverted boundaries and ticks 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBinvert()\fP 
.RE
.PP

.SS "double QwtScaleDiv::lowerBound () const"

.PP
\fBReturns:\fP
.RS 4
First boundary 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBupperBound()\fP 
.RE
.PP

.SS "bool QwtScaleDiv::operator!= (const \fBQwtScaleDiv\fP &other) const"

.PP
Inequality\&. 
.PP
\fBReturns:\fP
.RS 4
true if this instance is not equal to other 
.RE
.PP

.SS "bool QwtScaleDiv::operator== (const \fBQwtScaleDiv\fP &other) const"

.PP
Equality operator\&. 
.PP
\fBReturns:\fP
.RS 4
true if this instance is equal to other 
.RE
.PP

.SS "double QwtScaleDiv::range () const"

.PP
\fBReturns:\fP
.RS 4
\fBupperBound()\fP - \fBlowerBound()\fP 
.RE
.PP

.SS "void QwtScaleDiv::setInterval (doublelowerBound, doubleupperBound)"
Change the interval
.PP
\fBParameters:\fP
.RS 4
\fIlowerBound\fP First boundary 
.br
\fIupperBound\fP Second boundary
.RE
.PP
\fBNote:\fP
.RS 4
lowerBound might be greater than upperBound for inverted scales 
.RE
.PP

.SS "void QwtScaleDiv::setInterval (const \fBQwtInterval\fP &interval)"
Change the interval
.PP
\fBParameters:\fP
.RS 4
\fIinterval\fP Interval 
.RE
.PP

.SS "void QwtScaleDiv::setLowerBound (doublelowerBound)"
Set the first boundary
.PP
\fBParameters:\fP
.RS 4
\fIlowerBound\fP First boundary 
.RE
.PP
\fBSee Also:\fP
.RS 4
lowerBiound(), \fBsetUpperBound()\fP 
.RE
.PP

.SS "void QwtScaleDiv::setTicks (inttype, const QList< double > &ticks)"
Assign ticks
.PP
\fBParameters:\fP
.RS 4
\fItype\fP MinorTick, MediumTick or MajorTick 
.br
\fIticks\fP Values of the tick positions 
.RE
.PP

.SS "void QwtScaleDiv::setUpperBound (doubleupperBound)"
Set the second boundary
.PP
\fBParameters:\fP
.RS 4
\fIupperBound\fP Second boundary 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBupperBound()\fP, \fBsetLowerBound()\fP 
.RE
.PP

.SS "QList< double > QwtScaleDiv::ticks (inttype) const"
Return a list of ticks
.PP
\fBParameters:\fP
.RS 4
\fItype\fP MinorTick, MediumTick or MajorTick 
.RE
.PP
\fBReturns:\fP
.RS 4
Tick list 
.RE
.PP

.SS "double QwtScaleDiv::upperBound () const"

.PP
\fBReturns:\fP
.RS 4
upper bound 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBlowerBound()\fP 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for Qwt User's Guide from the source code\&.