// 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
- @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
+ 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();
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,
/**
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;