← 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/QwtScaleDiv.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/QwtScaleDiv.3
 
1
.TH "QwtScaleDiv" 3 "22 Mar 2009" "Version 5.1.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtScaleDiv \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
.SH "Detailed Description"
 
10
.PP 
 
11
A class representing a scale division. 
 
12
 
 
13
A scale division consists of its limits and 3 list of tick values qualified as major, medium and minor ticks.
 
14
.PP
 
15
In most cases scale divisions are calculated by a \fBQwtScaleEngine\fP.
 
16
.PP
 
17
\fBSee also:\fP
 
18
.RS 4
 
19
QwtScaleEngine::subDivideInto, QwtScaleEngine::subDivide 
 
20
.RE
 
21
.PP
 
22
 
 
23
.PP
 
24
Definition at line 30 of file qwt_scale_div.h.
 
25
.SS "Public Types"
 
26
 
 
27
.in +1c
 
28
.ti -1c
 
29
.RI "enum \fBTickType\fP { \fBNoTick\fP =  -1, \fBMinorTick\fP, \fBMediumTick\fP, \fBMajorTick\fP, \fBNTickTypes\fP }"
 
30
.br
 
31
.in -1c
 
32
.SS "Public Member Functions"
 
33
 
 
34
.in +1c
 
35
.ti -1c
 
36
.RI "\fBQwtScaleDiv\fP ()"
 
37
.br
 
38
.ti -1c
 
39
.RI "\fBQwtScaleDiv\fP (const \fBQwtDoubleInterval\fP &, QwtValueList[NTickTypes])"
 
40
.br
 
41
.ti -1c
 
42
.RI "\fBQwtScaleDiv\fP (double lBound, double rBound, QwtValueList[NTickTypes])"
 
43
.br
 
44
.ti -1c
 
45
.RI "int \fBoperator==\fP (const \fBQwtScaleDiv\fP &s) const "
 
46
.br
 
47
.ti -1c
 
48
.RI "int \fBoperator!=\fP (const \fBQwtScaleDiv\fP &s) const "
 
49
.br
 
50
.ti -1c
 
51
.RI "void \fBsetInterval\fP (double lBound, double rBound)"
 
52
.br
 
53
.ti -1c
 
54
.RI "void \fBsetInterval\fP (const \fBQwtDoubleInterval\fP &)"
 
55
.br
 
56
.ti -1c
 
57
.RI "\fBQwtDoubleInterval\fP \fBinterval\fP () const"
 
58
.br
 
59
.ti -1c
 
60
.RI "double \fBlBound\fP () const"
 
61
.br
 
62
.ti -1c
 
63
.RI "double \fBhBound\fP () const"
 
64
.br
 
65
.ti -1c
 
66
.RI "double \fBrange\fP () const"
 
67
.br
 
68
.ti -1c
 
69
.RI "bool \fBcontains\fP (double v) const"
 
70
.br
 
71
.ti -1c
 
72
.RI "void \fBsetTicks\fP (int type, const QwtValueList &)"
 
73
.br
 
74
.ti -1c
 
75
.RI "const QwtValueList & \fBticks\fP (int type) const"
 
76
.br
 
77
.ti -1c
 
78
.RI "void \fBinvalidate\fP ()"
 
79
.br
 
80
.ti -1c
 
81
.RI "bool \fBisValid\fP () const"
 
82
.br
 
83
.ti -1c
 
84
.RI "void \fBinvert\fP ()"
 
85
.br
 
86
.in -1c
 
87
.SH "Constructor & Destructor Documentation"
 
88
.PP 
 
89
.SS "QwtScaleDiv::QwtScaleDiv ()\fC [explicit]\fP"
 
90
.PP
 
91
Construct an invalid \fBQwtScaleDiv\fP instance. 
 
92
.PP
 
93
Definition at line 15 of file qwt_scale_div.cpp.
 
