← Back to branch summary

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

« back to all changes in this revision

Viewing changes to qwt-5.0.2/doc/man/man3/QwtScaleDiv.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.2/doc/man/man3/QwtScaleDiv.3
 
1
.TH "QwtScaleDiv" 3 "11 Jun 2007" "Version 5.0.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 29 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 "double \fBlBound\fP () const "
 
52
.br
 
53
.ti -1c
 
54
.RI "double \fBhBound\fP () const "
 
55
.br
 
56
.ti -1c
 
57
.RI "double \fBrange\fP () const "
 
58
.br
 
59
.ti -1c
 
60
.RI "bool \fBcontains\fP (double v) const "
 
61
.br
 
62
.ti -1c
 
63
.RI "const QwtValueList & \fBticks\fP (int type) const "
 
64
.br
 
65
.ti -1c
 
66
.RI "void \fBinvalidate\fP ()"
 
67
.br
 
68
.ti -1c
 
69
.RI "bool \fBisValid\fP () const "
 
70
.br
 
71
.ti -1c
 
72
.RI "void \fBinvert\fP ()"
 
73
.br
 
74
.in -1c
 
75
.SH "Constructor & Destructor Documentation"
 
76
.PP 
 
77
.SS "QwtScaleDiv::QwtScaleDiv ()\fC [explicit]\fP"
 
78
.PP
 
79
Construct an invalid \fBQwtScaleDiv\fP instance. 
 
80
.PP
 
81
Definition at line 15 of file qwt_scale_div.cpp.
 
82
.SS "QwtScaleDiv::QwtScaleDiv (const \fBQwtDoubleInterval\fP & interval, QwtValueList ticks[NTickTypes])\fC [explicit]\fP"
 
83
.PP
 
84
Construct \fBQwtScaleDiv\fP instance.
 
85
.PP
 
86
\fBParameters:\fP
 
87
.RS 4
 
88
\fIinterval\fP Interval 
 
89
.br
 
90
\fIticks\fP List of major, medium and minor ticks 
 
91
.RE
 
92
.PP
 
93
 
 
94
.PP
 
95
Definition at line 28 of file qwt_scale_div.cpp.
 
96
.PP
 
97
References ticks().
 
98
.SS "QwtScaleDiv::QwtScaleDiv (double lBound, double hBound, QwtValueList ticks[NTickTypes])\fC [explicit]\fP"
 
99
.PP
 
100
Construct \fBQwtScaleDiv\fP instance.
 
101
.PP
 
102
\fBParameters:\fP
 
103
.RS 4
 
104
\fIlBound\fP First interval limit 
 
105
.br
 
106
\fIhBound\fP Second interval limit 
 
107
.br
 
108
\fIticks\fP List of major, medium and minor ticks 
 
109
.RE
 
110
.PP
 
111
 
 
112
.PP
 
113
Definition at line 46 of file qwt_scale_div.cpp.
 
114
.PP
 
115
References ticks().
 
116
.SH "Member Function Documentation"
 
117
.PP 
 
118
.SS "double QwtScaleDiv::hBound () const\fC [inline]\fP"
 
119
.PP
 
120
\fBReturns:\fP
 
121
.RS 4
 
122
right bound 
 
123
.RE
 
124
.PP
 
125
\fBSee also:\fP
 
126
.RS 4
 
127
\fBQwtScaleDiv::lBound\fP 
 
128
.RE
 
129
.PP
 
130
 
 
131
.PP
 
132
Definition at line 86 of file qwt_scale_div.h.
 
133
.PP
 
134
Referenced by QwtPlot::canvasMap(), QwtPlotPanner::moveCanvas(), QwtPlotZoomer::rescale(), and QwtAbstractScaleDraw::setScaleDiv().
 
135
.SS "void QwtScaleDiv::invalidate ()"
 
136
.PP
 
137
Invalidate the scale division. 
 
138
.PP
 
