***************
wx.SplashScreen
***************

Inheritance diagram for `wx.SplashScreen`:

|

.. inheritance-diagram:: wx.SplashScreen

|

Description
===========

`wx.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|wx.SPLASH_TIMEOUT, 6000, None, style=wx.SIMPLE_BORDER|wx.STAY_ON_TOP)

    wx.Yield()


Derived From
^^^^^^^^^^^^^

* `wx.Frame <wx.Frame.html>`_ 
* `wx.Window <wx.Window.html>`_ 
* `wx.EvtHandler <wx.EvtHandler.html>`_ 
* `wx.Object <wx.Object.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetSplashStyle <#GetSplashStyle>`_ 
* `GetSplashWindow <#GetSplashWindow>`_ 
* `GetTimeout <#GetTimeout>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `SplashStyle <#SplashStyle>`_ 
* `SplashWindow <#SplashWindow>`_ 
* `Timeout <#Timeout>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(bitmap, splashStyle, milliseconds, parent, id=-1, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.SIMPLE_BORDER|wx.FRAME_NO_TASKBAR|wx.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.SPLASH_CENTRE_ON_PARENT``
   * ``wx.SPLASH_CENTRE_ON_SCREEN`` 
   * ``wx.SPLASH_NO_CENTRE`` 
   * ``wx.SPLASH_TIMEOUT`` 
   * ``wx.SPLASH_NO_TIMEOUT`` 

   `milliseconds` is the timeout in milliseconds.


   **Parameters:**

   * `bitmap` (`wx.Bitmap <wx.Bitmap.html>`_)
   * `splashStyle` (long)
   * `milliseconds` (int)
   * `parent` (`wx.Window <wx.Window.html>`_)
   * `id` (int)
   * `pos` (`wx.Point <wx.Point.html>`_)
   * `size` (`wx.Size <wx.Size.html>`_)
   * `style` (long)

   |

   **Returns:**

   `wx.SplashScreen <wx.SplashScreen.html>`_
 

--------

.. method:: GetSplashStyle()

   Returns the splash style (see `__init__ <#__init__>`_ for details).

   |  

   **Returns:**

   `long` 

--------

.. method:: GetSplashWindow()

   Returns the window used to display the bitmap.

   |  

   **Returns:**

   `wx.SplashScreenWindow` 

--------

.. method:: GetTimeout()

   Returns the timeout in milliseconds.

   |  

   **Returns:**

   `int` 

--------

Properties
^^^^^^^^^^


.. attribute:: SplashStyle

   See `GetSplashStyle <#GetSplashStyle>`_

.. attribute:: SplashWindow

   See `GetSplashWindow <#GetSplashWindow>`_

.. attribute:: Timeout

   See `GetTimeout <#GetTimeout>`_