wxSplashScreen(3)

🎀 NAME 🎀

okay so, bestie, welcome to the wxSplashScreen(3) page ✨

wxSplashScreen — it shows a window with a thin border, displaying a bitmap describing your application. it's giving "look at my app before it even loads" main character energy 💅

---

🦋 DESCRIPTION 🦋

Show it in application initialisation, and then either explicitly destroy it or let it time-out. that's the whole vibe — pop it up while your app is waking up, then either yeet it yourself with a destroy, or just let the clock run out and it dips on its own 😌

Example usage:

ngl, the page says "Example usage:" and then... nothing follows it 😭 that's literally just how it is in the docs, bestie, i'm not gatekeeping an example from you, there isn't one here 🙈

This class is derived, and can use functions, from:

• wxFrame
• wxTopLevelWindow
• wxWindow
• wxEvtHandler

so yeah, it inherits from all of those, which means it's lowkey stacked with inherited behaviour 👑

wxWidgets docs: wxSplashScreen

---

✨ DATA TYPES ✨

wxSplashScreen() :: wx:wx_object().

that's the object type, she's just a wx:wx_object() underneath 🌸

---

💖 FUNCTIONS 💖

🌈 destroy

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

Destroys the object. gone, bye, no notes 💀

🌸 getSplashStyle

getSplashStyle(This) -> integer() when This :: wxSplashScreen().

Returns the splash style (see new/6 for details). yes bestie, the details are down in new/6, keep scrolling 🫶

🦋 getTimeout

getTimeout(This) -> integer() when This :: wxSplashScreen().

Returns the timeout in milliseconds. clock's ticking fr fr ⏳

👑 new

new(Bitmap, SplashStyle, Milliseconds, Parent, Id, [Option]) ->
               wxSplashScreen()
               when
                   Bitmap :: wxBitmap:wxBitmap(),
                   SplashStyle :: integer(),
                   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. that's the lineup, hand them all over and she's built 🎀

SplashStyle is a bitlist of some of the following:

• wxSPLASH_CENTRE_ON_PARENT
• wxSPLASH_CENTRE_ON_SCREEN
• wxSPLASH_NO_CENTRE
• wxSPLASH_TIMEOUT
• wxSPLASH_NO_TIMEOUT

Milliseconds is the timeout in milliseconds. ⏰

---

and that's the whole page, bestie, you ate it, no crumbs 💅

this manual page came to you courtesy of Ericsson AB, and it's from wx 2.6 — so yeah, that's the source, that's the version, mwah 💖