1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.analogclock.analogclock
.. highlight:: python
.. _wx.lib.analogclock.analogclock.AnalogClock:
==========================================================================================================================================
|phoenix_title| **wx.lib.analogclock.analogclock.AnalogClock**
==========================================================================================================================================
An analog clock.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>AnalogClock</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.analogclock.analogclock.AnalogClock_inheritance.png" alt="Inheritance diagram of AnalogClock" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="44,5,145,35"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="96,83,207,112"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="91,160,212,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="169,5,251,35"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="107,237,196,267"/> <area shape="rect" id="node6" href="wx.lib.analogclock.analogclock.AnalogClock.html" title="wx.lib.analogclock.analogclock.AnalogClock" alt="" coords="4,315,299,344"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.analogclock.analogclock.AnalogClockWindow`
|
|super_classes| Known Superclasses
==================================
:class:`wx.Window`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.__init__`
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.DoGetBestSize`
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetClockStyle` Returns the current clock style.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetFaceBorderColour` Gets border colours of watch.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetFaceBorderWidth` Gets border width of watch.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetFaceFillColour` Gets fill colours of watch.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetHandBorderColour` Gets border colours of hands.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetHandBorderWidth` Gets border widths of hands.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetHandFillColour` Gets fill colours of hands.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetHandSize` Gets thickness of hands.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetShadowColour` Gets the colour to be used to draw shadows.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetTickBorderColour` Gets border colours of ticks.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetTickBorderWidth` Gets border widths of ticks.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetTickFillColour` Gets fill colours of ticks.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetTickFont` Gets fonts for tick marks when using TICKS_DECIMAL or
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetTickOffset` Gets the distance of tick marks for hours from border.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetTickPolygon` Gets lists of points to be used as polygon shapes
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetTickSize` Gets sizes of ticks.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.GetTickStyle` Gets the tick style(s).
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.Reset` Forces an immediate recalculation and redraw of all clock
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetBackgroundColour` Overriden base wx.Window method.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetClockStyle` Set the clock style, according to the options below.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetFaceBorderColour` Sets border colours of watch.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetFaceBorderWidth` Sets border width of watch.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetFaceFillColour` Sets fill colours of watch.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetForegroundColour` Overriden base wx.Window method. This method sets a colour for
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetHandBorderColour` Sets border colours of hands.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetHandBorderWidth` Sets border widths of hands.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetHandFillColour` Sets fill colours of hands.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetHandSize` Sets thickness of hands.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetShadowColour` Sets the colour to be used to draw shadows.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetTickBorderColour` Sets border colours of ticks.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetTickBorderWidth` Sets border widths of ticks.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetTickFillColour` Sets fill colours of ticks.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetTickFont` Sets fonts for tick marks when using text-based tick styles
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetTickOffset` Sets the distance of tick marks for hours from border.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetTickPolygon` Sets lists of points to be used as polygon shapes
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetTickSize` Sets sizes of ticks.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetTickStyle` Set the tick style, according to the options below.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetWindowStyle` Overriden base wx.Window method.
:meth:`~wx.lib.analogclock.analogclock.AnalogClock.SetWindowStyleFlag` Overriden base wx.Window method.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: AnalogClock(wx.Window)
An analog clock.
.. method:: __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.NO_BORDER, name="AnalogClock", clockStyle=DEFAULT_CLOCK_STYLE, minutesStyle=TICKS_CIRCLE, hoursStyle=TICKS_POLY)
.. method:: DoGetBestSize(self)
.. method:: GetClockStyle(self)
Returns the current clock style.
.. method:: GetFaceBorderColour(self)
Gets border colours of watch.
.. method:: GetFaceBorderWidth(self)
Gets border width of watch.
.. method:: GetFaceFillColour(self)
Gets fill colours of watch.
.. method:: GetHandBorderColour(self, target=ALL)
Gets border colours of hands.
.. method:: GetHandBorderWidth(self, target=ALL)
Gets border widths of hands.
.. method:: GetHandFillColour(self, target=ALL)
Gets fill colours of hands.
.. method:: GetHandSize(self, target=ALL)
Gets thickness of hands.
.. method:: GetShadowColour(self)
Gets the colour to be used to draw shadows.
.. method:: GetTickBorderColour(self, target=ALL)
Gets border colours of ticks.
.. method:: GetTickBorderWidth(self, target=ALL)
Gets border widths of ticks.
.. method:: GetTickFillColour(self, target=ALL)
Gets fill colours of ticks.
.. method:: GetTickFont(self, target=ALL)
Gets fonts for tick marks when using TICKS_DECIMAL or
TICKS_ROMAN style.
.. method:: GetTickOffset(self, target=ALL)
Gets the distance of tick marks for hours from border.
.. method:: GetTickPolygon(self, target=ALL)
Gets lists of points to be used as polygon shapes
when using the TICKS_POLY style.
.. method:: GetTickSize(self, target=ALL)
Gets sizes of ticks.
.. method:: GetTickStyle(self, target=ALL)
Gets the tick style(s).
.. method:: Reset(self)
Forces an immediate recalculation and redraw of all clock
elements.
.. method:: SetBackgroundColour(self, colour)
Overriden base wx.Window method.
.. method:: SetClockStyle(self, style)
Set the clock style, according to the options below.
==================== ================================
SHOW_QUARTERS_TICKS Show marks for hours 3, 6, 9, 12
SHOW_HOURS_TICKS Show marks for all hours
SHOW_MINUTES_TICKS Show marks for minutes
SHOW_HOURS_HAND Show hours hand
SHOW_MINUTES_HAND Show minutes hand
SHOW_SECONDS_HAND Show seconds hand
SHOW_SHADOWS Show hands and marks shadows
ROTATE_TICKS Align tick marks to watch
OVERLAP_TICKS Draw tick marks for minutes even
when they match the hours marks.
==================== ================================
.. method:: SetFaceBorderColour(self, colour)
Sets border colours of watch.
.. method:: SetFaceBorderWidth(self, width)
Sets border width of watch.
.. method:: SetFaceFillColour(self, colour)
Sets fill colours of watch.
.. method:: SetForegroundColour(self, colour)
Overriden base wx.Window method. This method sets a colour for
all hands and ticks at once.
.. method:: SetHandBorderColour(self, colour, target=ALL)
Sets border colours of hands.
.. method:: SetHandBorderWidth(self, width, target=ALL)
Sets border widths of hands.
.. method:: SetHandFillColour(self, colour, target=ALL)
Sets fill colours of hands.
.. method:: SetHandSize(self, size, target=ALL)
Sets thickness of hands.
.. method:: SetShadowColour(self, colour)
Sets the colour to be used to draw shadows.
.. method:: SetTickBorderColour(self, colour, target=ALL)
Sets border colours of ticks.
.. method:: SetTickBorderWidth(self, width, target=ALL)
Sets border widths of ticks.
.. method:: SetTickFillColour(self, colour, target=ALL)
Sets fill colours of ticks.
.. method:: SetTickFont(self, font, target=ALL)
Sets fonts for tick marks when using text-based tick styles
such as TICKS_DECIMAL or TICKS_ROMAN.
.. method:: SetTickOffset(self, offset, target=ALL)
Sets the distance of tick marks for hours from border.
.. method:: SetTickPolygon(self, polygon, target=ALL)
Sets lists of points to be used as polygon shapes
when using the TICKS_POLY style.
.. method:: SetTickSize(self, size, target=ALL)
Sets sizes of ticks.
.. method:: SetTickStyle(self, style, target=ALL)
Set the tick style, according to the options below.
================= ======================================
TICKS_NONE Don't show tick marks.
TICKS_SQUARE Use squares as tick marks.
TICKS_CIRCLE Use circles as tick marks.
TICKS_POLY Use a polygon as tick marks. A
polygon can be passed using
SetTickPolygon, otherwise the default
polygon will be used.
TICKS_DECIMAL Use decimal numbers as tick marks.
TICKS_ROMAN Use Roman numbers as tick marks.
TICKS_BINARY Use binary numbers as tick marks.
TICKS_HEX Use hexadecimal numbers as tick marks.
================= ======================================
.. method:: SetWindowStyle(self, \*args, \*\*kwargs)
Overriden base wx.Window method.
.. method:: SetWindowStyleFlag(self, \*args, \*\*kwargs)
Overriden base wx.Window method.
|
