← 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/QwtSimpleCompassRose.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/QwtSimpleCompassRose.3
 
1
.TH "QwtSimpleCompassRose" 3 "24 May 2008" "Version 5.1.1" "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(), and QwtCompassRose::setPalette().
 
75
.SH "Member Function Documentation"
 
76
.PP 
 
77
.SS "void QwtSimpleCompassRose::setWidth (double width)"
 
78
.PP
 
79
Set the width of the rose heads. Lower value make thinner heads. The range is limited from 0.03 to 0.4.
 
80
.PP
 
81
\fBParameters:\fP
 
82
.RS 4
 
83
\fIwidth\fP Width 
 
84
.RE
 
85
.PP
 
86
 
 
87
.PP
 
88
Definition at line 226 of file qwt_compass_rose.cpp.
 
89
.SS "void QwtSimpleCompassRose::setNumThorns (int numThorns)"
 
90
.PP
 
91
Set the number of thorns on one level The number is aligned to a multiple of 4, with a minimum of 4
 
92
.PP
 
93
\fBParameters:\fP
 
94
.RS 4
 
95
\fInumThorns\fP Number of thorns 
 
96
.RE
 
97
.PP
 
98
\fBSee also:\fP
 
99
.RS 4
 
100
\fBnumThorns()\fP, \fBsetNumThornLevels()\fP 
 
101
.RE
 
102
.PP
 
103
 
 
104
.PP
 
105
Definition at line 243 of file qwt_compass_rose.cpp.
 
106
.SS "int QwtSimpleCompassRose::numThorns () const"
 
107
.PP
 
108
\fBReturns:\fP
 
109
.RS 4
 
110
Number of thorns 
 
111
.RE
 
112
.PP
 
113
\fBSee also:\fP
 
114
.RS 4
 
115
\fBsetNumThorns()\fP, \fBsetNumThornLevels()\fP 
 
116
.RE
 
117
.PP
 
118
 
 
119
.PP
 
120
Definition at line 258 of file qwt_compass_rose.cpp.
 
121
.SS "void QwtSimpleCompassRose::setNumThornLevels (int numThornLevels)"
 
122
.PP
 
123
Set the of thorns levels
 
124
.PP
 
125
\fBParameters:\fP
 
126
.RS 4
 
127
\fInumThornLevels\fP Number of thorns levels 
 
128
.RE
 
129
.PP
 
130
\fBSee also:\fP
 
131
.RS 4
 
132
\fBsetNumThorns()\fP, \fBnumThornLevels()\fP 
 
133
.RE
 
134
.PP
 
135
 
 
136
.PP
 
137
Definition at line 269 of file qwt_compass_rose.cpp.
 
138
.SS "int QwtSimpleCompassRose::numThornLevels () const"
 
139
.PP
 
140
\fBReturns:\fP
 
141
.RS 4
 
142
Number of thorn levels 
 
143
.RE
 
144
.PP
 
145
\fBSee also:\fP
 
146
.RS 4
 
147
\fBsetNumThorns()\fP, \fBsetNumThornLevels()\fP 
 
148
.RE
 
149
.PP
 
150
 
 
151
.PP
 
152
Definition at line 278 of file qwt_compass_rose.cpp.
 
153
.SS "void QwtSimpleCompassRose::draw (QPainter * painter, const QPoint & center, int radius, double north, QPalette::ColorGroup cg = \fCQPalette::Active\fP) const\fC [virtual]\fP"
 
154
.PP
 
155
Draw the rose
 
156
.PP
 
157
\fBParameters:\fP
 
158
.RS 4
 
159
\fIpainter\fP Painter 
 
160
.br
 
161
\fIcenter\fP Center point 
 
162
.br
 
163
\fIradius\fP Radius of the rose 
 
164
.br
 
165
\fInorth\fP Position 
 
166
.br
 
167
\fIcg\fP Color group 
 
168
.RE
 
169
.PP
 
170
 
 
171
.PP
 
172
Implements \fBQwtCompassRose\fP.
 
173
.PP
 
174
Definition at line 98 of file qwt_compass_rose.cpp.
 
175
.PP
 
176
References drawRose(), and QwtCompassRose::palette().
 
177
.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"
 
178
.PP
 
179
Draw the rose
 
180
.PP
 
181
\fBParameters:\fP
 
182
.RS 4
 
183
\fIpainter\fP Painter 
 
184
.br
 
185
\fIpalette\fP Palette 
 
186
.br
 
187
\fIcenter\fP Center of the rose 
 
188
.br
 
189
\fIradius\fP Radius of the rose 
 
190
.br
 
191
\fInorth\fP Position pointing to north 
 
192
.br
 
193
\fIwidth\fP Width of the rose 
 
194
.br
 
195
\fInumThorns\fP Number of thorns 
 
196
.br
 
197
\fInumThornLevels\fP Number of thorn levels 
 
198
.br
 
199
\fIshrinkFactor\fP Factor to shrink the thorns with each level 
 
200
.RE
 
201
.PP
 
202
 
 
203
.PP
 
204
Definition at line 136 of file qwt_compass_rose.cpp.
 
205
.PP
 
206
Referenced by draw().
 
207
 
 
208
.SH "Author"
 
209
.PP 
 
210
Generated automatically by Doxygen for Qwt User's Guide from the source code.