X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12f5e1e78fe906050ff2fee9529476db332633f0..63a65070911908802c27b52173c3306e93dd63bf:/interface/wx/splash.h diff --git a/interface/wx/splash.h b/interface/wx/splash.h index 698f910a39..26dedbf6f9 100644 --- a/interface/wx/splash.h +++ b/interface/wx/splash.h @@ -3,27 +3,27 @@ // Purpose: interface of wxSplashScreen // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @class 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 + describing your application. + + Show it in application initialisation, and then either explicitly destroy it or let it time-out. Example usage: @code - wxBitmap bitmap; + 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, + 6000, NULL, -1, wxDefaultPosition, wxDefaultSize, wxBORDER_SIMPLE|wxSTAY_ON_TOP); } wxYield(); @@ -37,14 +37,15 @@ class wxSplashScreen : public wxFrame public: /** Construct the splash screen passing a bitmap, a style, a timeout, a window id, - optional position - and size, and a window style. + optional position and size, and a window style. + @a 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 + - wxSPLASH_CENTRE_ON_PARENT + - wxSPLASH_CENTRE_ON_SCREEN + - wxSPLASH_NO_CENTRE + - wxSPLASH_TIMEOUT + - wxSPLASH_NO_TIMEOUT + @a milliseconds is the timeout in milliseconds. */ wxSplashScreen(const wxBitmap& bitmap, long splashStyle, @@ -58,11 +59,10 @@ public: /** Destroys the splash screen. */ - ~wxSplashScreen(); + virtual ~wxSplashScreen(); /** - Returns the splash style (see wxSplashScreen() for - details). + Returns the splash style (see wxSplashScreen() for details). */ long GetSplashStyle() const;