wxPopupTransientWindow(3)

📦
version 29.0.6 · 3 versions
, in ubuntu stonking

💖 wxPopupTransientWindow 💖

okay bestie, welcome to the wxPopupTransientWindow page, straight out of the Erlang Module Definition section of the wx docs. it's giving popup-that-ghosts-you, and honestly? iconic.

✨ NAME ✨

wxPopupTransientWindow — a wxPopupWindow that dips out automatically the second the user clicks their mouse anywhere outside it, or whenever it loses focus some other way. lowkey the most emotionally unavailable window class in the whole toolkit. 💅

🌸 DESCRIPTION 🌸

so like, this window is genuinely useful for building custom combobox-style controls, for example. it pops up, it does its lil thing, and then it peaces out the moment it stops being the main character. no cap.

See: wxPopupWindow

🦋 inheritance energy (derived class tea) 🦋

this class is derived from — and can absolutely use functions from — the following:

  • wxPopupWindow
  • wxWindow
  • wxEvtHandler

it's giving family tree. it got the whole bloodline. 👑

just so you know: wxWidgets docs: wxPopupTransientWindow

🎀 DATA TYPES 🎀

  • wxPopupTransientWindow() :: wx:wx_object().

that's it, that's the type. short, sweet, slaying.

💅 FUNCTIONS 💅

🌟 destroy/1 🌟

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

destroys the object. bye bye, gone, no refunds, we love a clean exit. ✨

🌟 dismiss/1 🌟

dismiss(This) -> ok when This :: wxPopupTransientWindow().

hides the window. it's not destroyed, it's just napping under the covers, iykyk. 🙈

🌟 new/0 🌟

new() -> wxPopupTransientWindow().

the default constructor. no arguments, no drama, just vibes. 🫶

🌟 new/2 🌟

new(Parent, [Option]) -> wxPopupTransientWindow()
             when
                 Parent :: wxWindow:wxWindow(),
                 Option :: {style, integer()}.

the constructor. you bring a Parent (which is a wxWindow:wxWindow()) and you can sprinkle in an Option of {style, integer()}. very choose-your-own-adventure. 🌈

popup(This, [Option]) -> ok
               when
                   This :: wxPopupTransientWindow(),
                   Option :: {focus, wxWindow:wxWindow()}.

pops the window up — and yes, bestie, this will show it too. one call, two jobs, we stan efficiency. 👑

now for the focus situation, listen closely:

  • if focus is non-NULL, it will be kept focused while this window is shown — if the current platform supports that. platforms are gonna platform. 💀
  • otherwise, the popup itself will receive focus instead.
  • either way, the popup will disappear automatically if it loses focus because of a user action. it's clingy like that. touch grass once and it's gone.

See: dismiss/1

🧚 a lil sign-off, from me to you 🧚

this page came to you courtesy of Ericsson AB, sitting pretty at wx 2.6. no date on this one, so we keep it timeless, like a true icon. go forth and popup responsibly, bestie. mwah. 💖✨🎀

📦 where this page comes from