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
|
.. 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
.. _wx.adv.SplashScreen:
==========================================================================================================================================
|phoenix_title| **wx.adv.SplashScreen**
==========================================================================================================================================
:ref:`wx.adv.SplashScreen` shows a window with a thin border, displaying a bitmap describing your application.
Show it in application initialisation, and then either explicitly destroy it or let it time-out.
Example usage:
::
bitmap = wx.Bitmap('splash16.png', wx.BITMAP_TYPE_PNG)
splash = wx.adv.SplashScreen(bitmap, wx.SPLASH_CENTRE_ON_SCREEN | wx.SPLASH_TIMEOUT,
6000, None, -1, wx.DefaultPosition, wx.DefaultSize,
wx.BORDER_SIMPLE | wx.STAY_ON_TOP)
wx.Yield()
|
|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>SplashScreen</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.adv.SplashScreen_inheritance.png" alt="Inheritance diagram of SplashScreen" 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.Frame.html" title="wx.Frame" alt="" coords="63,392,144,421"/> <area shape="rect" id="node8" href="wx.adv.SplashScreen.html" title="wx.adv.SplashScreen" alt="" coords="26,469,181,499"/> <area shape="rect" id="node2" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="33,315,175,344"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node4" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="25,237,183,267"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node7" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.adv.SplashScreen.__init__` Construct the splash screen passing a bitmap, a style, a timeout, a window id, optional position and size, and a window style.
:meth:`~wx.adv.SplashScreen.GetBitmap` Get the spash screen's bitmap
:meth:`~wx.adv.SplashScreen.GetSplashStyle` Returns the splash style (see :ref:`wx.adv.SplashScreen` for details).
:meth:`~wx.adv.SplashScreen.GetTimeout` Returns the timeout in milliseconds.
:meth:`~wx.adv.SplashScreen.SetBitmap` Set a new bitmap for the splash screen.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.adv.SplashScreen.Bitmap` See :meth:`~wx.adv.SplashScreen.GetBitmap` and :meth:`~wx.adv.SplashScreen.SetBitmap`
:attr:`~wx.adv.SplashScreen.SplashStyle` See :meth:`~wx.adv.SplashScreen.GetSplashStyle`
:attr:`~wx.adv.SplashScreen.Timeout` See :meth:`~wx.adv.SplashScreen.GetTimeout`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.adv.SplashScreen(Frame)
**Possible constructors**::
SplashScreen(bitmap, splashStyle, milliseconds, parent, id=ID_ANY,
pos=DefaultPosition, size=DefaultSize,
style=BORDER_SIMPLE|FRAME_NO_TASKBAR|STAY_ON_TOP)
SplashScreen shows a window with a thin border, displaying a bitmap
describing your application.
.. method:: __init__(self, bitmap, splashStyle, milliseconds, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=BORDER_SIMPLE|FRAME_NO_TASKBAR|STAY_ON_TOP)
Construct the splash screen passing a bitmap, a style, a timeout, a window id, optional position and size, and a window style.
`splashStyle` is a bitlist of some of the following:
- ``wx.adv.SPLASH_CENTRE_ON_PARENT``
- ``wx.adv.SPLASH_CENTRE_ON_SCREEN``
- ``wx.adv.SPLASH_NO_CENTRE``
- ``wx.adv.SPLASH_TIMEOUT``
- ``wx.adv.SPLASH_NO_TIMEOUT``
`milliseconds` is the timeout in milliseconds.
:param `bitmap`:
:type `bitmap`: wx.Bitmap
:param `splashStyle`:
:type `splashStyle`: long
:param `milliseconds`:
:type `milliseconds`: int
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
.. method:: GetBitmap(self)
Get the spash screen's bitmap
:rtype: :ref:`Bitmap`
.. method:: GetSplashStyle(self)
Returns the splash style (see :ref:`wx.adv.SplashScreen` for details).
:rtype: `long`
.. method:: GetTimeout(self)
Returns the timeout in milliseconds.
:rtype: `int`
.. method:: SetBitmap(self, bitmap)
Set a new bitmap for the splash screen.
.. attribute:: Bitmap
See :meth:`~wx.adv.SplashScreen.GetBitmap` and :meth:`~wx.adv.SplashScreen.SetBitmap`
.. attribute:: SplashStyle
See :meth:`~wx.adv.SplashScreen.GetSplashStyle`
.. attribute:: Timeout
See :meth:`~wx.adv.SplashScreen.GetTimeout`
|
