wxSplashScreen(3erl)

🎀 NAME 🎀

okay bestie, this is wxSplashScreen(3erl) — the Erlang Module Definition page for wxSplashScreen. It's literally “Functions for wxSplashScreen class”. That's the name vibes. slay.

✨ 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. That's the whole vibe.

Example usage:

the original page says “Example usage:” and then... no snippet. iconic minimalism, honestly. We're not inventing one 🫶.

This class is derived (and can use functions) from: wxFrame wxTopLevelWindow wxWindow wxEvtHandler.

wxWidgets docs: wxSplashScreen.

🦋 DATA TYPES 🦋

wxSplashScreen() = wx:wx_object()

one type, one iconic little alias.

👑 EXPORTS 👑

🌸 new/5 🌸

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

Types:

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

💖 new/6 💖

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 timeout, a window id, optional position and size, and a window style. periodt.

splashStyle is a bitlist of some of the following:

bestie, the source says “some of the following:” and then lists absolutely nothing. That's not me being lazy — don't invent flags, fr fr.

milliseconds is the timeout in milliseconds.

🎀 destroy/1 🎀

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

Destroys the splash screen. bye-bye, splashy.

🧚 getSplashStyle/1 🧚

getSplashStyle(This) -> integer()

Types:

This = wxSplashScreen()

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

🍓 getTimeout/1 🍓

getTimeout(This) -> integer()

Types:

This = wxSplashScreen()

Returns the timeout in milliseconds. clock it.

---

mwah 💋 huge shoutout to the wxWidgets team, version wx 2.2.2.1, and this page is wxSplashScreen(3erl). Date? not in the footer, bestie — no invented dates here. 🎀