94
.SS "QwtScaleDiv::QwtScaleDiv (const \fBQwtDoubleInterval\fP & interval, QwtValueList ticks[NTickTypes])\fC [explicit]\fP"
 
95
.PP
 
96
Construct \fBQwtScaleDiv\fP instance.
 
97
.PP
 
98
\fBParameters:\fP
 
99
.RS 4
 
100
\fIinterval\fP Interval 
 
101
.br
 
102
\fIticks\fP List of major, medium and minor ticks 
 
103
.RE
 
104
.PP
 
105
 
 
106
.PP
 
107
Definition at line 28 of file qwt_scale_div.cpp.
 
108
.PP
 
109
References ticks().
 
110
.SS "QwtScaleDiv::QwtScaleDiv (double lBound, double hBound, QwtValueList ticks[NTickTypes])\fC [explicit]\fP"
 
111
.PP
 
112
Construct \fBQwtScaleDiv\fP instance.
 
113
.PP
 
114
\fBParameters:\fP
 
115
.RS 4
 
116
\fIlBound\fP First interval limit 
 
117
.br
 
118
\fIhBound\fP Second interval limit 
 
119
.br
 
120
\fIticks\fP List of major, medium and minor ticks 
 
121
.RE
 
122
.PP
 
123
 
 
124
.PP
 
125
Definition at line 46 of file qwt_scale_div.cpp.
 
126
.PP
 
127
References ticks().
 
128
.SH "Member Function Documentation"
 
129
.PP 
 
130
.SS "int QwtScaleDiv::operator== (const \fBQwtScaleDiv\fP & other) const"
 
131
.PP
 
132
Equality operator. 
 
133
.PP
 
134
\fBReturns:\fP
 
135
.RS 4
 
136
true if this instance is equal to other 
 
137
.RE
 
138
.PP
 
139
 
 
140
.PP
 
141
Definition at line 70 of file qwt_scale_div.cpp.
 
142
.PP
 
143
References d_hBound, d_isValid, d_lBound, and d_ticks.
 
144
.SS "int QwtScaleDiv::operator!= (const \fBQwtScaleDiv\fP & s) const"
 
145
.PP
 
146
Inequality. 
 
147
.PP
 
148
\fBReturns:\fP
 
149
.RS 4
 
150
true if this instance is not equal to s 
 
151
.RE
 
152
.PP
 
153
 
 
154
.PP
 
155
Definition at line 92 of file qwt_scale_div.cpp.
 
156
.SS "void QwtScaleDiv::setInterval (double lBound, double hBound)\fC [inline]\fP"
 
157
.PP
 
158
Change the interval  left bound  right bound 
 
159
.PP
 
160
Definition at line 84 of file qwt_scale_div.h.
 
161
.PP
 
162
Referenced by setInterval().
 
163
.SS "void QwtScaleDiv::setInterval (const \fBQwtDoubleInterval\fP & interval)"
 
164
.PP
 
165
Change the interval  Interval 
 
166
.PP
 
167
Definition at line 61 of file qwt_scale_div.cpp.
 
168
.PP
 
169
References interval(), QwtDoubleInterval::maxValue(), QwtDoubleInterval::minValue(), and setInterval().
 
170
.SS "\fBQwtDoubleInterval\fP QwtScaleDiv::interval () const\fC [inline]\fP"
 
171
.PP
 
172
\fBReturns:\fP
 
173
.RS 4
 
174
lBound -> hBound 
 
175
.RE
 
176
.PP
 
177
 
 
178
.PP
 
179
Definition at line 93 of file qwt_scale_div.h.
 
180
.PP
 
181
Referenced by setInterval().
 
182
.SS "double QwtScaleDiv::lBound () const\fC [inline]\fP"
 
183
.PP
 
184
\fBReturns:\fP
 
185
.RS 4
 
186
left bound 
 
187
.RE
 
188
.PP
 
189
\fBSee also:\fP
 
190
.RS 4
 
191
\fBQwtScaleDiv::hBound\fP 
 
192
.RE
 
193
.PP
 
