← 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/QwtCompassMagnetNeedle.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/QwtCompassMagnetNeedle.3
 
1
.TH "QwtCompassMagnetNeedle" 3 "11 Jun 2007" "Version 5.0.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtCompassMagnetNeedle \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
Inherits \fBQwtDialNeedle\fP.
 
10
.PP
 
11
.SH "Detailed Description"
 
12
.PP 
 
13
A magnet needle for compass widgets. 
 
14
 
 
15
A magnet needle points to two opposite directions indicating north and south.
 
16
.PP
 
17
The following colors are used:
 
18
.IP "\(bu" 2
 
19
QColorGroup::Light
 
20
.br
 
21
 Used for pointing south
 
22
.IP "\(bu" 2
 
23
QColorGroup::Dark
 
24
.br
 
25
 Used for pointing north
 
26
.IP "\(bu" 2
 
27
QColorGroup::Base
 
28
.br
 
29
 Knob (ThinStyle only)
 
30
.PP
 
31
.PP
 
32
\fBSee also:\fP
 
33
.RS 4
 
34
\fBQwtDial\fP, \fBQwtCompass\fP 
 
35
.RE
 
36
.PP
 
37
 
 
38
.PP
 
39
Definition at line 125 of file qwt_dial_needle.h.
 
40
.SS "Public Types"
 
41
 
 
42
.in +1c
 
43
.ti -1c
 
44
.RI "enum \fBStyle\fP { \fBTriangleStyle\fP, \fBThinStyle\fP }"
 
45
.br
 
46
.in -1c
 
47
.SS "Public Member Functions"
 
48
 
 
49
.in +1c
 
50
.ti -1c
 
51
.RI "\fBQwtCompassMagnetNeedle\fP (\fBStyle\fP=TriangleStyle, const QColor &light=Qt::white, const QColor &dark=Qt::red)"
 
52
.br
 
53
.ti -1c
 
54
.RI "virtual void \fBdraw\fP (QPainter *, const QPoint &, int length, double direction, QPalette::ColorGroup=QPalette::Active) const "
 
55
.br
 
56
.in -1c
 
57
.SS "Static Public Member Functions"
 
58
 
 
59
.in +1c
 
60
.ti -1c
 
61
.RI "static void \fBdrawTriangleNeedle\fP (QPainter *, const QPalette &, QPalette::ColorGroup, const QPoint &, int length, double direction)"
 
62
.br
 
63
.ti -1c
 
64
.RI "static void \fBdrawThinNeedle\fP (QPainter *, const QPalette &, QPalette::ColorGroup, const QPoint &, int length, double direction)"
 
65
.br
 
66
.in -1c
 
67
.SS "Static Protected Member Functions"
 
68
 
 
69
.in +1c
 
70
.ti -1c
 
71
.RI "static void \fBdrawPointer\fP (QPainter *painter, const QBrush &brush, int colorOffset, const QPoint &center, int length, int width, double direction)"
 
72
.br
 
73
.in -1c
 
74
.SH "Member Enumeration Documentation"
 
75
.PP 
 
76
.SS "enum \fBQwtCompassMagnetNeedle::Style\fP"
 
77
.PP
 
78
Style of the needle. 
 
79
.PP
 
80
Definition at line 129 of file qwt_dial_needle.h.
 
81
.SH "Constructor & Destructor Documentation"
 
82
.PP 
 
83
.SS "QwtCompassMagnetNeedle::QwtCompassMagnetNeedle (\fBStyle\fP = \fCTriangleStyle\fP, const QColor & light = \fCQt::white\fP, const QColor & dark = \fCQt::red\fP)"
 
84
.PP
 
85
Constructor. 
 
86
.PP
 
87
Definition at line 265 of file qwt_dial_needle.cpp.
 
88
.PP
 
89
References QwtDialNeedle::palette().
 
90
.SH "Member Function Documentation"
 
91
.PP 
 
92
.SS "void QwtCompassMagnetNeedle::draw (QPainter * painter, const QPoint & center, int length, double direction, QPalette::ColorGroup colorGroup = \fCQPalette::Active\fP) const\fC [virtual]\fP"
 
