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
|
.. 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.ticker
.. highlight:: python
.. _wx.lib.ticker.Ticker:
==========================================================================================================================================
|phoenix_title| **wx.lib.ticker.Ticker**
==========================================================================================================================================
|
|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>Ticker</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.ticker.Ticker_inheritance.png" alt="Inheritance diagram of Ticker" 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="5,5,107,35"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="57,83,168,112"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="53,160,173,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="131,5,212,35"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="69,237,157,267"/> <area shape="rect" id="node6" href="wx.Control.html" title="wx.Control" alt="" coords="69,315,157,344"/> <area shape="rect" id="node7" href="wx.lib.ticker.Ticker.html" title="wx.lib.ticker.Ticker" alt="" coords="46,392,180,421"/> </map>
</p>
|
|super_classes| Known Superclasses
==================================
:class:`wx.Control`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.ticker.Ticker.__init__` Default class constructor.
:meth:`~wx.lib.ticker.Ticker.AcceptsFocus` Non-interactive, so don't accept focus
:meth:`~wx.lib.ticker.Ticker.DoGetBestSize` Width we don't care about, height is either -1, or the character
:meth:`~wx.lib.ticker.Ticker.DrawText` Draws the ticker text at the current offset using the provided DC.
:meth:`~wx.lib.ticker.Ticker.GetDirection` Get the set direction.
:meth:`~wx.lib.ticker.Ticker.GetFPS` Get the frames per second speed of the ticker.
:meth:`~wx.lib.ticker.Ticker.GetPPF` Get pixels per frame setting.
:meth:`~wx.lib.ticker.Ticker.GetText` Get the current ticker text.
:meth:`~wx.lib.ticker.Ticker.IsTicking` Is the ticker ticking? ie, is the text moving?
:meth:`~wx.lib.ticker.Ticker.OnErase` Noop because of double buffering
:meth:`~wx.lib.ticker.Ticker.OnPaint` Handles the ``wx.EVT_PAINT`` event for :class:`Ticker`.
:meth:`~wx.lib.ticker.Ticker.OnTick` Handles the ``wx.EVT_TIMER`` event for :class:`Ticker`.
:meth:`~wx.lib.ticker.Ticker.SetDirection` Sets the direction of the ticker: right to left (rtl) or
:meth:`~wx.lib.ticker.Ticker.SetFont` Set the font for the control.
:meth:`~wx.lib.ticker.Ticker.SetFPS` Adjust the update speed of the ticker.
:meth:`~wx.lib.ticker.Ticker.SetPPF` Set the number of pixels per frame the ticker moves - ie,
:meth:`~wx.lib.ticker.Ticker.SetText` Set the ticker text.
:meth:`~wx.lib.ticker.Ticker.ShouldInheritColours` Don't get colours from our parent.
:meth:`~wx.lib.ticker.Ticker.Start` Starts the text moving
:meth:`~wx.lib.ticker.Ticker.Stop` Stop moving the text
:meth:`~wx.lib.ticker.Ticker.UpdateExtent` Updates the cached text extent if needed.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: Ticker(wx.Control)
.. method:: __init__(self, parent, id=-1, text=wx.EmptyString, fgcolor = wx.BLACK, bgcolor = wx.WHITE, start=True, ppf=2, fps=20, direction="rtl", pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.NO_BORDER, name="Ticker" )
Default class constructor.
:param wx.Window `parent`: the parent
:param integer `id`: an identifier for the control: a value of -1 is taken to mean a default
:param string `text`: text in the ticker
:param wx.Colour `fgcolor`: text/foreground color
:param wx.Colour `bgcolor`: background color
:param boolean `start`: if True, the ticker starts immediately
:param int `ppf`: pixels per frame
:param int `fps`: frames per second
:param `direction`: direction of ticking, 'rtl' or 'ltr'
:param wx.Point `pos`: the control position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform
:param `name`: the control name
.. method:: AcceptsFocus(self)
Non-interactive, so don't accept focus
.. method:: DoGetBestSize(self)
Width we don't care about, height is either -1, or the character
height of our text with a little extra padding
.. method:: DrawText(self, dc)
Draws the ticker text at the current offset using the provided DC.
:param wx.DC `dc`: the dc to use.
.. method:: GetDirection(self)
Get the set direction.
.. method:: GetFPS(self)
Get the frames per second speed of the ticker.
.. method:: GetPPF(self)
Get pixels per frame setting.
.. method:: GetText(self)
Get the current ticker text.
.. method:: IsTicking(self)
Is the ticker ticking? ie, is the text moving?
.. method:: OnErase(self, evt)
Noop because of double buffering
Handles the ``wx.EVT_ERASE_BACKGROUND`` event for :class:`Ticker`.
:param `evt`: a :class:`EraseEvent` event to be processed.
.. method:: OnPaint(self, evt)
Handles the ``wx.EVT_PAINT`` event for :class:`Ticker`.
:param `evt`: a :class:`PaintEvent` event to be processed.
.. method:: OnTick(self, evt)
Handles the ``wx.EVT_TIMER`` event for :class:`Ticker`.
:param `evt`: a :class:`TimerEvent` event to be processed.
.. method:: SetDirection(self, dir)
Sets the direction of the ticker: right to left (rtl) or
left to right (ltr).
:param `dir`: the direction 'rtl' or 'ltr'
.. method:: SetFont(self, font)
Set the font for the control.
:param wx.Font `font`: the font to be used.
.. method:: SetFPS(self, fps)
Adjust the update speed of the ticker.
:param int `fps`: frames per second.
.. method:: SetPPF(self, ppf)
Set the number of pixels per frame the ticker moves - ie,
how "jumpy" it is.
:param int `ppf`: the pixels per frame setting.
.. method:: SetText(self, text)
Set the ticker text.
:param string `text`: the ticker text
.. method:: ShouldInheritColours(self)
Don't get colours from our parent.
.. method:: Start(self)
Starts the text moving
.. method:: Stop(self)
Stop moving the text
.. method:: UpdateExtent(self, dc)
Updates the cached text extent if needed.
:param wx.DC `dc`: the dc to use.
|
