wxDirDialog(3erl)

💖 wxDirDialog 💖

okay so welcome to the wxDirDialog(3erl) page — Erlang Module Definition — and it's literally the manual for the directory chooser dialog. the way that this is main character energy for a dialog class? iconic, no cap. vibe check: passed. 💅

🌸 NAME 🌸

wxDirDialog — Functions for wxDirDialog class. periodt. 💅

✨ DESCRIPTION ✨

This class? It represents the directory chooser dialog. obsessed.

🎀 Styles 🎀

This class supports the following styles:

⚠️ Note: this flag cannot be used with the wxDD_MULTIPLE style.

🌈 Remark: MacOS 10.11+ does not display a title bar on the dialog. Use setMessage/2 to change the string displayed to the user at the top of the dialog after creation. The wxTopLevelWindow:setTitle/2 method is provided for compatibility with pre-10.11 MacOS versions that do still support displaying the title bar.

👀 See: Overview cmndlg, wxFileDialog.

Highkey, this class is derived (and can use functions) from: wxDialog wxTopLevelWindow wxWindow wxEvtHandler.

📚 wxWidgets docs: wxDirDialog.

🦋 DATA TYPES 🦋

wxDirDialog() = wx:wx_object()

👑 EXPORTS 👑

💅 new(Parent) -> wxDirDialog()

Types:

Parent = wxWindow:wxWindow()

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

Types:

Parent = wxWindow:wxWindow()
Option =
    {title, unicode:chardata()} |
    {defaultPath, unicode:chardata()} |
    {style, integer()} |
    {pos, {X :: integer(), Y :: integer()}} |
    {sz, {W :: integer(), H :: integer()}}

Constructor. Use wxDialog:showModal/1 to show the dialog. slay.

💅 destroy(This :: wxDirDialog()) -> ok

Destructor.

💅 getPath(This) -> unicode:charlist()

Types:

This = wxDirDialog()

Returns the default or user-selected path.

⚠️ Note: This function can't be used with dialogs which have the wxDD_MULTIPLE style, use GetPaths() (not implemented in wx) instead.

💅 getMessage(This) -> unicode:charlist()

Types:

This = wxDirDialog()

Returns the message that will be displayed on the dialog.

💅 setMessage(This, Message) -> ok

Types:

This = wxDirDialog()
Message = unicode:chardata()

Sets the message that will be displayed on the dialog.

💅 setPath(This, Path) -> ok

Types:

This = wxDirDialog()
Path = unicode:chardata()

Sets the default path.

---

okay that's the whole glow-up. Signed off by the wxWidgets team, version wx 2.2.2.1, page wxDirDialog(3erl) — that's the footer, bestie, and there's no extra date hiding in it. 💖