X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..3201a1046ba71ba8e5ef2ed694fde34d12f743f3:/interface/splash.h?ds=inline diff --git a/interface/splash.h b/interface/splash.h index 7a9bfb2ec4..ae408f6bb0 100644 --- a/interface/splash.h +++ b/interface/splash.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: splash.h -// Purpose: documentation for wxSplashScreen class +// Purpose: interface of wxSplashScreen // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -9,15 +9,15 @@ /** @class wxSplashScreen @wxheader{splash.h} - + 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: - + @code wxBitmap bitmap; if (bitmap.LoadFile("splash16.png", wxBITMAP_TYPE_PNG)) @@ -29,7 +29,7 @@ } wxYield(); @endcode - + @library{wxadv} @category{managedwnd} */ @@ -40,16 +40,13 @@ public: Construct the splash screen passing a bitmap, a style, a timeout, a window id, optional position and size, and a window style. - - @e splashStyle is a bitlist of some of the following: - + @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 - - @e milliseconds is the timeout in milliseconds. + @a milliseconds is the timeout in milliseconds. */ wxSplashScreen(const wxBitmap& bitmap, long splashStyle, int milliseconds, @@ -68,17 +65,17 @@ public: Returns the splash style (see wxSplashScreen() for details). */ - long GetSplashStyle(); + long GetSplashStyle() const; /** Returns the window used to display the bitmap. */ - wxSplashScreenWindow* GetSplashWindow(); + wxSplashScreenWindow* GetSplashWindow() const; /** Returns the timeout in milliseconds. */ - int GetTimeout(); + int GetTimeout() const; /** Reimplement this event handler if you want to set an application variable on @@ -86,3 +83,4 @@ public: */ void OnCloseWindow(wxCloseEvent& event); }; +