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

« back to all changes in this revision

Viewing changes to qwt-5.0.2/doc/man/man3/QwtSimpleCompassRose.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
* 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:
 
1
.TH "QwtSimpleCompassRose" 3 "11 Jun 2007" "Version 5.0.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtSimpleCompassRose \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
Inherits \fBQwtCompassRose\fP.
 
10
.PP
 
11
.SH "Detailed Description"
 
12
.PP 
 
13
A simple rose for \fBQwtCompass\fP. 
 
14
.PP
 
15
Definition at line 49 of file qwt_compass_rose.h.
 
16
.SS "Public Member Functions"
 
17
 
 
18
.in +1c
 
19
.ti -1c
 
20
.RI "\fBQwtSimpleCompassRose\fP (int numThorns=8, int numThornLevels=-1)"
 
21
.br
 
22
.ti -1c
 
23
.RI "void \fBsetWidth\fP (double w)"
 
24
.br
 
25
.ti -1c
 
26
.RI "double \fBwidth\fP () const "
 
27
.br
 
28
.ti -1c
 
29
.RI "void \fBsetNumThorns\fP (int count)"
 
30
.br
 
31
.ti -1c
 
32
.RI "int \fBnumThorns\fP () const "
 
33
.br
 
34
.ti -1c
 
35
.RI "void \fBsetNumThornLevels\fP (int count)"
 
36
.br
 
37
.ti -1c
 
38
.RI "int \fBnumThornLevels\fP () const "
 
39
.br
 
40
.ti -1c
 
41
.RI "void \fBsetShrinkFactor\fP (double factor)"
 
42
.br
 
43
.ti -1c
 
44
.RI "double \fBshrinkFactor\fP () const "
 
45
.br
 
46
.ti -1c
 
47
.RI "virtual void \fBdraw\fP (QPainter *, const QPoint &center, int radius, double north, QPalette::ColorGroup=QPalette::Active) const "
 
48
.br
 
49
.in -1c
 
50
.SS "Static Public Member Functions"
 
51
 
 
52
.in +1c
 
53
.ti -1c
 
54
.RI "static void \fBdrawRose\fP (QPainter *, const QPalette &, const QPoint &center, int radius, double origin, double width, int numThorns, int numThornLevels, double shrinkFactor)"
 
55
.br
 
56
.in -1c
 
57
.SH "Constructor & Destructor Documentation"
 
58
.PP 
 
59
.SS "QwtSimpleCompassRose::QwtSimpleCompassRose (int numThorns = \fC8\fP, int numThornLevels = \fC-1\fP)"
 
60
.PP
 
61
Constructor
 
62
.PP
 
63
\fBParameters:\fP
 
64
.RS 4
 
65
\fInumThorns\fP Number of thorns 
 
66
.br
 
67
\fInumThornLevels\fP Number of thorn levels 
 
68
.RE
 
69
.PP
 
70
 
 
71
.PP
 
72
Definition at line 61 of file qwt_compass_rose.cpp.
 
73
.PP
 
74
References QwtCompassRose::palette().
 
75
.SH "Member Function Documentation"
 
76
.PP 
 
77
.SS "void QwtSimpleCompassRose::draw (QPainter * painter, const QPoint & center, int radius, double north, QPalette::ColorGroup cg = \fCQPalette::Active\fP) const\fC [virtual]\fP"
 
78
.PP
 
79
Draw the rose
 
80
.PP
 
81
\fBParameters:\fP
 
82
.RS 4
 
83
\fIpainter\fP Painter 
 
84
.br
 
85
\fIcenter\fP Center point 
 
86
.br
 
87
\fIradius\fP Radius of the rose 
 
88
.br
 
89
\fInorth\fP Position 
 
90
.br
 
91
\fIcg\fP Color group 
 
92
.RE
 
93
.PP
 
94
 
 
95
.PP
 
96
Implements \fBQwtCompassRose\fP.
 
97
.PP
 
98
Definition at line 98 of file qwt_compass_rose.cpp.
 
99
.PP
 
100
References drawRose(), and QwtCompassRose::palette().
 
