[wxWidgets.git] / docs / latex / wx / splash.tex

\section{\class{wxSplashScreen}}\label{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:

\begin{verbatim}
  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,
          wxSIMPLE_BORDER|wxSTAY_ON_TOP);
  }
  wxYield();
\end{verbatim}
 
\wxheading{Derived from}

\helpref{wxFrame}{wxframe}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/splash.h>

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxSplashScreen::wxSplashScreen}\label{wxsplashscreenwxsplashscreen}

\func{}{wxSplashScreen}{\param{const wxBitmap\& }{bitmap}, \param{long }{splashStyle}, \param{int }{milliseconds}, \param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxSIMPLE\_BORDER}}

Construct the splash screen passing a bitmap, a style, a timeout, a window id, optional position
and size, and a window style.

{\it splashStyle} is a bitlist of some of the following:

\begin{itemize}\itemsep=0pt
\item wxSPLASH\_CENTRE\_ON\_PARENT
\item wxSPLASH\_CENTRE\_ON\_SCREEN
\item wxSPLASH\_NO\_CENTRE
\item wxSPLASH\_TIMEOUT
\item wxSPLASH\_NO\_TIMEOUT
\end{itemize}

{\it milliseconds} is the timeout in milliseconds.

\membersection{wxSplashScreen::\destruct{wxSplashScreen}}\label{wxsplashscreendtor}

\func{}{\destruct{wxSplashScreen}}{\void}

Destroys the splash screen.

\membersection{wxSplashScreen::OnCloseWindow}\label{wxsplashscreenonclosewindow}

\func{void}{OnCloseWindow}{\param{wxCloseEvent\& }{event}}

Reimplement this event handler if you want to set an application variable on window destruction, for example.

\membersection{wxSplashScreen::GetSplashStyle}\label{wxsplashscreengetsplashstyle}

\constfunc{long}{GetSplashStyle}{\void}

Returns the splash style (see \helpref{wxSplashScreen::wxSplashScreen}{wxsplashscreenwxsplashscreen} for
details).

\membersection{wxSplashScreen::GetSplashWindow}\label{wxsplashscreengetsplashwindow}

\constfunc{wxSplashScreenWindow*}{GetSplashWindow}{\void}

Returns the window used to display the bitmap.

\membersection{wxSplashScreen::GetTimeout}\label{wxsplashscreengettimeout}

\constfunc{int}{GetTimeout}{\void}

Returns the timeout in milliseconds.
Commit	Line	Data
e3c10211 JS	1	\section{\class{wxSplashScreen}}\label{wxsplashscreen}
	2
	3	wxSplashScreen shows a window with a thin border, displaying a bitmap describing your
	4	application. Show it in application initialisation, and then either explicitly destroy
	5	it or let it time-out.
	6
	7	Example usage:
	8
	9	\begin{verbatim}
	10	wxBitmap bitmap;
	11	if (bitmap.LoadFile("splash16.png", wxBITMAP_TYPE_PNG))
	12	{
	13	wxSplashScreen* splash = new wxSplashScreen(bitmap,
	14	wxSPLASH_CENTRE_ON_SCREEN\|wxSPLASH_TIMEOUT,
	15	6000, NULL, -1, wxDefaultPosition, wxDefaultSize,
	16	wxSIMPLE_BORDER\|wxSTAY_ON_TOP);
	17	}
	18	wxYield();
	19	\end{verbatim}
	20
	21	\wxheading{Derived from}
	22
	23	\helpref{wxFrame}{wxframe}\\
	24	\helpref{wxWindow}{wxwindow}\\
	25	\helpref{wxEvtHandler}{wxevthandler}\\
	26	\helpref{wxObject}{wxobject}
	27
	28	\wxheading{Include files}
	29
	30	<wx/splash.h>
	31
	32	\latexignore{\rtfignore{\wxheading{Members}}}
	33
	34	\membersection{wxSplashScreen::wxSplashScreen}\label{wxsplashscreenwxsplashscreen}
	35
	36	\func{}{wxSplashScreen}{\param{const wxBitmap\& }{bitmap}, \param{long }{splashStyle}, \param{int }{milliseconds}, \param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxSIMPLE\_BORDER}}
	37
	38	Construct the splash screen passing a bitmap, a style, a timeout, a window id, optional position
	39	and size, and a window style.
	40
	41	{\it splashStyle} is a bitlist of some of the following:
	42
	43	\begin{itemize}\itemsep=0pt
	44	\item wxSPLASH\_CENTRE\_ON\_PARENT
	45	\item wxSPLASH\_CENTRE\_ON\_SCREEN
	46	\item wxSPLASH\_NO\_CENTRE
	47	\item wxSPLASH\_TIMEOUT
	48	\item wxSPLASH\_NO\_TIMEOUT
	49	\end{itemize}
	50
	51	{\it milliseconds} is the timeout in milliseconds.
	52
	53	\membersection{wxSplashScreen::\destruct{wxSplashScreen}}\label{wxsplashscreendtor}
	54
	55	\func{}{\destruct{wxSplashScreen}}{\void}
	56
	57	Destroys the splash screen.
	58
	59	\membersection{wxSplashScreen::OnCloseWindow}\label{wxsplashscreenonclosewindow}
	60
	61	\func{void}{OnCloseWindow}{\param{wxCloseEvent\& }{event}}
	62
	63	Reimplement this event handler if you want to set an application variable on window destruction, for example.
	64
65	\membersection{wxSplashScreen::GetSplashStyle}\label{wxsplashscreengetsplashstyle}
66
67	\constfunc{long}{GetSplashStyle}{\void}
68
69	Returns the splash style (see \helpref{wxSplashScreen::wxSplashScreen}{wxsplashscreenwxsplashscreen} for
70	details).
71
72	\membersection{wxSplashScreen::GetSplashWindow}\label{wxsplashscreengetsplashwindow}
73
74	\constfunc{wxSplashScreenWindow*}{GetSplashWindow}{\void}
75
76	Returns the window used to display the bitmap.
77
78	\membersection{wxSplashScreen::GetTimeout}\label{wxsplashscreengettimeout}
79
80	\constfunc{int}{GetTimeout}{\void}
81
82	Returns the timeout in milliseconds.
83