.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxSplashScreen 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxSplashScreen \- 
  Splash screen class
 
.SH DESCRIPTION

  


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


  
  wxBitmap bitmap;
  if (bitmap.LoadFile("splash16.png", wxBITMAP_TYPE_PNG))
  {
      wxSplashScreen* splash = new wxSplashScreen(bitmap,
          wxSPLASH_CENTRE_ON_SCREEN|wxSPLASH_TIMEOUT,
          6000, NULL, -1, wxDefaultPosition, wxDefaultSize,
          wxSIMPLE_BORDER|wxSTAY_ON_TOP);
  }
  wxYield();

  


 
.SH "PARENTS"

  wxFrame
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
.SH "INCLUDE FILES"
wx/splash.h
.SH MEMBERS

  
.SS  wxSplashScreen (const wxBitmap& bitmaplong splashStyleint millisecondswxWindow* parentwxWindowID idconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxSIMPLE_BORDER|wxFRAME_NO_TASKBAR|wxSTAY_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:
     
     


      
       wxSPLASH_CENTRE_ON_PARENT
        
       wxSPLASH_CENTRE_ON_SCREEN
        
       wxSPLASH_NO_CENTRE
        
       wxSPLASH_TIMEOUT
        
       wxSPLASH_NO_TIMEOUT
      
     
     


      
       milliseconds
      
      is the timeout in milliseconds.
     
    
   
  
.SS  ~wxSplashScreen ()

     


      Destroys the splash screen.
     
    
   
  
.SS void OnCloseWindow (wxCloseEvent& event)

     


      Reimplement this event handler if you want to set an application variable
      on window destruction, for example.
     
    
   
  
.SS long GetSplashStyle ()

     


      Returns the splash style (see
      wxSplashScreen::wxSplashScreen
      for details).
     
    
   
  
.SS wxSplashScreenWindow* GetSplashWindow ()

     


      Returns the window used to display the bitmap.
     
    
   
  
.SS int GetTimeout ()

     


      Returns the timeout in milliseconds.
     
    
 
.SH "SEE ALSO"

  wxFrame
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.