Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxSplashScreen (3erl)

Name

wxSplashScreen - Functions for wxSplashScreen class

Synopsis

Please see following description for synopsis

Description

wxSplashScreen(3)          Erlang Module Definition          wxSplashScreen(3)



NAME
       wxSplashScreen - Functions for wxSplashScreen class

DESCRIPTION
       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:

       This class is derived (and can use functions) from: wxFrame wxTopLevel-
       Window wxWindow wxEvtHandler

       wxWidgets docs: wxSplashScreen

DATA TYPES
       wxSplashScreen() = wx:wx_object()

EXPORTS
       new(Bitmap, SplashStyle, Milliseconds, Parent, Id) ->
              wxSplashScreen()

              Types:

                 Bitmap = wxBitmap:wxBitmap()
                 SplashStyle = Milliseconds = integer()
                 Parent = wxWindow:wxWindow()
                 Id = integer()

       new(Bitmap, SplashStyle, Milliseconds, Parent, Id,
           Options :: [Option]) ->
              wxSplashScreen()

              Types:

                 Bitmap = wxBitmap:wxBitmap()
                 SplashStyle = Milliseconds = integer()
                 Parent = wxWindow:wxWindow()
                 Id = integer()
                 Option =
                     {pos, {X :: integer(), Y :: integer()}} |
                     {size, {W :: integer(), H :: integer()}} |
                     {style, integer()}

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

              splashStyle is a bitlist of some of the following:

              milliseconds is the timeout in milliseconds.

       destroy(This :: wxSplashScreen()) -> ok

              Destroys the splash screen.

       getSplashStyle(This) -> integer()

              Types:

                 This = wxSplashScreen()

              Returns the splash style (see new/6 for details).

       getTimeout(This) -> integer()

              Types:

                 This = wxSplashScreen()

              Returns the timeout in milliseconds.



wxWidgets team.                    wx 2.1.1                  wxSplashScreen(3)