.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 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.svg" alt="Inheritance diagram of SplashScreen" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.adv.SplashScreen.html" title="wx.adv.SplashScreen  shows a window with a thin border, displaying a bitmap describing your application." alt="" coords="30,466,213,495"/> <area shape="rect" id="node2" href="wx.Frame.html" title="A frame is a window whose size and position can (usually) be changed by the user." alt="" coords="72,389,171,418"/> <area shape="rect" id="node3" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow  is a common base class for wx.Dialog  and wx.Frame." alt="" coords="34,313,209,341"/> <area shape="rect" id="node4" href="wx.NonOwnedWindow.html" title="Common base class for all non-child windows." alt="" coords="26,236,217,265"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="66,159,177,188"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="55,82,188,111"/> <area shape="rect" id="node7" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,104,34"/> <area shape="rect" id="node8" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="128,5,251,34"/> </map> 
   </p>
   </div>

|


|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.GetClassDefaultAttributes`                           
: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 : Bitmap, splashStyle : int, milliseconds : int,
                    parent : Window, id: int=ID_ANY, pos: Point=DefaultPosition, size:
                    Size=DefaultSize, style: int=BORDER_SIMPLE|FRAME_NO_TASKBAR|STAY_ON_TOP)
                    -> None
       
   
   SplashScreen shows a window with a thin border, displaying a bitmap
   describing your application.



   .. method:: __init__(self, bitmap : Bitmap, splashStyle : int, milliseconds : int, parent : Window, id: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=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




      :rtype: `None`     








   .. method:: GetBitmap(self)

      Get the spash screen's bitmap 

      :rtype: `Bitmap`     








   .. staticmethod:: GetClassDefaultAttributes(variant: WindowVariant=WINDOW_VARIANT_NORMAL)




      :param `variant`: 
      :type `variant`: wx.WindowVariant




      :rtype: `VisualAttributes`     








   .. method:: GetSplashStyle(self)

      Returns the splash style (see :ref:`wx.adv.SplashScreen`  for details). 
                 

      :rtype: `int`








   .. method:: GetTimeout(self)

      Returns the timeout in milliseconds. 
                 

      :rtype: `int`








   .. method:: SetBitmap(self, bitmap: Bitmap)

      Set a new bitmap for the splash screen. 

      :rtype: `None`     








   .. 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`