← 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/QwtAnalogClock.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:
qwt-5.1.1/doc/man/man3/QwtAnalogClock.3
1
 
.TH "QwtAnalogClock" 3 "24 May 2008" "Version 5.1.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::setHand (\fBHand\fP hand, \fBQwtDialNeedle\fP * needle)\fC [virtual]\fP"
133
 
.PP
134
 
Set a clockhand 
135
 
.PP
136
 
\fBParameters:\fP
137
 
.RS 4
138
 
\fIhand\fP Specifies the type of hand 
139
 
.br
140
 
\fIneedle\fP Hand 
141
 
.RE
142
 
.PP
143
 
\fBSee also:\fP
144
 
.RS 4
145
 
\fBQwtAnalogClock::hand()\fP 
146
 
.RE
147
 
.PP
148
 
 
149
 
.PP
150
 
Definition at line 104 of file qwt_analog_clock.cpp.
151
 
.PP
152
 
References QwtDial::needle().
153
 
.SS "const \fBQwtDialNeedle\fP * QwtAnalogClock::hand (\fBHand\fP hd) const"
154
 
.PP
155
 
\fBReturns:\fP
156
 
.RS 4
157
 
Clock hand 
158
 
.RE
159
 
.PP
160
 
\fBParameters:\fP
161
 
.RS 4
162
 
\fIhd\fP Specifies the type of hand 
163
 
.RE
164
 
.PP
165
 
\fBSee also:\fP
166
 
.RS 4
167
 
\fBQwtAnalogClock::setHand\fP 
168
 
.RE
169
 
.PP
170
 
 
171
 
.PP
172
 
Definition at line 131 of file qwt_analog_clock.cpp.
173
 
.PP
174
 
Referenced by drawHand().
175
 
.SS "\fBQwtDialNeedle\fP * QwtAnalogClock::hand (\fBHand\fP hd)"
176
 
.PP
177
 
\fBReturns:\fP
178
 
.RS 4
179
 
Clock hand 
180
 
.RE
181
 
.PP
182
 
\fBParameters:\fP
183
 
.RS 4
184
 
\fIhd\fP Specifies the type of hand 
185
 
.RE
186
 
.PP
187
 
\fBSee also:\fP
188
 
.RS 4
189
 
\fBQwtAnalogClock::setHand\fP 
190
 
.RE
191
 
.PP
192
 
 
193
 
.PP
194
 
Definition at line 118 of file qwt_analog_clock.cpp.
195
 
.SS "void QwtAnalogClock::setCurrentTime ()\fC [slot]\fP"
196
 
.PP
197
 
Set the current time. 
198
 
.PP
199
 
This is the same as \fBQwtAnalogClock::setTime()\fP, but Qt < 3.0 can't handle default parameters for slots. 
200
 
.PP
201
 
Definition at line 142 of file qwt_analog_clock.cpp.
202
 
.PP
203
 
References setTime().
204
 
.SS "void QwtAnalogClock::setTime (const QTime & time = \fCQTime::currentTime()\fP)\fC [slot]\fP"
205
 
.PP
206
 
Set a time 
207
 
.PP
208
 
\fBParameters:\fP
209
 
.RS 4
210
 
\fItime\fP Time to display 
211
 
.RE
212
 
.PP
213
 
 
214
 
.PP
215
 
Definition at line 151 of file qwt_analog_clock.cpp.
216
 
.PP
217
 
References QwtAbstractSlider::setValid(), and QwtAbstractSlider::setValue().
218
 
.PP
219
 
Referenced by setCurrentTime().
220
 
.SS "\fBQwtText\fP QwtAnalogClock::scaleLabel (double value) const\fC [protected, virtual]\fP"
221
 
.PP
222
 
Find the scale label for a given value
223
 
.PP
224
 
\fBParameters:\fP
225
 
.RS 4
226
 
\fIvalue\fP Value 
227
 
.RE
228
 
.PP
229
 
\fBReturns:\fP
230
 
.RS 4
231
 
Label 
232
 
.RE
233
 
.PP
234
 
 
235
 
.PP
236
 
Reimplemented from \fBQwtDial\fP.
237
 
.PP
238
 
Definition at line 168 of file qwt_analog_clock.cpp.
239
 
.SS "void QwtAnalogClock::drawNeedle (QPainter * painter, const QPoint & center, int radius, double direction, QPalette::ColorGroup cg) const\fC [protected, virtual]\fP"
240
 
.PP
241
 
Draw the needle. 
242
 
.PP
243
 
A clock has no single needle but three hands instead. drawNeedle translates \fBvalue()\fP into directions for the hands and calls \fBdrawHand()\fP.
244
 
.PP
245
 
\fBParameters:\fP
246
 
.RS 4
247
 
\fIpainter\fP Painter 
248
 
.br
249
 
\fIcenter\fP Center of the clock 
250
 
.br
251
 
\fIradius\fP Maximum length for the hands 
252
 
.br
253
 
\fIdirection\fP Dummy, not used. 
254
 
.br
255
 
\fIcg\fP ColorGroup
256
 
.RE
257
 
.PP
258
 
\fBSee also:\fP
259
 
.RS 4
260
 
\fBQwtAnalogClock::drawHand()\fP 
261
 
.RE
262
 
.PP
263
 
 
264
 
.PP
265
 
Reimplemented from \fBQwtDial\fP.
266
 
.PP
267
 
Definition at line 191 of file qwt_analog_clock.cpp.
268
 
.PP
269
 
References drawHand(), QwtAbstractSlider::isValid(), QwtDial::origin(), and QwtDoubleRange::value().
270
 
.SS "void QwtAnalogClock::drawHand (QPainter * painter, \fBHand\fP hd, const QPoint & center, int radius, double direction, QPalette::ColorGroup cg) const\fC [protected, virtual]\fP"
271
 
.PP
272
 
Draw a clock hand
273
 
.PP
274
 
\fBParameters:\fP
275
 
.RS 4
276
 
\fIpainter\fP Painter 
277
 
.br
278
 
\fIhd\fP Specify the type of hand 
279
 
.br
280
 
\fIcenter\fP Center of the clock 
281
 
.br
282
 
\fIradius\fP Maximum length for the hands 
283
 
.br
284
 
\fIdirection\fP Direction of the hand in degrees, counter clockwise 
285
 
.br
286
 
\fIcg\fP ColorGroup 
287
 
.RE
288
 
.PP
289
 
 
290
 
.PP
291
 
Definition at line 220 of file qwt_analog_clock.cpp.
292
 
.PP
293
 
References QwtDialNeedle::draw(), hand(), and QwtDial::needle().
294
 
.PP
295
 
Referenced by drawNeedle().
296
 
 
297
 
.SH "Author"
298
 
.PP 
299
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.