4f4c5fcfdf
This is a combination of running clang-tidy with modernize-use-nullptr check for some ports (GTK, X11, OSX) and manual changes to the ports for which it couldn't be used easily (MSW, DFB) and also manually updating the docs. Also replace NULL with null or nullptr in the comments as this is more consistent with the use of nullptr in the code and makes it simpler to grep for the remaining occurrences of NULL itself. And also use null in the assert messages. Only a few occurrences of "NULL" are still left in non-C files, mostly corresponding to unclear comments or string output which it might not be safe to change.
91 lines
2.6 KiB
Objective-C
91 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, nullptr, -1, wxDefaultPosition, wxDefaultSize,
|
|
wxBORDER_SIMPLE|wxSTAY_ON_TOP);
|
|
}
|
|
wxYield();
|
|
@endcode
|
|
|
|
@library{wxcore}
|
|
@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);
|
|
};
|
|
|