Moved all interface headers into a 'wx' subdirectory for proper use of Doxygen path settings.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54385 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
86
interface/wx/splash.h
Normal file
86
interface/wx/splash.h
Normal file
@@ -0,0 +1,86 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: splash.h
|
||||
// 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))
|
||||
{
|
||||
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.
|
||||
*/
|
||||
~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);
|
||||
};
|
||||
|
Reference in New Issue
Block a user