wxStaticLine(3erl)

🌸 NAME 🌸

wxStaticLine — Functions for wxStaticLine class ✨

okay so this is the wxStaticLine(3erl) page from the Erlang Module Definition manual, and we’re gonna get you comfy with it, bestie 💅

---

💅 DESCRIPTION 💅

A static line is literally just a line, and you use it in a dialog to separate the groups of controls. It’s giving “visual divider energy” 🎀

The line may be only vertical or horizontal. No diagonal main-character nonsense.

Moreover, not all ports (notably not wxGTK) support specifying the transversal direction of the line (e.g. height for a horizontal line) so for maximal portability you should specify it as wxDefaultCoord. That caveat is important, fr fr — if you want max portability, use wxDefaultCoord for that transversal dimension.

✨ Styles ✨

This class supports the following styles:

(the source page doesn’t actually list any styles here, bestie 😭 so there’s nothing to bullet — that’s not me skipping it, that’s the whole vibe)

See: wxStaticBox

This class is derived (and can use functions) from: wxControl wxWindow wxEvtHandler

wxWidgets docs: wxStaticLine

---

🦋 DATA TYPES 🦋

wxStaticLine() = wx:wx_object()

That’s the type, periodt 💖

---

✨ EXPORTS ✨

🌟 new/0 — default constructor 🌟

new() -> wxStaticLine()

Default constructor.

🌸 new/1 — constructor with parent 🌸

new(Parent) -> wxStaticLine()

Types:

Parent = wxWindow:wxWindow()

💖 new/2 — constructor with parent and options 💖

new(Parent, Options :: [Option]) -> wxStaticLine()

Types:

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.

See: create/3

🎀 create/2 — two-step construction without options 🎀

create(This, Parent) -> boolean()

Types:

This = wxStaticLine()
Parent = wxWindow:wxWindow()

🔥 create/3 — two-step construction with options 🔥

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

Types:

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.

🦋 isVertical/1 — vibe check: vertical or not? 🦋

isVertical(This) -> boolean()

Types:

This = wxStaticLine()

Returns true if the line is vertical, false if horizontal. Literally the whole plot 💀

🌈 getDefaultSize/0 — default size for the smaller dimension 🌈

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.

💀 destroy/1 — bye bye, object 💀

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

Destroys the object.

---

Cute sign-off time, bestie: big love to the wxWidgets team — this page is from wx 2.2.2.1, and the manual tag is wxStaticLine(3erl). The source footer doesn’t show a separate date, so I’m not inventing one, periodt 🫶💖