<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year><year>2021</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxSplashScreen</title>
</header>
<module>wxSplashScreen</module>
<modulesummary>Functions for wxSplashScreen class</modulesummary>
<description><p><seeerl marker="wxSplashScreen"><c>wxSplashScreen</c></seeerl> shows a window with a thin border, displaying a bitmap describing your application.
      </p><p>Show it in application initialisation, and then either explicitly destroy it or let it time-out.
      </p><p>Example usage:
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxFrame"><c>wxFrame</c></seeerl> <seeerl marker="wxTopLevelWindow"><c>wxTopLevelWindow</c></seeerl> <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_splash_screen.html">wxSplashScreen</url></p>
  </description>
<datatypes><datatype><name name="wxSplashScreen"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="5" clause_i="1" since=""/>
    <fsummary>See: <c>new/6</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="6" clause_i="1" since=""/>
    <fsummary>Construct the splash screen passing a bitmap, a style, a timeout, a window id, optional position and size, and a window style. </fsummary>
    <desc><p>Construct the splash screen passing a bitmap, a style, a timeout, a window id, optional position and size, and a window style. 
      </p><p><c>splashStyle</c> is a bitlist of some of the following:
      </p><p><c>milliseconds</c> is the timeout in milliseconds. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destroys the splash screen. </fsummary>
    <desc><p>Destroys the splash screen. 
      </p></desc>
  </func>
  
  <func>
    <name name="getSplashStyle" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the splash style (see <c>new/6</c> for details). </fsummary>
    <desc><p>Returns the splash style (see <seemfa marker="#new/6"><c>new/6</c></seemfa> for details). 
      </p></desc>
  </func>
  
  <func>
    <name name="getTimeout" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the timeout in milliseconds. </fsummary>
    <desc><p>Returns the timeout in milliseconds. 
      </p></desc>
  </func>
  </funcs>
</erlref>
