wxPopupWindow(3erl)

🌸 NAME 🌸

wxPopupWindow — functions for the wxPopupWindow class, bestie. This is the wxPopupWindow(3erl) page, aka the Erlang module definition, and we're about to make popup windows make sense. 💖

✨ DESCRIPTION ✨

Okay so picture this: a special kind of top level window used for popup menus, combobox popups and such. That's the whole vibe. 🦋

🎀 Styles 🎀

This class supports the following styles:

…and that's the list on this page — yes, it's literally giving "no styles listed" energy, and we respect it. 💅

See: wxDialog, wxFrame.

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

wxWidgets docs: wxPopupWindow.

💾 DATA TYPES 💾

The one data type on the menu, no cap:

wxPopupWindow() = wx:wx_object()

👑 EXPORTS 👑

new() -> wxPopupWindow()

Default constructor. That's it, that's the function — it's giving simple and iconic. ✨

new(Parent) -> wxPopupWindow()

Types:

Parent = wxWindow:wxWindow()

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

Types:

Parent = wxWindow:wxWindow()
Option = {flags, integer()}

Constructor. You're passing a Parent and Options (which are a list of {flags, integer()}), and it constructs. Slay. 💖

create(This, Parent) -> boolean()

Types:

This = wxPopupWindow()
Parent = wxWindow:wxWindow()

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

Types:

This = wxPopupWindow()
Parent = wxWindow:wxWindow()
Option = {flags, integer()}

Create method for two-step creation. Two-step creation is the moment, bestie. 🎀

position(This, PtOrigin, SizePopup) -> ok

Types:

This = wxPopupWindow()
PtOrigin = {X :: integer(), Y :: integer()}
SizePopup = {W :: integer(), H :: integer()}

Move the popup window to the right position, i.e. such that it is entirely visible.

The popup is positioned at ptOrigin + size if it opens below and to the right (default), at ptOrigin - sizePopup if it opens above and to the left etc. Positioning math? Obsessed. 🧚

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

Destroys the object. Rude but necessary, periodt. 💀

---

Sign-off city: wxWidgets team. · wx 2.2.2.1 · wxPopupWindow(3erl) — that's the source/version and manual-name energy at the very end. Byeee, bestie! 🌈🫶