194
 
 
195
.PP
 
196
Definition at line 102 of file qwt_scale_div.h.
 
197
.PP
 
198
Referenced by QwtPlot::canvasMap(), QwtPlotPanner::moveCanvas(), QwtPlot::print(), QwtPlotZoomer::rescale(), QwtPlotMagnifier::rescale(), QwtPlotPicker::scaleRect(), and QwtAbstractScaleDraw::setScaleDiv().
 
199
.SS "double QwtScaleDiv::hBound () const\fC [inline]\fP"
 
200
.PP
 
201
\fBReturns:\fP
 
202
.RS 4
 
203
right bound 
 
204
.RE
 
205
.PP
 
206
\fBSee also:\fP
 
207
.RS 4
 
208
\fBQwtScaleDiv::lBound\fP 
 
209
.RE
 
210
.PP
 
211
 
 
212
.PP
 
213
Definition at line 111 of file qwt_scale_div.h.
 
214
.PP
 
215
Referenced by QwtPlot::canvasMap(), QwtPlotPanner::moveCanvas(), QwtPlot::print(), QwtPlotZoomer::rescale(), and QwtAbstractScaleDraw::setScaleDiv().
 
216
.SS "double QwtScaleDiv::range () const\fC [inline]\fP"
 
217
.PP
 
218
\fBReturns:\fP
 
219
.RS 4
 
220
\fBhBound()\fP - \fBlBound()\fP 
 
221
.RE
 
222
.PP
 
223
 
 
224
.PP
 
225
Definition at line 119 of file qwt_scale_div.h.
 
226
.PP
 
227
Referenced by QwtPlotPicker::scaleRect().
 
228
.SS "void QwtScaleDiv::setTicks (int type, const QwtValueList & ticks)"
 
229
.PP
 
230
Assign ticks
 
231
.PP
 
232
\fBParameters:\fP
 
233
.RS 4
 
234
\fItype\fP MinorTick, MediumTick or MajorTick 
 
235
.br
 
236
\fIticks\fP Values of the tick positions 
 
237
.RE
 
238
.PP
 
239
 
 
240
.PP
 
241
Definition at line 149 of file qwt_scale_div.cpp.
 
242
.SS "const QwtValueList & QwtScaleDiv::ticks (int type) const"
 
243
.PP
 
244
Return a list of ticks
 
245
.PP
 
246
\fBParameters:\fP
 
247
.RS 4
 
248
\fItype\fP MinorTick, MediumTick or MajorTick 
 
249
.RE
 
250
.PP
 
251
 
 
252
.PP
 
253
Definition at line 160 of file qwt_scale_div.cpp.
 
254
.PP
 
255
Referenced by QwtRoundScaleDraw::extent(), QwtScaleDraw::getBorderDistHint(), invert(), QwtScaleDraw::maxLabelHeight(), QwtScaleDraw::maxLabelWidth(), QwtScaleDraw::minLabelDist(), QwtScaleDraw::minLength(), QwtScaleDiv(), and QwtPlot::sizeHint().
 
256
.SS "void QwtScaleDiv::invalidate ()"
 
257
.PP
 
258
Invalidate the scale division. 
 
259
.PP
 
260
Definition at line 98 of file qwt_scale_div.cpp.
 
261
.SS "bool QwtScaleDiv::isValid () const"
 
262
.PP
 
263
Check if the scale division is valid. 
 
264
.PP
 
265
Definition at line 110 of file qwt_scale_div.cpp.
 
266
.SS "void QwtScaleDiv::invert ()"
 
267
.PP
 
268
Invert the scale divison. 
 
269
.PP
 
270
Definition at line 127 of file qwt_scale_div.cpp.
 
271
.PP
 
272
References ticks().
 
273
.PP
 
274
Referenced by QwtLog10ScaleEngine::divideScale().
 
275
 
 
276
.SH "Author"
 
277
.PP 
 
278
Generated automatically by Doxygen for Qwt User's Guide from the source code.