← Back to branch summary

~l3on/ubuntu/oneiric/qwt/fix-921430

« back to all changes in this revision

Viewing changes to qwt-5.0.1/doc/man/man3/QwtAnalogClock.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.1/doc/man/man3/QwtAnalogClock.3
1
 
.TH "QwtAnalogClock" 3 "26 Feb 2007" "Version 5.0.1" "Qwt User's Guide" \" -*- nroff -*-
2
 
.ad l
3
 
.nh
4
 
.SH NAME
5
 
QwtAnalogClock \- 
6
 
.SH SYNOPSIS
7
 
.br
8
 
.PP
9
 
Inherits \fBQwtDial\fP.
10
 
.PP
11
 
.SH "Detailed Description"
12
 
.PP 
13
 
An analog clock. 
14
 
 
15
 
.PP
16
 
\fBExample\fP.RS 4
17
 
 
18
 
.PP
19
 
.nf
20
 
#include <qwt_analog_clock.h>
21
 
 
22
 
  QwtAnalogClock *clock = new QwtAnalogClock(...);
23
 
  clock->scaleDraw()->setPenWidth(3);
24
 
  clock->setLineWidth(6);
25
 
  clock->setFrameShadow(QwtDial::Sunken);
26
 
  clock->setTime();
27
 
 
28
 
  // update the clock every second
29
 
  QTimer *timer = new QTimer(clock);
30
 
  timer->connect(timer, SIGNAL(timeout()), clock, SLOT(setCurrentTime()));
31
 
  timer->start(1000);
32
 
 
33
 
  
34
 
.fi
35
 
.PP
36
 
.RE
37
 
.PP
38
 
Qwt is missing a set of good looking hands. Contributions are very welcome.
39
 
.PP
40
 
\fBNote:\fP
41
 
.RS 4
42
 
The examples/dials example shows how to use \fBQwtAnalogClock\fP. 
43
 
.RE
44
 
.PP
45
 
 
46
 
.PP
47
 
Definition at line 45 of file qwt_analog_clock.h.
48
 
.SS "Public Types"
49
 
 
50
 
.in +1c
51
 
.ti -1c
52
 
.RI "enum \fBHand\fP { \fBSecondHand\fP, \fBMinuteHand\fP, \fBHourHand\fP, \fBNHands\fP }"
53
 
.br
54
 
.in -1c
55
 
.SS "Public Slots"
56
 
 
57
 
.in +1c
58
 
.ti -1c
59
 
.RI "void \fBsetCurrentTime\fP ()"
60
 
.br
61
 
.ti -1c
62
 
.RI "void \fBsetTime\fP (const QTime &=QTime::currentTime())"
63
 
.br
64
 
.in -1c
65
 
.SS "Public Member Functions"
66
 
 
67
 
.in +1c
68
 
.ti -1c
69
 
.RI "\fBQwtAnalogClock\fP (QWidget *parent=NULL)"
70
 
.br
71
 
.ti -1c
72
 
.RI "virtual \fB~QwtAnalogClock\fP ()"
73
 
.br
74
 
.ti -1c
75
 
.RI "virtual void \fBsetHand\fP (\fBHand\fP, \fBQwtDialNeedle\fP *)"
76
 
.br
77
 
.ti -1c
78
 
.RI "const \fBQwtDialNeedle\fP * \fBhand\fP (\fBHand\fP) const "
79
 
.br
80
 
.ti -1c
81
 
.RI "\fBQwtDialNeedle\fP * \fBhand\fP (\fBHand\fP)"
82
 
.br
83
 
.in -1c
84
 
.SS "Protected Member Functions"
85
 
 
86
 
.in +1c
87
 
.ti -1c
88
 
.RI "virtual \fBQwtText\fP \fBscaleLabel\fP (double) const "
89
 
.br
90
 
.ti -1c
91
 
.RI "virtual void \fBdrawNeedle\fP (QPainter *, const QPoint &, int radius, double direction, QPalette::ColorGroup) const "
92
 
.br
93
 
.ti -1c
94
 
