wxWidgets/interface/wx/splash.h
Vadim Zeitlin 3f66f6a5b3 Remove all lines containing cvs/svn "$Id$" keyword.
This keyword is not expanded by Git which means it's not replaced with the
correct revision value in the releases made using git-based scripts and it's
confusing to have lines with unexpanded "$Id$" in the released files. As
expanding them with Git is not that simple (it could be done with git archive
and export-subst attribute) and there are not many benefits in having them in
the first place, just remove all these lines.

If nothing else, this will make an eventual transition to Git simpler.

Closes #14487.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74602 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-07-26 16:02:46 +00:00

92 lines
2.6 KiB
Objective-C

/////////////////////////////////////////////////////////////////////////////
// Name: splash.h
// Purpose: interface of wxSplashScreen
// Author: wxWidgets team
// 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
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.
@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
@a 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.
*/
virtual ~wxSplashScreen();
/**
Returns the splash style (see wxSplashScreen() for details).
*/
long GetSplashStyle() const;
/**
Returns the window used to display the bitmap.
*/
wxSplashScreenWindow* GetSplashWindow() const;
/**
Returns the timeout in milliseconds.
*/
int GetTimeout() const;
/**
Reimplement this event handler if you want to set an application variable on
window destruction, for example.
*/
void OnCloseWindow(wxCloseEvent& event);
};