/////////////////////////////////////////////////////////////////////////////
// Name: splash.h
-// Purpose: documentation for wxSplashScreen class
+// Purpose: interface of wxSplashScreen
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@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))
}
wxYield();
@endcode
-
+
@library{wxadv}
@category{managedwnd}
*/
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,
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
*/
void OnCloseWindow(wxCloseEvent& event);
};
+