wxSplashScreen

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();

wxFrame
wxWindow
wxEvtHandler
wxObject

Include files

<wx/splash.h>

Members

wxSplashScreen::wxSplashScreen
wxSplashScreen::~wxSplashScreen
wxSplashScreen::OnCloseWindow
wxSplashScreen::GetSplashStyle
wxSplashScreen::GetSplashWindow
wxSplashScreen::GetTimeout

wxSplashScreen::wxSplashScreen

wxSplashScreen(const wxBitmap& bitmap, long splashStyle, int milliseconds, wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long 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.

wxSplashScreen::~wxSplashScreen

~wxSplashScreen()

Destroys the splash screen.

wxSplashScreen::OnCloseWindow

void OnCloseWindow(wxCloseEvent& event)

Reimplement this event handler if you want to set an application variable on window destruction, for example.

wxSplashScreen::GetSplashStyle

long GetSplashStyle() const

Returns the splash style (see wxSplashScreen::wxSplashScreen for details).

wxSplashScreen::GetSplashWindow

wxSplashScreenWindow* GetSplashWindow() const

Returns the window used to display the bitmap.

wxSplashScreen::GetTimeout

int GetTimeout() const

Returns the timeout in milliseconds.