139
Definition at line 89 of file qwt_scale_div.cpp.
 
140
.SS "void QwtScaleDiv::invert ()"
 
141
.PP
 
142
Invert the scale divison. 
 
143
.PP
 
144
Definition at line 118 of file qwt_scale_div.cpp.
 
145
.PP
 
146
References ticks().
 
147
.PP
 
148
Referenced by QwtLog10ScaleEngine::divideScale().
 
149
.SS "bool QwtScaleDiv::isValid () const"
 
150
.PP
 
151
Check if the scale division is valid. 
 
152
.PP
 
153
Definition at line 101 of file qwt_scale_div.cpp.
 
154
.SS "double QwtScaleDiv::lBound () const\fC [inline]\fP"
 
155
.PP
 
156
\fBReturns:\fP
 
157
.RS 4
 
158
left bound 
 
159
.RE
 
160
.PP
 
161
\fBSee also:\fP
 
162
.RS 4
 
163
\fBQwtScaleDiv::hBound\fP 
 
164
.RE
 
165
.PP
 
166
 
 
167
.PP
 
168
Definition at line 77 of file qwt_scale_div.h.
 
169
.PP
 
170
Referenced by QwtPlot::canvasMap(), QwtPlotPanner::moveCanvas(), QwtPlotZoomer::rescale(), QwtPlotMagnifier::rescale(), QwtPlotPicker::scaleRect(), and QwtAbstractScaleDraw::setScaleDiv().
 
171
.SS "int QwtScaleDiv::operator!= (const \fBQwtScaleDiv\fP & s) const"
 
172
.PP
 
173
Inequality. 
 
174
.PP
 
175
\fBReturns:\fP
 
176
.RS 4
 
177
true if this instance is not equal to s 
 
178
.RE
 
179
.PP
 
180
 
 
181
.PP
 
182
Definition at line 83 of file qwt_scale_div.cpp.
 
183
.SS "int QwtScaleDiv::operator== (const \fBQwtScaleDiv\fP & other) const"
 
184
.PP
 
185
Equality operator. 
 
186
.PP
 
187
\fBReturns:\fP
 
188
.RS 4
 
189
true if this instance is equal to other 
 
190
.RE
 
191
.PP
 
192
 
 
193
.PP
 
194
Definition at line 61 of file qwt_scale_div.cpp.
 
195
.PP
 
196
References d_hBound, d_isValid, d_lBound, and d_ticks.
 
197
.SS "double QwtScaleDiv::range () const\fC [inline]\fP"
 
198
.PP
 
199
\fBReturns:\fP
 
200
.RS 4
 
201
\fBhBound()\fP - \fBlBound()\fP 
 
202
.RE
 
203
.PP
 
204
 
 
205
.PP
 
206
Definition at line 94 of file qwt_scale_div.h.
 
207
.PP
 
208
Referenced by QwtPlotPicker::scaleRect().
 
209
.SS "const QwtValueList & QwtScaleDiv::ticks (int type) const"
 
210
.PP
 
211
Return a list of ticks
 
212
.PP
 
213
\fBParameters:\fP
 
214
.RS 4
 
215
\fItype\fP MinorTick, MediumTick or MajorTick 
 
216
.RE
 
217
.PP
 
218
 
 
219
.PP
 
220
Definition at line 139 of file qwt_scale_div.cpp.
 
221
.PP
 
222
Referenced by QwtRoundScaleDraw::extent(), QwtScaleDraw::getBorderDistHint(), invert(), QwtScaleDraw::maxLabelHeight(), QwtScaleDraw::maxLabelWidth(), QwtScaleDraw::minLabelDist(), QwtScaleDraw::minLength(), QwtScaleDiv(), and QwtPlot::sizeHint().
 
223
 
 
224
.SH "Author"
 
225
.PP 
 
226
Generated automatically by Doxygen for Qwt User's Guide from the source code.