wxGenericDirCtrl(3)

NAME
wxGenericDirCtrl - This control can be used to place a directory listing (with optional files) on an arbitrary window.

DESCRIPTION

The control contains a wxTreeCtrl window representing the directory hierarchy, and optionally, a wxChoice window containing a list of filters.

  Styles

This class supports the following styles:

    • wxDIRCTRL_DIR_ONLY: Only show directories, and not files.

    • wxDIRCTRL_3D_INTERNAL: Use 3D borders for internal controls. This is the default.

    • wxDIRCTRL_SELECT_FIRST: When setting the default path, select the first file in the directory.

    • wxDIRCTRL_SHOW_FILTERS: Show the drop-down filter list.

    • wxDIRCTRL_EDIT_LABELS: Allow the folder and file labels to be editable.

    • wxDIRCTRL_MULTIPLE: Allows multiple files and folders to be selected.

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

    • wxControl

    • wxWindow

    • wxEvtHandler

wxWidgets docs: wxGenericDirCtrl

  Events

Event types emitted from this class:

    • dirctrl_selectionchanged

    • dirctrl_fileactivated

DATA TYPES

wxGenericDirCtrl() :: wx:wx_object().

FUNCTIONS

collapseTree(This) -> ok when This :: wxGenericDirCtrl().

    Collapses the entire tree.
create(This, Parent, [Option]) -> boolean() when This :: wxGenericDirCtrl(), Parent :: wxWindow:wxWindow(), Option :: {id, integer()} | {dir, unicode:chardata()} | {pos, {X :: integer(), Y :: integer()}} | {size, {W :: integer(), H :: integer()}} | {style, integer()} | {filter, unicode:chardata()} | {defaultFilter, integer()}.

    Create function for two-step construction.

    See new/2 for details.
destroy(This :: wxGenericDirCtrl()) -> ok.

    Destroys the object
expandPath(This, Path) -> boolean() when This :: wxGenericDirCtrl(), Path :: unicode:chardata().

    Tries to expand as much of the given path as possible, so that the filename or directory is visible in the tree control.
getDefaultPath(This) -> unicode:charlist() when This :: wxGenericDirCtrl().

    Gets the default path.
getFilePath(This) -> unicode:charlist() when This :: wxGenericDirCtrl().

    Gets selected filename path only (else empty string).

    This function doesn't count a directory as a selection.
getFilter(This) -> unicode:charlist() when This :: wxGenericDirCtrl().

    Returns the filter string.
getFilterIndex(This) -> integer() when This :: wxGenericDirCtrl().

    Returns the current filter index (zero-based).
getPath(This) -> unicode:charlist() when This :: wxGenericDirCtrl().

    Gets the currently-selected directory or filename.
getPath(This, ItemId) -> unicode:charlist() when This :: wxGenericDirCtrl(), ItemId :: integer().

    Gets the path corresponding to the given tree control item.

    Since: 2.9.5
getRootId(This) -> integer() when This :: wxGenericDirCtrl().

    Returns the root id for the tree control.
getTreeCtrl(This) -> wxTreeCtrl:wxTreeCtrl() when This :: wxGenericDirCtrl().

    Returns a pointer to the tree control.
init(This) -> ok when This :: wxGenericDirCtrl().

    Initializes variables.
new() -> wxGenericDirCtrl().

    Default constructor.
new(Parent, [Option]) -> wxGenericDirCtrl() when Parent :: wxWindow:wxWindow(), Option :: {id, integer()} | {dir, unicode:chardata()} | {pos, {X :: integer(), Y :: integer()}} | {size, {W :: integer(), H :: integer()}} | {style, integer()} | {filter, unicode:chardata()} | {defaultFilter, integer()}.

    Main constructor.
reCreateTree(This) -> ok when This :: wxGenericDirCtrl().

    Collapse and expand the tree, thus re-creating it from scratch.

    May be used to update the displayed directory content.
setDefaultPath(This, Path) -> ok when This :: wxGenericDirCtrl(), Path :: unicode:chardata().

    Sets the default path.
setFilter(This, Filter) -> ok when This :: wxGenericDirCtrl(), Filter :: unicode:chardata().

    Sets the filter string.
setFilterIndex(This, N) -> ok when This :: wxGenericDirCtrl(), N :: integer().

    Sets the current filter index (zero-based).
setPath(This, Path) -> ok when This :: wxGenericDirCtrl(), Path :: unicode:chardata().

    Sets the current path.