
wx.lib.agw.advancedsplash.AdvancedSplash¶AdvancedSplash tries to reproduce the behavior of SplashScreen, with
some enhancements.
This is the main class implementation.
Class Hierarchy¶
Inheritance diagram for class AdvancedSplash:

Control Appearance¶
wxMSW¶
wxMAC¶
wxGTK¶
Known Superclasses¶
Methods Summary¶Default class constructor. |
|
Returns a list of strings and a list of integers containing the styles. |
|
Returns the text displayed on |
|
Gets the colour for the text in |
|
Gets the font for the text in |
|
Returns the text position inside |
|
Handles the |
|
Handles the |
|
Handles the |
|
Handles the timer expiration, and calls the Close() method. |
|
Handles the |
|
Sets |
|
Sets the text to be displayed on |
|
Sets the colour for the text in |
|
Sets the font for the text in |
|
Sets the text position inside |
|
Applies a mask on the bitmap accordingly to user input. |
Class API¶AdvancedSplash(wx.Frame)¶AdvancedSplash tries to reproduce the behavior of SplashScreen, with
some enhancements.
This is the main class implementation.
__init__(self, parent, id=-1, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.FRAME_NO_TASKBAR | wx.FRAME_SHAPED | wx.STAY_ON_TOP, bitmap=None, timeout=5000, agwStyle=AS_TIMEOUT | AS_CENTER_ON_SCREEN, shadowcolour=wx.NullColour)¶Default class constructor.
parent (wx.Window) – parent window;
id (integer) – window identifier. A value of -1 indicates a default value;
pos (tuple or wx.Point) – the control position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform;
size (tuple or wx.Size) – the control size. A value of (-1, -1) indicates a default size,
chosen by either the windowing system or wxPython, depending on platform;
style (integer) – the underlying wx.Frame style;
bitmap (wx.Bitmap) – this must be a valid bitmap, that you may construct using
whatever image file format supported by wxPython. If the file you load
already supports mask/transparency (like png), the transparent areas
will not be drawn on screen, and the AdvancedSplash frame will have
the shape defined only by non-transparent pixels.
If you use other file formats that does not supports transparency, you
can obtain the same effect as above by masking a specific colour in
your wx.Bitmap.
timeout (integer) – if you construct AdvancedSplash using the style AS_TIMEOUT,
AdvancedSplash will be destroyed after timeout milliseconds;
agwStyle (integer) – this value specifies the AdvancedSplash styles:
Window Styles |
Hex Value |
Description |
|---|---|---|
|
0x1 |
|
|
0x2 |
|
|
0x4 |
|
|
0x8 |
|
|
0x10 |
|
|
0x20 |
If the bitmap you pass as input has no transparency, you can choose one colour that will be masked in your bitmap. the final shape of |
shadowcolour (wx.Colour) – if you construct AdvancedSplash using the style
AS_SHADOW_BITMAP, here you can specify the colour that will be masked on
your input bitmap. This has to be a valid wxPython colour.
Exception in the following cases:
The AS_TIMEOUT style is set but timeout is not a positive integer;
The AS_SHADOW_BITMAP style is set but shadowcolour is not a valid wxPython colour;
The AdvancedSplash bitmap is an invalid wx.Bitmap.
GetSplashStyle(self)¶Returns a list of strings and a list of integers containing the styles.
Two Python lists containing the style name and style values for AdvancedSplash.
GetText(self)¶Returns the text displayed on AdvancedSplash.
A string representing the text drawn on top of the AdvancedSplash bitmap.
GetTextColour(self)¶Gets the colour for the text in AdvancedSplash.
An instance of wx.Colour.
GetTextFont(self)¶Gets the font for the text in AdvancedSplash.
GetTextPosition(self)¶Returns the text position inside AdvancedSplash frame.
A tuple containing the text x and y position inside the AdvancedSplash frame.
OnCharEvents(self, event)¶Handles the wx.EVT_CHAR event for AdvancedSplash.
event – a KeyEvent to be processed.
Note
This reproduces the behavior of SplashScreen.
OnCloseWindow(self, event)¶Handles the wx.EVT_CLOSE event for AdvancedSplash.
event – a CloseEvent to be processed.
Note
This reproduces the behavior of SplashScreen.
OnMouseEvents(self, event)¶Handles the wx.EVT_MOUSE_EVENTS events for AdvancedSplash.
event – a MouseEvent to be processed.
Note
This reproduces the behavior of SplashScreen.
OnNotify(self, event)¶Handles the timer expiration, and calls the Close() method.
event – a wx.TimerEvent to be processed.
OnPaint(self, event)¶Handles the wx.EVT_PAINT event for AdvancedSplash.
event – a PaintEvent to be processed.
SetSplashShape(self, event=None)¶Sets AdvancedSplash shape using the region created from the bitmap.
event – a wx.WindowCreateEvent event (GTK only, as GTK supports setting
the window shape only during window creation).
SetText(self, text=None)¶Sets the text to be displayed on AdvancedSplash.
text (string or None) – the text we want to display on top of the bitmap. If text is
set to None, nothing will be drawn on top of the bitmap.
SetTextColour(self, colour=None)¶Sets the colour for the text in AdvancedSplash.
colour (wx.Colour or None) – the text colour to use while drawing the text on top of our
bitmap. If colour is None, then wx.BLACK is used.
SetTextFont(self, font=None)¶Sets the font for the text in AdvancedSplash.
font (wx.Font or None) – the font to use while drawing the text on top of our bitmap. If font
is None, a simple generic font is generated.
SetTextPosition(self, position=None)¶Sets the text position inside AdvancedSplash frame.
position (tuple or None) – the text position inside our bitmap. If position is None,
the text will be placed at the top-left corner.
ShadowBitmap(self, bmp, shadowcolour)¶Applies a mask on the bitmap accordingly to user input.