docs/latex/wx/splash.tex

   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 \wxheading{Library}
  33
  34 \helpref{wxAdv}{librarieslist}
  35
  36 \latexignore{\rtfignore{\wxheading{Members}}}
  37
  38 \membersection{wxSplashScreen::wxSplashScreen}\label{wxsplashscreenwxsplashscreen}
  39
  40 \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|wxFRAME\_NO\_TASKBAR|wxSTAY\_ON\_TOP}}
  41
  42 Construct the splash screen passing a bitmap, a style, a timeout, a window id, optional position
  43 and size, and a window style.
  44
  45 {\it splashStyle} is a bitlist of some of the following:
  46
  47 \begin{itemize}\itemsep=0pt
  48 \item wxSPLASH\_CENTRE\_ON\_PARENT
  49 \item wxSPLASH\_CENTRE\_ON\_SCREEN
  50 \item wxSPLASH\_NO\_CENTRE
  51 \item wxSPLASH\_TIMEOUT
  52 \item wxSPLASH\_NO\_TIMEOUT
  53 \end{itemize}
  54
  55 {\it milliseconds} is the timeout in milliseconds.
  56
  57 \membersection{wxSplashScreen::\destruct{wxSplashScreen}}\label{wxsplashscreendtor}
  58
  59 \func{}{\destruct{wxSplashScreen}}{\void}
  60
  61 Destroys the splash screen.
  62
  63 \membersection{wxSplashScreen::OnCloseWindow}\label{wxsplashscreenonclosewindow}
  64
  65 \func{void}{OnCloseWindow}{\param{wxCloseEvent\& }{event}}
  66
  67 Reimplement this event handler if you want to set an application variable on window destruction, for example.
  68
  69 \membersection{wxSplashScreen::GetSplashStyle}\label{wxsplashscreengetsplashstyle}
  70
  71 \constfunc{long}{GetSplashStyle}{\void}
  72
  73 Returns the splash style (see \helpref{wxSplashScreen::wxSplashScreen}{wxsplashscreenwxsplashscreen} for
  74 details).
  75
  76 \membersection{wxSplashScreen::GetSplashWindow}\label{wxsplashscreengetsplashwindow}
  77
  78 \constfunc{wxSplashScreenWindow*}{GetSplashWindow}{\void}
  79
  80 Returns the window used to display the bitmap.
  81
  82 \membersection{wxSplashScreen::GetTimeout}\label{wxsplashscreengettimeout}
  83
  84 \constfunc{int}{GetTimeout}{\void}
  85
  86 Returns the timeout in milliseconds.
  87