X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6bfc18d01649c47eb2157f1333d8c189be83ee4d..9e9574fe45b176ee74bba8fad7574cf9906145d1:/interface/wx/splash.h?ds=sidebyside diff --git a/interface/wx/splash.h b/interface/wx/splash.h index 8f1b0b51fd..2e09981951 100644 --- a/interface/wx/splash.h +++ b/interface/wx/splash.h @@ -2,23 +2,29 @@ // Name: splash.h // Purpose: interface of wxSplashScreen // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// +#define wxSPLASH_CENTRE_ON_PARENT 0x01 +#define wxSPLASH_CENTRE_ON_SCREEN 0x02 +#define wxSPLASH_NO_CENTRE 0x00 +#define wxSPLASH_TIMEOUT 0x04 +#define wxSPLASH_NO_TIMEOUT 0x00 + + /** @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, @@ -37,14 +43,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 +65,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;