wxMiniFrame(3erl)

💅 NAME 💅

Hey bestie, welcome to wxMiniFrame(3erl) — yep, that's the Erlang Module Definition page for the wxMiniFrame class. It's literally wxMiniFrame — Functions for wxMiniFrame class. ✨

🦋 DESCRIPTION 🦋

Okay so picture this: a miniframe is a frame with a small title bar. It's giving floating-toolbar realness, and it's suitable for floating toolbars that must not take up too much screen area. Iconic, lowkey. 💖

You can see an example of a mini frame in page_samples_dialogs, using the "Mini frame" command of the "Generic dialogs" submenu. Go look, bestie, it's right there. 👑

🎀 Styles 🎀

This class supports the following styles: — and then the page immediately hits us with the remark, so no actual styles are listed here. Don't come for me, I'm just the messenger 😭💀

Remark: This class has miniframe functionality under Windows and GTK, i.e. the presence of mini frame will not be noted in the task bar and focus behaviour is different. On other platforms, it behaves like a normal frame. 🪟🐧

See: wxMDIParentFrame, wxMDIChildFrame, wxFrame, wxDialog. Those are the references, periodt.

This class is derived (and can use functions) from: wxFrame wxTopLevelWindow wxWindow wxEvtHandler. So yes, it's got the whole family tree situation going on. 🌳

wxWidgets docs: wxMiniFrame — the official docs hookup. 🔗

🌸 DATA TYPES 🌸

wxMiniFrame() = wx:wx_object()

👑 EXPORTS 👑

💖 new() -> wxMiniFrame()

Default ctor. That's the default constructor, bestie. Easy.

✨ new(Parent, Id, Title) -> wxMiniFrame()

Types:

Parent = wxWindow:wxWindow()
Id = integer()
Title = unicode:chardata()

Here's the three-argument flavor. 🎀

🎀 new(Parent, Id, Title, Options :: [Option]) -> wxMiniFrame()

Types:

Parent = wxWindow:wxWindow()
Id = integer()
Title = unicode:chardata()
Option =
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()}

Constructor, creating the window. Main character constructor energy. 🔥

Remark: The frame behaves like a normal frame on non-Windows platforms.

See: create/5. Go check it out. 💅

🫶 destroy(This :: wxMiniFrame()) -> ok

Destructor. It destroys all child windows and menu bar if present. Cleanup slay. 🧹✨

🦋 create(This, Parent, Id, Title) -> boolean()

Types:

This = wxMiniFrame()
Parent = wxWindow:wxWindow()
Id = integer()
Title = unicode:chardata()

Four-argument create, bestie. 🦋

🌈 create(This, Parent, Id, Title, Options :: [Option]) -> boolean()

Types:

This = wxMiniFrame()
Parent = wxWindow:wxWindow()
Id = integer()
Title = unicode:chardata()
Option =
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()}

Used in two-step frame construction. See new/4 for further details. That's the whole tea. ☕

---

And that's the page, bestie! Footer shoutout: the wxWidgets team, wx 2.2.2.1, and page wxMiniFrame(3erl) — no date listed in this footer, just pure manual energy. Byeee! 💋💖