89 lines
2.5 KiB
C
89 lines
2.5 KiB
C
|
/////////////////////////////////////////////////////////////////////////////
|
||
|
|
// Name: splash.h
|
||
|
|
// Purpose: documentation for wxSplashScreen class
|
||
|
|
// 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))
|
||
|
|
{
|
||
|
|
wxSplashScreen* splash = new wxSplashScreen(bitmap,
|
||
|
|
wxSPLASH_CENTRE_ON_SCREEN|wxSPLASH_TIMEOUT,
|
||
|
|
6000, @NULL, -1, wxDefaultPosition, wxDefaultSize,
|
||
|
|
wxBORDER_SIMPLE|wxSTAY_ON_TOP);
|
||
|
|
}
|
||
|
|
wxYield();
|
||
|
|
@endcode
|
||
|
|
|
||
|
|
@library{wxadv}
|
||
|
|
@category{managedwnd}
|
||
|
|
*/
|
||
|
|
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.
|
||
|
|
|
||
|
|
@e 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.
|
||
|
|
*/
|
||
|
|
wxSplashScreen(const wxBitmap& bitmap, long splashStyle,
|
||
|
|
int milliseconds,
|
||
|
|
wxWindow* parent,
|
||
|
|
wxWindowID id,
|
||
|
|
const wxPoint& pos = wxDefaultPosition,
|
||
|
|
const wxSize& size = wxDefaultSize,
|
||
|
|
long style = wxBORDER_SIMPLE|wxFRAME_NO_TASKBAR|wxSTAY_ON_TOP);
|
||
|
|
|
||
|
|
/**
|
||
|
|
Destroys the splash screen.
|
||
|
|
*/
|
||
|
|
~wxSplashScreen();
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns the splash style (see wxSplashScreen() for
|
||
|
|
details).
|
||
|
|
*/
|
||
|
|
long GetSplashStyle();
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns the window used to display the bitmap.
|
||
|
|
*/
|
||
|
|
wxSplashScreenWindow* GetSplashWindow();
|
||
|
|
|
||
|
|
/**
|
||
|
|
Returns the timeout in milliseconds.
|
||
|
|
*/
|
||
|
|
int GetTimeout();
|
||
|
|
|
||
|
|
/**
|
||
|
|
Reimplement this event handler if you want to set an application variable on
|
||
|
|
window destruction, for example.
|
||
|
|
*/
|
||
|
|
void OnCloseWindow(wxCloseEvent& event);
|
||
|
|
};
|