wxMiniFrame(3)

✨ NAME ✨

wxMiniFrame — a miniframe is a frame with a small title bar 💅 (yes bestie, it's the Erlang module definition for wxMiniFrame(3), we're doing this)

---

🦋 DESCRIPTION 🦋

Okay so picture this: a frame, right, but tiny. It's giving floating toolbar energy, and it's literally designed for exactly that — the kind of floating toolbar that must not take up too much screen area. Small. Cute. Efficient. Iconic.

If you wanna see one in the wild 💖, there's an example of a mini frame in the page page_samples_dialogs, where you'd use the "Mini frame" command of the "Generic dialogs" submenu. Go look, it's a whole vibe.

🌸 Styles 🌸

This class supports the following styles, no cap:

• wxICONIZE: Display the frame iconized (minimized) — Windows only.
• wxCAPTION: Puts a caption on the frame.
• wxMINIMIZE: Identical to wxICONIZE.
• wxMINIMIZE_BOX: Displays a minimize box on the frame — Windows and Motif only.
• wxMAXIMIZE: Displays the frame maximized — Windows only.
• wxMAXIMIZE_BOX: Displays a maximize box on the frame — Windows and Motif only.
• wxCLOSE_BOX: Displays a close box on the frame.
• wxSTAY_ON_TOP: Stay on top of other windows — Windows only.
• wxSYSTEM_MENU: Displays a system menu — Windows and Motif only.
• wxRESIZE_BORDER: Displays a resizable border around the window.

Remark: This class has miniframe functionality under Windows and GTK — i.e. the presence of a mini frame will not be noted in the task bar, and focus behaviour is different. On other platforms, it behaves like a normal frame. So like… know which one you're on, bestie. 🙈

See:

• wxMDIParentFrame
• wxMDIChildFrame
• wxFrame
• wxDialog

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

• wxFrame
• wxTopLevelWindow
• wxWindow
• wxEvtHandler

wxWidgets docs: wxMiniFrame 📚

---

💜 DATA TYPES 💜

wxMiniFrame() :: wx:wx_object().

---

🎀 FUNCTIONS 🎀

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

when
    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.

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

Destroys the object. Bye bye, frame 👋💀

new() -> wxMiniFrame().

Default ctor. The starter pack, the bare minimum, the "just vibes" constructor ✨

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

when
    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. 🪟💖

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

See: create/5

---

And that's the whole page, bestie — every flag, every type, every function, preserved with love 🫶

Brought to you by Ericsson AB, wx 2.6, dated wxMiniFrame(3) — that's the source, the version and the date all wrapped up in one cute sign-off, mwah 💅🌟