93
.PP
 
94
Draw the needle
 
95
.PP
 
96
\fBParameters:\fP
 
97
.RS 4
 
98
\fIpainter\fP Painter 
 
99
.br
 
100
\fIcenter\fP Center of the dial, start position for the needle 
 
101
.br
 
102
\fIlength\fP Length of the needle 
 
103
.br
 
104
\fIdirection\fP Direction of the needle, in degrees counter clockwise 
 
105
.br
 
106
\fIcolorGroup\fP Color group, used for painting 
 
107
.RE
 
108
.PP
 
109
 
 
110
.PP
 
111
Implements \fBQwtDialNeedle\fP.
 
112
.PP
 
113
Definition at line 292 of file qwt_dial_needle.cpp.
 
114
.PP
 
115
References drawThinNeedle(), drawTriangleNeedle(), and QwtDialNeedle::palette().
 
116
.SS "void QwtCompassMagnetNeedle::drawPointer (QPainter * painter, const QBrush & brush, int colorOffset, const QPoint & center, int length, int width, double direction)\fC [static, protected]\fP"
 
117
.PP
 
118
Draw a compass needle
 
119
.PP
 
120
\fBParameters:\fP
 
121
.RS 4
 
122
\fIpainter\fP Painter 
 
123
.br
 
124
\fIbrush\fP Brush 
 
125
.br
 
126
\fIcolorOffset\fP Color offset 
 
127
.br
 
128
\fIcenter\fP Center, where the needle starts 
 
129
.br
 
130
\fIlength\fP Length of the needle 
 
131
.br
 
132
\fIwidth\fP Width of the needle 
 
133
.br
 
134
\fIdirection\fP Direction 
 
135
.RE
 
136
.PP
 
137
 
 
138
.PP
 
139
Definition at line 419 of file qwt_dial_needle.cpp.
 
140
.PP
 
141
Referenced by drawThinNeedle().
 
142
.SS "void QwtCompassMagnetNeedle::drawThinNeedle (QPainter * painter, const QPalette & palette, QPalette::ColorGroup colorGroup, const QPoint & center, int length, double direction)\fC [static]\fP"
 
143
.PP
 
144
Draw a compass needle
 
145
.PP
 
146
\fBParameters:\fP
 
147
.RS 4
 
148
\fIpainter\fP Painter 
 
149
.br
 
150
\fIpalette\fP Palette 
 
151
.br
 
152
\fIcolorGroup\fP Color group 
 
153
.br
 
154
\fIcenter\fP Center, where the needle starts 
 
155
.br
 
156
\fIlength\fP Length of the needle 
 
157
.br
 
158
\fIdirection\fP Direction 
 
159
.RE
 
160
.PP
 
161
 
 
162
.PP
 
163
Definition at line 383 of file qwt_dial_needle.cpp.
 
164
.PP
 
165
References QwtDialNeedle::drawKnob(), and drawPointer().
 
166
.PP
 
167
Referenced by draw().
 
168
.SS "void QwtCompassMagnetNeedle::drawTriangleNeedle (QPainter * painter, const QPalette & palette, QPalette::ColorGroup colorGroup, const QPoint & center, int length, double direction)\fC [static]\fP"
 
169
.PP
 
170
Draw a compass needle
 
171
.PP
 
172
\fBParameters:\fP
 
173
.RS 4
 
174
\fIpainter\fP Painter 
 
175
.br
 
176
\fIpalette\fP Palette 
 
177
.br
 
178
\fIcolorGroup\fP Color group 
 
179
.br
 
180
\fIcenter\fP Center, where the needle starts 
 
181
.br
 
182
\fIlength\fP Length of the needle 
 
183
.br
 
184
\fIdirection\fP Direction 
 
185
.RE
 
186
.PP
 
187
 
 
188
.PP
 
189
Definition at line 317 of file qwt_dial_needle.cpp.
 
190
.PP
 
191
Referenced by draw().
 
192
 
 
193
.SH "Author"
 
194
.PP 
 
195
Generated automatically by Doxygen for Qwt User's Guide from the source code.