.RI "virtual void \fBdrawHand\fP (QPainter *, \fBHand\fP, const QPoint &, int radius, double direction, QPalette::ColorGroup) const "
95
 
.br
96
 
.in -1c
97
 
.SH "Member Enumeration Documentation"
98
 
.PP 
99
 
.SS "enum \fBQwtAnalogClock::Hand\fP"
100
 
.PP
101
 
Hand type 
102
 
.PP
103
 
\fBSee also:\fP
104
 
.RS 4
105
 
\fBsetHand()\fP, \fBhand()\fP 
106
 
.RE
107
 
.PP
108
 
 
109
 
.PP
110
 
Definition at line 55 of file qwt_analog_clock.h.
111
 
.SH "Constructor & Destructor Documentation"
112
 
.PP 
113
 
.SS "QwtAnalogClock::QwtAnalogClock (QWidget * parent = \fCNULL\fP)\fC [explicit]\fP"
114
 
.PP
115
 
Constructor 
116
 
.PP
117
 
\fBParameters:\fP
118
 
.RS 4
119
 
\fIparent\fP Parent widget 
120
 
.RE
121
 
.PP
122
 
 
123
 
.PP
124
 
Definition at line 16 of file qwt_analog_clock.cpp.
125
 
.SS "QwtAnalogClock::~QwtAnalogClock ()\fC [virtual]\fP"
126
 
.PP
127
 
Destructor. 
128
 
.PP
129
 
Definition at line 82 of file qwt_analog_clock.cpp.
130
 
.SH "Member Function Documentation"
131
 
.PP 
132
 
.SS "void QwtAnalogClock::drawHand (QPainter * painter, \fBHand\fP hd, const QPoint & center, int radius, double direction, QPalette::ColorGroup cg) const\fC [protected, virtual]\fP"
133
 
.PP
134
 
Draw a clock hand
135
 
.PP
136
 
\fBParameters:\fP
137
 
.RS 4
138
 
\fIpainter\fP Painter 
139
 
.br
140
 
\fIhd\fP Specify the type of hand 
141
 
.br
142
 
\fIcenter\fP Center of the clock 
143
 
.br
144
 
\fIradius\fP Maximum length for the hands 
145
 
.br
146
 
\fIdirection\fP Direction of the hand in degrees, counter clockwise 
147
 
.br
148
 
\fIcg\fP ColorGroup 
149
 
.RE
150
 
.PP
151
 
 
152
 
.PP
153
 
Definition at line 220 of file qwt_analog_clock.cpp.
154
 
.PP
155
 
References QwtDialNeedle::draw(), hand(), and QwtDial::needle().
156
 
.PP
157
 
Referenced by drawNeedle().
158
 
.SS "void QwtAnalogClock::drawNeedle (QPainter * painter, const QPoint & center, int radius, double direction, QPalette::ColorGroup cg) const\fC [protected, virtual]\fP"
159
 
.PP
160
 
Draw the needle. 
161
 
.PP
162
 
A clock has no single needle but three hands instead. drawNeedle translates \fBvalue()\fP into directions for the hands and calls \fBdrawHand()\fP.
163
 
.PP
164
 
\fBParameters:\fP
165
 
.RS 4
166
 
\fIpainter\fP Painter 
167
 
.br
168
 
\fIcenter\fP Center of the clock 
169
 
.br
170
 
\fIradius\fP Maximum length for the hands 
171
 
.br
172
 
\fIdirection\fP Dummy, not used. 
173
 
.br
174
 
\fIcg\fP ColorGroup
175
 
.RE
176
 
.PP
177
 
\fBSee also:\fP
178
 
.RS 4
179
 
\fBQwtAnalogClock::drawHand()\fP 
180
 
.RE
181
 
.PP
182
 
 
183
 
.PP
184
 
Reimplemented from \fBQwtDial\fP.
185
 
.PP
186
 
Definition at line 191 of file qwt_analog_clock.cpp.
187
 
.PP
188
 
References drawHand(), QwtAbstractSlider::isValid(), QwtDial::origin(), and QwtDoubleRange::value().
189
 
