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

« back to all changes in this revision

Viewing changes to qwt-5.1.2/doc/man/man3/QwtCompassMagnetNeedle.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:
 
1
.TH "QwtCompassMagnetNeedle" 3 "22 Mar 2009" "Version 5.1.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 { \fBArrow\fP, \fBRay\fP, \fBTriangleStyle\fP, \fBThinStyle\fP, \fBStyle1\fP, \fBStyle2\fP, \fBNoSymbol\fP =  -1, \fBEllipse\fP, \fBRect\fP, \fBDiamond\fP, \fBTriangle\fP, \fBDTriangle\fP, \fBUTriangle\fP, \fBLTriangle\fP, \fBRTriangle\fP, \fBCross\fP, \fBXCross\fP, \fBHLine\fP, \fBVLine\fP, \fBStar1\fP, \fBStar2\fP, \fBHexagon\fP, \fBStyleCnt\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(), and QwtDialNeedle::setPalette().
 
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::drawTriangleNeedle (QPainter * painter, const QPalette & palette, QPalette::ColorGroup colorGroup, const QPoint & center, int length, double direction)\fC [static]\fP"
 
117
.PP
 
118
Draw a compass needle
 
119
.PP
 
120
\fBParameters:\fP
 
121
.RS 4
 
122
\fIpainter\fP Painter 
 
123
.br
 
124
\fIpalette\fP Palette 
 
125
.br
 
126
\fIcolorGroup\fP Color group 
 
127
.br
 
128
\fIcenter\fP Center, where the needle starts 
 
129
.br
 
130
\fIlength\fP Length of the needle 
 
131
.br
 
132
\fIdirection\fP Direction 
 
133
.RE
 
134
.PP
 
135
 
 
136
.PP
 
137
Definition at line 317 of file qwt_dial_needle.cpp.
 
138
.PP
 
139
Referenced by draw().
 
140
.SS "void QwtCompassMagnetNeedle::drawThinNeedle (QPainter * painter, const QPalette & palette, QPalette::ColorGroup colorGroup, const QPoint & center, int length, double direction)\fC [static]\fP"
 
141
.PP
 
142
Draw a compass needle
 
143
.PP
 
144
\fBParameters:\fP
 
145
.RS 4
 
146
\fIpainter\fP Painter 
 
147
.br
 
148
\fIpalette\fP Palette 
 
149
.br
 
150
\fIcolorGroup\fP Color group 
 
151
.br
 
152
\fIcenter\fP Center, where the needle starts 
 
153
.br
 
154
\fIlength\fP Length of the needle 
 
155
.br
 
156
\fIdirection\fP Direction 
 
157
.RE
 
158
.PP
 
159
 
 
160
.PP
 
161
Definition at line 383 of file qwt_dial_needle.cpp.
 
162
.PP
 
163
References QwtDialNeedle::drawKnob(), and drawPointer().
 
164
.PP
 
165
Referenced by draw().
 
166
.SS "void QwtCompassMagnetNeedle::drawPointer (QPainter * painter, const QBrush & brush, int colorOffset, const QPoint & center, int length, int width, double direction)\fC [static, protected]\fP"
 
167
.PP
 
168
Draw a compass needle
 
169
.PP
 
170
\fBParameters:\fP
 
171
.RS 4
 
172
\fIpainter\fP Painter 
 
173
.br
 
174
\fIbrush\fP Brush 
 
175
.br
 
176
\fIcolorOffset\fP Color offset 
 
177
.br
 
178
\fIcenter\fP Center, where the needle starts 
 
179
.br
 
180
\fIlength\fP Length of the needle 
 
181
.br
 
182
\fIwidth\fP Width of the needle 
 
183
.br
 
184
\fIdirection\fP Direction 
 
185
.RE
 
186
.PP
 
187
 
 
188
.PP
 
189
Definition at line 419 of file qwt_dial_needle.cpp.
 
190
.PP
 
191
Referenced by drawThinNeedle().
 
192
 
 
193
.SH "Author"
 
194
.PP 
 
195
Generated automatically by Doxygen for Qwt User's Guide from the source code.