wxStaticLine(3)

💅 wxStaticLine(3) — Erlang Module Definition 🎀

ok so bestie, welcome to the wxStaticLine page ✨ (it's pronounced "w-x-static-line", and yes it's an Erlang module definition, the wx 2.6 era, we love a classic).

---

🌸 NAME 🌸

wxStaticLine — a static line is literally just a line, and you can use it in a dialog to separate groups of controls. that's it. that's the whole gig. and honestly? iconic for it. 🫶

---

✨ DESCRIPTION ✨

So the line can be only vertical or horizontal — pick a lane, bestie, there's no diagonal slay here 😭.

AND here's the tea: not all ports support specifying the transversal direction of the line — notably not wxGTK. What does transversal mean? For a horizontal line it's the height, for a vertical line it's the width. So for maximal portability you should specify it as wxDefaultCoord. no cap, just do it 💖

🦋 Styles 🦋

This class supports the following styles, and there are exactly two, so you literally cannot get them mixed up:

• wxLI_HORIZONTAL — creates a horizontal line. side to side. chill energy. ➡️
• wxLI_VERTICAL — creates a vertical line. up and down. main character energy. ⬆️

See: wxStaticBox

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

• wxControl
• wxWindow
• wxEvtHandler

so it's giving inheritance chain 💅 it got the whole family tree.

wxWidgets docs: wxStaticLine

---

🎀 DATA TYPES 🎀

wxStaticLine() :: wx:wx_object().

yeah it's just an object. short and sweet, periodt.

---

👑 FUNCTIONS 👑

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

when
    This :: wxStaticLine(),
    Parent :: wxWindow:wxWindow(),
    Option ::
        {id, integer()} |
        {pos, {X :: integer(), Y :: integer()}} |
        {size, {W :: integer(), H :: integer()}} |
        {style, integer()}.

Creates the static line for two-step construction.

See new/2 for further details. (go read that one, it's the one with the lore 💜)

---

🌸 destroy(This :: wxStaticLine()) -> ok.

Destroys the object 🔥 bye bestie, it was real.

---

⭐ getDefaultSize() -> integer().

This static function returns the size which will be given to the smaller dimension of the static line, i.e.

its height for a horizontal line or its width for a vertical one.

(so like — the little one. the thin one. the dimension nobody thinks about until it's wrong 🙈)

---

🦋 isVertical(This) -> boolean() when This :: wxStaticLine().

Returns true if the line is vertical, false if horizontal.

vibe check on your line's orientation, basically 🌈

---

💜 new() -> wxStaticLine().

Default constructor. baby's first static line 🎀

---

✨ new(Parent, [Option]) -> wxStaticLine()

when
    Parent :: wxWindow:wxWindow(),
    Option ::
        {id, integer()} |
        {pos, {X :: integer(), Y :: integer()}} |
        {size, {W :: integer(), H :: integer()}} |
        {style, integer()}.

Constructor, creating and showing a static line. yes it does both, it's an overachiever, we stan 💅

See: create/3

---

lowkey reminder since we're all friends here: that transversal-direction thing from the DESCRIPTION? still true. specify it as wxDefaultCoord if you want it to work everywhere. we're not repeating it for fun, we're repeating it because it matters 💖

---

and that's the page bestie!! written by Ericsson AB 🫶, wx 2.6 era, stamped with the date of wxStaticLine(3) 🌸 mwah, go separate some control groups, you're gonna ate ✨👑💅