View Source wxDirDialog (wx v2.4.2)
Functions for wxDirDialog class
This class represents the directory chooser dialog.
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
This class is derived (and can use functions) from: wxDialog
wxTopLevelWindow
wxWindow
wxEvtHandler
wxWidgets docs: wxDirDialog
Summary
Functions
Destructor.
Returns the message that will be displayed on the dialog.
Returns the default or user-selected path.
Constructor.
Sets the message that will be displayed on the dialog.
Sets the default path.
Types
-type wxDirDialog() :: wx:wx_object().
Functions
-spec destroy(This :: wxDirDialog()) -> ok.
Destructor.
-spec getMessage(This) -> unicode:charlist() when This :: wxDirDialog().
Returns the message that will be displayed on the dialog.
-spec getPath(This) -> unicode:charlist() when 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.
-spec new(Parent) -> wxDirDialog() when Parent :: wxWindow:wxWindow().
-spec new(Parent, [Option]) -> wxDirDialog() when 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.
-spec setMessage(This, Message) -> ok when This :: wxDirDialog(), Message :: unicode:chardata().
Sets the message that will be displayed on the dialog.
-spec setPath(This, Path) -> ok when This :: wxDirDialog(), Path :: unicode:chardata().
Sets the default path.