← Back to branch summary

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

« back to all changes in this revision

Viewing changes to qwt-5.1.1/doc/man/man3/QwtCompass.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2008-05-26 10:26:31 UTC
  • mfrom: (1.1.3 upstream) (2.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20080526102631-bp95mfccnrb957nx
Tags: 5.1.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.1.1/doc/man/man3/QwtCompass.3
 
1
.TH "QwtCompass" 3 "24 May 2008" "Version 5.1.1" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtCompass \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
Inherits \fBQwtDial\fP.
 
10
.PP
 
11
.SH "Detailed Description"
 
12
.PP 
 
13
A Compass Widget. 
 
14
 
 
15
\fBQwtCompass\fP is a widget to display and enter directions. It consists of a scale, an optional needle and rose.
 
16
.PP
 
17
.PP
 
18
\fBNote:\fP
 
19
.RS 4
 
20
The examples/dials example shows how to use \fBQwtCompass\fP. 
 
21
.RE
 
22
.PP
 
23
 
 
24
.PP
 
25
Definition at line 48 of file qwt_compass.h.
 
26
.SS "Public Member Functions"
 
27
 
 
28
.in +1c
 
29
.ti -1c
 
30
.RI "\fBQwtCompass\fP (QWidget *parent=NULL)"
 
31
.br
 
32
.ti -1c
 
33
.RI "virtual \fB~QwtCompass\fP ()"
 
34
.br
 
35
.ti -1c
 
36
.RI "void \fBsetRose\fP (\fBQwtCompassRose\fP *rose)"
 
37
.br
 
38
.ti -1c
 
39
.RI "const \fBQwtCompassRose\fP * \fBrose\fP () const"
 
40
.br
 
41
.ti -1c
 
42
.RI "\fBQwtCompassRose\fP * \fBrose\fP ()"
 
43
.br
 
44
.ti -1c
 
45
.RI "const QMap< double, QString > & \fBlabelMap\fP () const"
 
46
.br
 
47
.ti -1c
 
48
.RI "QMap< double, QString > & \fBlabelMap\fP ()"
 
49
.br
 
50
.ti -1c
 
51
.RI "void \fBsetLabelMap\fP (const QMap< double, QString > &map)"
 
52
.br
 
53
.in -1c
 
54
.SS "Protected Member Functions"
 
55
 
 
56
.in +1c
 
57
.ti -1c
 
58
.RI "virtual \fBQwtText\fP \fBscaleLabel\fP (double value) const "
 
59
.br
 
60
.ti -1c
 
61
.RI "virtual void \fBdrawRose\fP (QPainter *, const QPoint &center, int radius, double north, QPalette::ColorGroup) const"
 
62
.br
 
63
.ti -1c
 
64
.RI "virtual void \fBdrawScaleContents\fP (QPainter *, const QPoint &center, int radius) const "
 
65
.br
 
66
.ti -1c
 
67
.RI "virtual void \fBkeyPressEvent\fP (QKeyEvent *)"
 
68
.br
 
69
.in -1c
 
70
.SH "Constructor & Destructor Documentation"
 
71
.PP 
 
72
.SS "QwtCompass::QwtCompass (QWidget * parent = \fCNULL\fP)\fC [explicit]\fP"
 
73
.PP
 
74
Constructor. 
 
75
.PP
 
76
\fBParameters:\fP
 
77
.RS 4
 
78
\fIparent\fP Parent widget
 
79
.RE
 
80
.PP
 
81
Create a compass widget with a scale, no needle and no rose. The default origin is 270.0 with no valid value. It accepts mouse and keyboard inputs and has no step size. The default mode is QwtDial::RotateNeedle. 
 
82
.PP
 
83
Definition at line 50 of file qwt_compass.cpp.
 
84
.SS "QwtCompass::~QwtCompass ()\fC [virtual]\fP"
 
85
.PP
 
86
Destructor. 
 
87
.PP
 
88
Definition at line 77 of file qwt_compass.cpp.
 
89
.SH "Member Function Documentation"
 
90
.PP 
 
91
.SS "void QwtCompass::setRose (\fBQwtCompassRose\fP * rose)"
 
92
.PP
 
93
Set a rose for the compass 
 
94
.PP
 
95
\fBParameters:\fP
 
96
.RS 4
 
97
\fIrose\fP Compass rose 
 
98
.RE
 
99
.PP
 
100
\fBWarning:\fP
 
101
.RS 4
 
102
The rose will be deleted, when a different rose is set or in ~QwtCompass 
 
103
.RE
 
104
.PP
 
105
\fBSee also:\fP
 
106
.RS 4
 
107
\fBrose()\fP 
 
108
.RE
 
109
.PP
 
110
 
 
111
.PP
 
112
Definition at line 157 of file qwt_compass.cpp.
 
113
.PP
 
114
References rose().
 
115
.SS "const \fBQwtCompassRose\fP * QwtCompass::rose () const"
 
116
.PP
 
117
\fBReturns:\fP
 
118
.RS 4
 
119
rose 
 
120
.RE
 
121
.PP
 
122
\fBSee also:\fP
 
123
.RS 4
 
124
\fBsetRose()\fP 
 
125
.RE
 
126
.PP
 
127
 
 
128
.PP
 
129
Definition at line 173 of file qwt_compass.cpp.
 
130
.PP
 
131
Referenced by setRose().
 
132
.SS "\fBQwtCompassRose\fP * QwtCompass::rose ()"
 
133
.PP
 
134
\fBReturns:\fP
 
135
.RS 4
 
136
rose 
 
137
.RE
 
138
.PP
 
139
\fBSee also:\fP
 
140
.RS 4
 
141
\fBsetRose()\fP 
 
142
.RE
 
143
.PP
 
144
 
 
145
.PP
 
146
Definition at line 182 of file qwt_compass.cpp.
 
147
.SS "const QMap< double, QString > & QwtCompass::labelMap () const"
 
148
.PP
 
149
\fBReturns:\fP
 
150
.RS 4
 
151
map, mapping values to labels 
 
152
.RE
 
153
.PP
 
154
\fBSee also:\fP
 
155
.RS 4
 
156
\fBsetLabelMap()\fP 
 
157
.RE
 
158
.PP
 
159
 
 
160
.PP
 
161
Definition at line 256 of file qwt_compass.cpp.
 
162
.SS "QMap< double, QString > & QwtCompass::labelMap ()"
 
163
.PP
 
164
\fBReturns:\fP
 
165
.RS 4
 
166
map, mapping values to labels 
 
167
.RE
 
168
.PP
 
169
\fBSee also:\fP
 
170
.RS 4
 
171
\fBsetLabelMap()\fP 
 
172
.RE
 
173
.PP
 
174
 
 
175
.PP
 
176
Definition at line 265 of file qwt_compass.cpp.
 
177
.SS "void QwtCompass::setLabelMap (const QMap< double, QString > & map)"
 
178
.PP
 
179
Set a map, mapping values to labels. 
 
180
.PP
 
181
\fBParameters:\fP
 
182
.RS 4
 
183
\fImap\fP value to label map
 
184
.RE
 
185
.PP
 
186
The values of the major ticks are found by looking into this map. The default map consists of the labels N, NE, E, SE, S, SW, W, NW.
 
187
.PP
 
188
\fBWarning:\fP
 
189
.RS 4
 
190
The map will have no effect for values that are no major tick values. Major ticks can be changed by QwtScaleDraw::setScale
 
191
.RE
 
192
.PP
 
193
\fBSee also:\fP
 
194
.RS 4
 
195
\fBlabelMap()\fP, \fBscaleDraw()\fP, \fBsetScale()\fP 
 
196
.RE
 
197
.PP
 
198
 
 
199
.PP
 
200
Definition at line 282 of file qwt_compass.cpp.
 
201
.SS "\fBQwtText\fP QwtCompass::scaleLabel (double value) const\fC [protected, virtual]\fP"
 
202
.PP
 
203
Map a value to a corresponding label 
 
204
.PP
 
205
\fBParameters:\fP
 
206
.RS 4
 
207
\fIvalue\fP Value that will be mapped 
 
208
.RE
 
209
.PP
 
210
\fBReturns:\fP
 
211
.RS 4
 
212
Label, or QString::null
 
213
.RE
 
214
.PP
 
215
label() looks in a map for a corresponding label for value or return an null text. 
 
216
.PP
 
217
\fBSee also:\fP
 
218
.RS 4
 
219
\fBlabelMap()\fP, \fBsetLabelMap()\fP 
 
220
.RE
 
221
.PP
 
222
 
 
223
.PP
 
224
Reimplemented from \fBQwtDial\fP.
 
225
.PP
 
226
Definition at line 297 of file qwt_compass.cpp.
 
227
.SS "void QwtCompass::drawRose (QPainter * painter, const QPoint & center, int radius, double north, QPalette::ColorGroup cg) const\fC [protected, virtual]\fP"
 
228
.PP
 
229
Draw the compass rose
 
230
.PP
 
231
\fBParameters:\fP
 
232
.RS 4
 
233
\fIpainter\fP Painter 
 
234
.br
 
235
\fIcenter\fP Center of the compass 
 
236
.br
 
237
\fIradius\fP of the circle, where to paint the rose 
 
238
.br
 
239
\fInorth\fP Direction pointing north, in degrees counter clockwise 
 
240
.br
 
241
\fIcg\fP Color group 
 
242
.RE
 
243
.PP
 
244
 
 
245
.PP
 
246
Definition at line 143 of file qwt_compass.cpp.
 
247
.PP
 
248
Referenced by drawScaleContents().
 
249
.SS "void QwtCompass::drawScaleContents (QPainter *, const QPoint & center, int radius) const\fC [protected, virtual]\fP"
 
250
.PP
 
251
Draw the contents of the scale. 
 
252
.PP
 
253
Reimplemented from \fBQwtDial\fP.
 
254
.PP
 
255
Definition at line 114 of file qwt_compass.cpp.
 
256
.PP
 
257
References drawRose(), QwtAbstractSlider::isValid(), QwtDial::mode(), QwtDial::origin(), and QwtDoubleRange::value().
 
258
.SS "void QwtCompass::keyPressEvent (QKeyEvent * kev)\fC [protected, virtual]\fP"
 
259
.PP
 
260
Handles key events
 
261
.PP
 
262
Beside the keys described in \fBQwtDial::keyPressEvent\fP numbers from 1-9 (without 5) set the direction according to their position on the num pad.
 
263
.PP
 
264
\fBSee also:\fP
 
265
.RS 4
 
266
\fBisReadOnly()\fP 
 
267
.RE
 
268
.PP
 
269
 
 
270
.PP
 
271
Reimplemented from \fBQwtDial\fP.
 
272
.PP
 
273
Definition at line 196 of file qwt_compass.cpp.
 
274
.PP
 
275
References QwtAbstractSlider::isReadOnly(), QwtDial::keyPressEvent(), QwtDial::mode(), QwtDial::origin(), QwtAbstractSlider::setValue(), and QwtDoubleRange::value().
 
276
 
 
277
.SH "Author"
 
278
.PP 
 
279
Generated automatically by Doxygen for Qwt User's Guide from the source code.