.SS "\fBQwtDialNeedle\fP * QwtAnalogClock::hand (\fBHand\fP hd)"
190
 
.PP
191
 
\fBReturns:\fP
192
 
.RS 4
193
 
Clock hand 
194
 
.RE
195
 
.PP
196
 
\fBParameters:\fP
197
 
.RS 4
198
 
\fIhd\fP Specifies the type of hand 
199
 
.RE
200
 
.PP
201
 
\fBSee also:\fP
202
 
.RS 4
203
 
\fBQwtAnalogClock::setHand\fP 
204
 
.RE
205
 
.PP
206
 
 
207
 
.PP
208
 
Definition at line 118 of file qwt_analog_clock.cpp.
209
 
.SS "const \fBQwtDialNeedle\fP * QwtAnalogClock::hand (\fBHand\fP hd) const"
210
 
.PP
211
 
\fBReturns:\fP
212
 
.RS 4
213
 
Clock hand 
214
 
.RE
215
 
.PP
216
 
\fBParameters:\fP
217
 
.RS 4
218
 
\fIhd\fP Specifies the type of hand 
219
 
.RE
220
 
.PP
221
 
\fBSee also:\fP
222
 
.RS 4
223
 
\fBQwtAnalogClock::setHand\fP 
224
 
.RE
225
 
.PP
226
 
 
227
 
.PP
228
 
Definition at line 131 of file qwt_analog_clock.cpp.
229
 
.PP
230
 
Referenced by drawHand().
231
 
.SS "\fBQwtText\fP QwtAnalogClock::scaleLabel (double value) const\fC [protected, virtual]\fP"
232
 
.PP
233
 
Find the scale label for a given value
234
 
.PP
235
 
\fBParameters:\fP
236
 
.RS 4
237
 
\fIvalue\fP Value 
238
 
.RE
239
 
.PP
240
 
\fBReturns:\fP
241
 
.RS 4
242
 
Label 
243
 
.RE
244
 
.PP
245
 
 
246
 
.PP
247
 
Reimplemented from \fBQwtDial\fP.
248
 
.PP
249
 
Definition at line 168 of file qwt_analog_clock.cpp.
250
 
.SS "void QwtAnalogClock::setCurrentTime ()\fC [slot]\fP"
251
 
.PP
252
 
Set the current time. 
253
 
.PP
254
 
This is the same as \fBQwtAnalogClock::setTime()\fP, but Qt < 3.0 can't handle default parameters for slots. 
255
 
.PP
256
 
Definition at line 142 of file qwt_analog_clock.cpp.
257
 
.PP
258
 
References setTime().
259
 
.SS "void QwtAnalogClock::setHand (\fBHand\fP hand, \fBQwtDialNeedle\fP * needle)\fC [virtual]\fP"
260
 
.PP
261
 
Set a clockhand 
262
 
.PP
263
 
\fBParameters:\fP
264
 
.RS 4
265
 
\fIhand\fP Specifies the type of hand 
266
 
.br
267
 
\fIneedle\fP Hand 
268
 
.RE
269
 
.PP
270
 
\fBSee also:\fP
271
 
.RS 4
272
 
\fBQwtAnalogClock::hand()\fP 
273
 
.RE
274
 
.PP
275
 
 
276
 
.PP
277
 
Definition at line 104 of file qwt_analog_clock.cpp.
278
 
.PP
279
 
References QwtDial::needle().
280
 
.SS "void QwtAnalogClock::setTime (const QTime & time = \fCQTime::currentTime()\fP)\fC [slot]\fP"
281
 
.PP
282
 
Set a time 
283
 
.PP
284
 
\fBParameters:\fP
285
 
.RS 4
286
 
\fItime\fP Time to display 
287
 
.RE
288
 
.PP
289
 
 
290
 
.PP
291
 
Definition at line 151 of file qwt_analog_clock.cpp.
292
 
.PP
293
 
References QwtAbstractSlider::setValue().
294
 
.PP
295
 
Referenced by setCurrentTime().
296
 
 
297
 
.SH "Author"
298
 
.PP 
299
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.