wxDirPickerCtrl(3)

NAME
wxDirPickerCtrl - This control allows the user to select a directory.

DESCRIPTION

The generic implementation is a button which brings up a wxDirDialog when clicked. Native implementation may differ but this is usually a (small) widget which give access to the dir-chooser dialog. It is only available if wxUSE_DIRPICKERCTRL is set to 1 (the default).

  Styles

This class supports the following styles:

    • wxDIRP_DEFAULT_STYLE: The default style: includes wxDIRP_DIR_MUST_EXIST and, under wxMSW only, wxDIRP_USE_TEXTCTRL.

    • wxDIRP_USE_TEXTCTRL: Creates a text control to the left of the picker button which is completely managed by the wxDirPickerCtrl and which can be used by the user to specify a path (see SetPath). The text control is automatically synchronized with button's value. Use functions defined in wxPickerBase to modify the text control.

    • wxDIRP_DIR_MUST_EXIST: Creates a picker which allows selecting only existing directories in the popup wxDirDialog. Notice that, as with wxFLP_FILE_MUST_EXIST, it is still possible to enter a non-existent directory even when this file is specified if wxDIRP_USE_TEXTCTRL style is also used. Also note that if wxDIRP_USE_TEXTCTRL is not used, the native wxGTK implementation always uses this style as it doesn't support selecting non-existent directories.

    • wxDIRP_CHANGE_DIR: Change current working directory on each user directory selection change.

    • wxDIRP_SMALL: Use smaller version of the control with a small "..." button instead of the normal "Browse" one. This flag is new since wxWidgets 2.9.3.

See:

    • wxDirDialog

    • wxFileDirPickerEvent

This class is derived, and can use functions, from:

    • wxPickerBase

    • wxControl

    • wxWindow

    • wxEvtHandler

wxWidgets docs: wxDirPickerCtrl

  Events

Event types emitted from this class:

    • command_dirpicker_changed

DATA TYPES

wxDirPickerCtrl() :: wx:wx_object().

FUNCTIONS

create(This, Parent, Id, [Option]) -> boolean() when This :: wxDirPickerCtrl(), Parent :: wxWindow:wxWindow(), Id :: integer(), Option :: {path, unicode:chardata()} | {message, unicode:chardata()} | {pos, {X :: integer(), Y :: integer()}} | {size, {W :: integer(), H :: integer()}} | {style, integer()} | {validator, wx:wx_object()}.

    Creates the widgets with the given parameters.

    Return: true if the control was successfully created or false if creation failed.
destroy(This :: wxDirPickerCtrl()) -> ok.

    Destroys the object
getPath(This) -> unicode:charlist() when This :: wxDirPickerCtrl().

    Returns the absolute path of the currently selected directory.
new() -> wxDirPickerCtrl().
new(Parent, Id, [Option]) -> wxDirPickerCtrl() when Parent :: wxWindow:wxWindow(), Id :: integer(), Option :: {path, unicode:chardata()} | {message, unicode:chardata()} | {pos, {X :: integer(), Y :: integer()}} | {size, {W :: integer(), H :: integer()}} | {style, integer()} | {validator, wx:wx_object()}.

    Initializes the object and calls create/4 with all the parameters.
setPath(This, Dirname) -> ok when This :: wxDirPickerCtrl(), Dirname :: unicode:chardata().

    Sets the absolute path of the currently selected directory.

    If the control uses wxDIRP_DIR_MUST_EXIST and does not use wxDIRP_USE_TEXTCTRL style, the dirname must be a name of an existing directory and will be simply ignored by the native wxGTK implementation if this is not the case.