101
.SS "void QwtSimpleCompassRose::drawRose (QPainter * painter, const QPalette & palette, const QPoint & center, int radius, double north, double width, int numThorns, int numThornLevels, double shrinkFactor)\fC [static]\fP"
 
102
.PP
 
103
Draw the rose
 
104
.PP
 
105
\fBParameters:\fP
 
106
.RS 4
 
107
\fIpainter\fP Painter 
 
108
.br
 
109
\fIpalette\fP Palette 
 
110
.br
 
111
\fIcenter\fP Center of the rose 
 
112
.br
 
113
\fIradius\fP Radius of the rose 
 
114
.br
 
115
\fInorth\fP Position pointing to north 
 
116
.br
 
117
\fIwidth\fP Width of the rose 
 
118
.br
 
119
\fInumThorns\fP Number of thorns 
 
120
.br
 
121
\fInumThornLevels\fP Number of thorn levels 
 
122
.br
 
123
\fIshrinkFactor\fP Factor to shrink the thorns with each level 
 
124
.RE
 
125
.PP
 
126
 
 
127
.PP
 
128
Definition at line 136 of file qwt_compass_rose.cpp.
 
129
.PP
 
130
Referenced by draw().
 
131
.SS "int QwtSimpleCompassRose::numThornLevels () const"
 
132
.PP
 
133
\fBReturns:\fP
 
134
.RS 4
 
135
Number of thorn levels 
 
136
.RE
 
137
.PP
 
138
\fBSee also:\fP
 
139
.RS 4
 
140
\fBsetNumThorns()\fP, \fBsetNumThornLevels()\fP 
 
141
.RE
 
142
.PP
 
143
 
 
144
.PP
 
145
Definition at line 278 of file qwt_compass_rose.cpp.
 
146
.SS "int QwtSimpleCompassRose::numThorns () const"
 
147
.PP
 
148
\fBReturns:\fP
 
149
.RS 4
 
150
Number of thorns 
 
151
.RE
 
152
.PP
 
153
\fBSee also:\fP
 
154
.RS 4
 
155
\fBsetNumThorns()\fP, \fBsetNumThornLevels()\fP 
 
156
.RE
 
157
.PP
 
158
 
 
159
.PP
 
160
Definition at line 258 of file qwt_compass_rose.cpp.
 
161
.SS "void QwtSimpleCompassRose::setNumThornLevels (int numThornLevels)"
 
162
.PP
 
163
Set the of thorns levels
 
164
.PP
 
165
\fBParameters:\fP
 
166
.RS 4
 
167
\fInumThornLevels\fP Number of thorns levels 
 
168
.RE
 
169
.PP
 
170
\fBSee also:\fP
 
171
.RS 4
 
172
\fBsetNumThorns()\fP, \fBnumThornLevels()\fP 
 
173
.RE
 
174
.PP
 
175
 
 
176
.PP
 
177
Definition at line 269 of file qwt_compass_rose.cpp.
 
178
.SS "void QwtSimpleCompassRose::setNumThorns (int numThorns)"
 
179
.PP
 
180
Set the number of thorns on one level The number is aligned to a multiple of 4, with a minimum of 4
 
181
.PP
 
182
\fBParameters:\fP
 
183
.RS 4
 
184
\fInumThorns\fP Number of thorns 
 
185
.RE
 
186
.PP
 
187
\fBSee also:\fP
 
188
.RS 4
 
189
\fBnumThorns()\fP, \fBsetNumThornLevels()\fP 
 
190
.RE
 
191
.PP
 
192
 
 
193
.PP
 
194
Definition at line 243 of file qwt_compass_rose.cpp.
 
195
.SS "void QwtSimpleCompassRose::setWidth (double width)"
 
196
.PP
 
197
Set the width of the rose heads. Lower value make thinner heads. The range is limited from 0.03 to 0.4.
 
198
.PP
 
199
\fBParameters:\fP
 
200
.RS 4
 
201
\fIwidth\fP Width 
 
202
.RE
 
203
.PP
 
204
 
 
205
.PP
 
206
Definition at line 226 of file qwt_compass_rose.cpp.
 
207
 
 
208
.SH "Author"
 
209
.PP 
 
210
Generated automatically by Doxygen for Qwt User's Guide from the source code.