1wxSplashScreen(3)          Erlang Module Definition          wxSplashScreen(3)
2
3
4

NAME

6       wxSplashScreen - Functions for wxSplashScreen class
7

DESCRIPTION

9       wxSplashScreen  shows  a window with a thin border, displaying a bitmap
10       describing your application.
11
12       Show it in application initialisation, and then either  explicitly  de‐
13       stroy it or let it time-out.
14
15       Example usage:
16
17       This class is derived (and can use functions) from: wxFrame wxTopLevel‐
18       Window wxWindow wxEvtHandler
19
20       wxWidgets docs: wxSplashScreen
21

DATA TYPES

23       wxSplashScreen() = wx:wx_object()
24

EXPORTS

26       new(Bitmap, SplashStyle, Milliseconds, Parent, Id) ->
27              wxSplashScreen()
28
29              Types:
30
31                 Bitmap = wxBitmap:wxBitmap()
32                 SplashStyle = Milliseconds = integer()
33                 Parent = wxWindow:wxWindow()
34                 Id = integer()
35
36       new(Bitmap, SplashStyle, Milliseconds, Parent, Id,
37           Options :: [Option]) ->
38              wxSplashScreen()
39
40              Types:
41
42                 Bitmap = wxBitmap:wxBitmap()
43                 SplashStyle = Milliseconds = integer()
44                 Parent = wxWindow:wxWindow()
45                 Id = integer()
46                 Option =
47                     {pos, {X :: integer(), Y :: integer()}} |
48                     {size, {W :: integer(), H :: integer()}} |
49                     {style, integer()}
50
51              Construct the splash screen passing a bitmap, a style,  a  time‐
52              out,  a  window  id,  optional  position  and size, and a window
53              style.
54
55              splashStyle is a bitlist of some of the following:
56
57              milliseconds is the timeout in milliseconds.
58
59       destroy(This :: wxSplashScreen()) -> ok
60
61              Destroys the splash screen.
62
63       getSplashStyle(This) -> integer()
64
65              Types:
66
67                 This = wxSplashScreen()
68
69              Returns the splash style (see new/6 for details).
70
71       getTimeout(This) -> integer()
72
73              Types:
74
75                 This = wxSplashScreen()
76
77              Returns the timeout in milliseconds.
78
79
80
81wxWidgets team.                     wx 2.1                   wxSplashScreen(3)