1wxDirPickerCtrl(3)         Erlang Module Definition         wxDirPickerCtrl(3)
2
3
4

NAME

6       wxDirPickerCtrl - Functions for wxDirPickerCtrl class
7

DESCRIPTION

9       This  control allows the user to select a directory. The generic imple‐
10       mentation is a button which brings up a wxDirDialog when  clicked.  Na‐
11       tive  implementation  may  differ  but this is usually a (small) widget
12       which give access to the dir-chooser dialog. It is  only  available  if
13       wxUSE_DIRPICKERCTRL is set to 1 (the default).
14
15       Styles
16
17       This class supports the following styles:
18
19       See: wxDirDialog, wxFileDirPickerEvent
20
21       This class is derived (and can use functions) from: wxPickerBase wxCon‐
22       trol wxWindow wxEvtHandler
23
24       wxWidgets docs: wxDirPickerCtrl
25

EVENTS

27       Event types emitted from this class: command_dirpicker_changed
28

DATA TYPES

30       wxDirPickerCtrl() = wx:wx_object()
31

EXPORTS

33       new() -> wxDirPickerCtrl()
34
35       new(Parent, Id) -> wxDirPickerCtrl()
36
37              Types:
38
39                 Parent = wxWindow:wxWindow()
40                 Id = integer()
41
42       new(Parent, Id, Options :: [Option]) -> wxDirPickerCtrl()
43
44              Types:
45
46                 Parent = wxWindow:wxWindow()
47                 Id = integer()
48                 Option =
49                     {path, unicode:chardata()} |
50                     {message, unicode:chardata()} |
51                     {pos, {X :: integer(), Y :: integer()}} |
52                     {size, {W :: integer(), H :: integer()}} |
53                     {style, integer()} |
54                     {validator, wx:wx_object()}
55
56              Initializes the object and calls create/4 with all  the  parame‐
57              ters.
58
59       create(This, Parent, Id) -> boolean()
60
61              Types:
62
63                 This = wxDirPickerCtrl()
64                 Parent = wxWindow:wxWindow()
65                 Id = integer()
66
67       create(This, Parent, Id, Options :: [Option]) -> boolean()
68
69              Types:
70
71                 This = wxDirPickerCtrl()
72                 Parent = wxWindow:wxWindow()
73                 Id = integer()
74                 Option =
75                     {path, unicode:chardata()} |
76                     {message, unicode:chardata()} |
77                     {pos, {X :: integer(), Y :: integer()}} |
78                     {size, {W :: integer(), H :: integer()}} |
79                     {style, integer()} |
80                     {validator, wx:wx_object()}
81
82              Creates the widgets with the given parameters.
83
84              Return: true if the control was successfully created or false if
85              creation failed.
86
87       getPath(This) -> unicode:charlist()
88
89              Types:
90
91                 This = wxDirPickerCtrl()
92
93              Returns the absolute path of the currently selected directory.
94
95       setPath(This, Dirname) -> ok
96
97              Types:
98
99                 This = wxDirPickerCtrl()
100                 Dirname = unicode:chardata()
101
102              Sets the absolute path of the currently selected directory.
103
104              If the control  uses  wxDIRP_DIR_MUST_EXIST  and  does  not  use
105              wxDIRP_USE_TEXTCTRL  style, the dirname must be a name of an ex‐
106              isting directory and will be simply ignored by the native  wxGTK
107              implementation if this is not the case.
108
109       destroy(This :: wxDirPickerCtrl()) -> ok
110
111              Destroys the object.
112
113
114
115wxWidgets team.                    wx 2.1.4                 wxDirPickerCtrl(3)