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
|
.. 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.BannerWindow:
==========================================================================================================================================
|phoenix_title| **wx.adv.BannerWindow**
==========================================================================================================================================
A simple banner window showing either a bitmap or text.
Banner windows can be used to present some overview of the current window contents to the user in an aesthetically pleasant way. They are typically positioned along the left or top edge of the window (although this class also supports right- and bottom-aligned banners) and show either a bitmap with a logo or a few lines of text on a gradient-filled background.
Using this class is very simple, e.g.: ::
class MyFrame(wx.Frame):
def __init__(self, parent):
# ... create the frame itself ...
wx.Frame.__init__(self, parent)
# Create and initialize the banner.
banner = wx.adv.BannerWindow(self, wx.TOP)
banner.SetText("Welcome to my wonderful program",
" Before doing anything else, you need to connect to "
"the online server.\n"
" Please enter your credentials in the controls below.")
# And position it along the left edge of the window.
sizer = wx.BoxSizer(wx.VERTICAL)
sizer.Add(banner, wx.SizerFlags().Expand())
# ... add the rest of the window contents to the same sizer ...
self.SetSizerAndFit(sizer)
This class is currently implemented generically and so looks the same under all platforms.
.. versionadded:: 2.9.3
|
|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>BannerWindow</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.BannerWindow_inheritance.png" alt="Inheritance diagram of BannerWindow" 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.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node3" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node2" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node4" href="wx.adv.BannerWindow.html" title="wx.adv.BannerWindow" alt="" coords="23,237,184,267"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.adv.BannerWindow.__init__` Default constructor, use :meth:`~BannerWindow.Create` later.
:meth:`~wx.adv.BannerWindow.Create` Really create the banner window for the objects created using the default constructor.
:meth:`~wx.adv.BannerWindow.SetBitmap` Provide the bitmap to use as background.
:meth:`~wx.adv.BannerWindow.SetGradient` Set the colours between which the gradient runs.
:meth:`~wx.adv.BannerWindow.SetText` Set the text to display.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.adv.BannerWindow(Window)
**Possible constructors**::
BannerWindow()
BannerWindow(parent, winid=ID_ANY, dir=LEFT, pos=DefaultPosition,
size=DefaultSize, style=0, name=BannerWindowNameStr)
A simple banner window showing either a bitmap or text.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor, use :meth:`Create` later.
This constructor is only used for two-step creation, if possible, prefer using the constructor below directly instead of using this one and calling :meth:`Create` later.
**~~~**
**__init__** `(self, parent, winid=ID_ANY, dir=LEFT, pos=DefaultPosition, size=DefaultSize, style=0, name=BannerWindowNameStr)`
Full constructor provided for consistency with the other classes only.
Prefer to use the shorter constructor documented above. You should rarely, if ever, need to use non-default values for any other parameters: as the banner window doesn't generate any events, its identifier is not particularly useful; its position and size will be almost always managed by the containing sizer and it doesn't have any specific styles. So only the parent and the banner direction need to be specified.
:param `parent`:
:type `parent`: wx.Window
:param `winid`:
:type `winid`: wx.WindowID
:param `dir`:
:type `dir`: wx.DataObject.Direction
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `name`:
:type `name`: string
**~~~**
.. method:: Create(self, parent, winid=ID_ANY, dir=LEFT, pos=DefaultPosition, size=DefaultSize, style=0, name=BannerWindowNameStr)
Really create the banner window for the objects created using the default constructor.
It's an error to call :meth:`Create` for the objects created using non-default constructor.
:param `parent`:
:type `parent`: wx.Window
:param `winid`:
:type `winid`: wx.WindowID
:param `dir`:
:type `dir`: wx.DataObject.Direction
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `name`:
:type `name`: string
:rtype: `bool`
.. method:: SetBitmap(self, bmp)
Provide the bitmap to use as background.
Notice that ideally the bitmap should be big enough to always cover the entire banner, e.g. for a horizontal banner with ``wx.TOP`` style its width should be bigger than any reasonable window size. Otherwise the bitmap is extended to cover the entire window area with a solid colour taken from the bitmap pixel on the edge in which direction the extension occurs so all bitmap pixels on this edge (top for ``wx.LEFT``, right for ``wx.TOP`` and ``wx.BOTTOM`` and bottom for ``wx.RIGHT``) should have the same colour to avoid jarring discontinuity.
If, on the other hand, the bitmap is bigger than the window size, then it is truncated. For ``wx.LEFT`` orientation the bitmap is truncated from the top, for ``wx.TOP`` and ``wx.BOTTOM``
If no valid background bitmap is specified, the banner draws gradient background but if a valid bitmap is given here, the gradient is not draw and the start and end colours specified for it are ignored.
:param `bmp`: Bitmap to use as background. May be invalid to indicate that no background bitmap should be used.
:type `bmp`: wx.Bitmap
.. method:: SetGradient(self, start, end)
Set the colours between which the gradient runs.
The gradient colours are ignored if :meth:`SetBitmap` is used.
:param `start`:
:type `start`: wx.Colour
:param `end`:
:type `end`: wx.Colour
.. method:: SetText(self, title, message)
Set the text to display.
This is mutually exclusive with :meth:`SetBitmap` .
Title is rendered in bold and should be single line, message can have multiple lines but is not wrapped automatically, include explicit line breaks in the string if you want to have multiple lines.
:param `title`:
:type `title`: string
:param `message`:
:type `message`: string
|
