.. include:: headings.inc



.. currentmodule:: adv



.. _adv.SplashScreen:

==========================================================================================================================================
|phoenix_title|  **SplashScreen**
==========================================================================================================================================

:ref:`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.SplashScreen(bitmap, wx.SPLASH_CENTRE_ON_SCREEN|.SPLASH_TIMEOUT,
                               6000, None, -1, wx.DefaultPosition, wx.DefaultSize,
                               wx.BORDER_SIMPLE|.STAY_ON_TOP)

        wx.Yield()











|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **SplashScreen**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/adv.SplashScreen_inheritance.png" alt="Inheritance diagram of SplashScreen" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Frame.html" title="A frame is a window whose size and position can (usually) be changed by the user." alt="" coords="733,32,805,61"/> <area shape="rect" id="node13" href="adv.SplashScreen.html" title="adv.SplashScreen  shows a window with a thin border, displaying a bitmap describing your application." alt="" coords="855,32,956,61"/> <area shape="rect" id="node2" href="TopLevelWindow.html" title="TopLevelWindow  is a common base class for Dialog  and Frame." alt="" coords="567,32,684,61"/> <area shape="rect" id="node4" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="9,5,81,35"/> <area shape="rect" id="node9" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="135,32,217,61"/> <area shape="rect" id="node5" href="NonOwnedWindow.html" title="Common base class for all non-child windows." alt="" coords="387,32,517,61"/> <area shape="rect" id="node6" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="267,32,339,61"/> <area shape="rect" id="node11" href="Trackable.html" title="Add-on base class for a trackable object." alt="" coords="7,59,84,88"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~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:`~SplashScreen.GetBitmap`                                                  Get the spash screen's bitmap
:meth:`~SplashScreen.GetSplashStyle`                                             Returns the splash style (see :meth:`SplashScreen`   for details).
:meth:`~SplashScreen.GetTimeout`                                                 Returns the timeout in milliseconds.
:meth:`~SplashScreen.SetBitmap`                                                  Set a new bitmap for the splash screen.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~SplashScreen.Bitmap`                                                     See :meth:`~SplashScreen.GetBitmap` and :meth:`~SplashScreen.SetBitmap`
:attr:`~SplashScreen.SplashStyle`                                                See :meth:`~SplashScreen.GetSplashStyle`
:attr:`~SplashScreen.Timeout`                                                    See :meth:`~SplashScreen.GetTimeout`
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: SplashScreen(Frame)

   SplashScreen shows a window with a thin border, displaying a bitmap describing your application.
   
   **Possible constructors**::

       SplashScreen(bitmap, splashStyle, milliseconds, parent, id=ID_ANY,
                    pos=DefaultPosition, size=DefaultSize,
                    style=BORDER_SIMPLE|FRAME_NO_TASKBAR|STAY_ON_TOP)
       



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

      - ``SPLASH_CENTRE_ON_PARENT`` 
      - ``SPLASH_CENTRE_ON_SCREEN`` 
      - ``SPLASH_NO_CENTRE`` 
      - ``SPLASH_TIMEOUT`` 
      - ``SPLASH_NO_TIMEOUT`` 




      `milliseconds`  is the timeout in milliseconds.                  


      :param `bitmap`: 
      :type `bitmap`: Bitmap
      :param `splashStyle`: 
      :type `splashStyle`: long
      :param `milliseconds`: 
      :type `milliseconds`: int
      :param `parent`: 
      :type `parent`: Window
      :param `id`: 
      :type `id`: int
      :param `pos`: 
      :type `pos`: Point
      :param `size`: 
      :type `size`: 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 :meth:`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:`~SplashScreen.GetBitmap` and :meth:`~SplashScreen.SetBitmap`


   .. attribute:: SplashStyle

      See :meth:`~SplashScreen.GetSplashStyle`


   .. attribute:: Timeout

      See :meth:`~SplashScreen.GetTimeout`