wxTextEntryDialog(3erl)

💬 wxTextEntryDialog(3erl)

okay so bestie, welcome to the wxTextEntryDialog page from the Erlang Module Definition manual ✨ — yes this is the module doc for the wxTextEntryDialog class, and yes it's about to be your new fave little popup. 🎀

---

🌸 NAME 🌸

wxTextEntryDialog — Functions for wxTextEntryDialog class 💅

---

✨ DESCRIPTION ✨

This class represents a dialog that requests a one-line text string from the user. That's it, that's the whole vibe — one line, no paragraphs, no essay, just give me a string bestie. 🫶

It is implemented as a generic wxWidgets dialog.

See: Overview cmndlg

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

• wxDialog
• wxTopLevelWindow
• wxWindow
• wxEvtHandler

wxWidgets docs: wxTextEntryDialog

---

🦋 DATA TYPES 🦋

wxTextEntryDialog() = wx:wx_object()

literally just the object type, nothing wild 🧚

---

👑 EXPORTS 👑

• new() -> wxTextEntryDialog() — Default constructor 🌈

Call Create() (not implemented in wx) to really create the dialog later. So like, this one is the "I'll build it in a sec" version, no cap.

Since: 2.9.5 ⭐

• new(Parent, Message) -> wxTextEntryDialog() — constructor that takes the parent window and the message 💖

Types:

Parent = wxWindow:wxWindow()
Message = unicode:chardata()

• new(Parent, Message, Options :: [Option]) -> wxTextEntryDialog() — the full-glam constructor, now with options 🔥

Types:

Parent = wxWindow:wxWindow()
Message = unicode:chardata()
Option =
    {caption, unicode:chardata()} |
    {value, unicode:chardata()} |
    {style, integer()} |
    {pos, {X :: integer(), Y :: integer()}}

Constructor.

Use wxDialog:showModal/1 to show the dialog — that's how you actually make it appear, bestie 👀

See Create() (not implemented in wx) method for parameter description. (iykyk, the docs live over there 🫡)

• destroy(This :: wxTextEntryDialog()) -> ok — Destructor 🧹 bye babes
• getValue(This) -> unicode:charlist() — the reader 💅

Types:

This = wxTextEntryDialog()

Returns the text that the user has entered if the user has pressed OK, or the original value if the user has pressed Cancel. so basically Cancel = "we're keeping the old one, no thoughts" 😭

• setValue(This, Value) -> ok — the writer ✍️

Types:

This = wxTextEntryDialog()
Value = unicode:chardata()

Sets the default text value. pre-fill it, manifest it, slay 🌸

---

ok that's the whole page, every single option and type is here, you're so welcome 💖

---

mwah, tysm for reading bestie 🫶 this page was brought to you by the wxWidgets team, version wx 2.2.2.1, and wxTextEntryDialog(3erl) — periodt. 💅✨🎀