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

NAME

6       wxFilePickerCtrl - Functions for wxFilePickerCtrl class
7

DESCRIPTION

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

EVENTS

27       Event types emitted from this class: command_filepicker_changed
28

DATA TYPES

30       wxFilePickerCtrl() = wx:wx_object()
31

EXPORTS

33       new() -> wxFilePickerCtrl()
34
35       new(Parent, Id) -> wxFilePickerCtrl()
36
37              Types:
38
39                 Parent = wxWindow:wxWindow()
40                 Id = integer()
41
42       new(Parent, Id, Options :: [Option]) -> wxFilePickerCtrl()
43
44              Types:
45
46                 Parent = wxWindow:wxWindow()
47                 Id = integer()
48                 Option =
49                     {path, unicode:chardata()} |
50                     {message, unicode:chardata()} |
51                     {wildcard, unicode:chardata()} |
52                     {pos, {X :: integer(), Y :: integer()}} |
53                     {size, {W :: integer(), H :: integer()}} |
54                     {style, integer()} |
55                     {validator, wx:wx_object()}
56
57              Initializes the object and calls create/4 with all  the  parame‐
58              ters.
59
60       create(This, Parent, Id) -> boolean()
61
62              Types:
63
64                 This = wxFilePickerCtrl()
65                 Parent = wxWindow:wxWindow()
66                 Id = integer()
67
68       create(This, Parent, Id, Options :: [Option]) -> boolean()
69
70              Types:
71
72                 This = wxFilePickerCtrl()
73                 Parent = wxWindow:wxWindow()
74                 Id = integer()
75                 Option =
76                     {path, unicode:chardata()} |
77                     {message, unicode:chardata()} |
78                     {wildcard, unicode:chardata()} |
79                     {pos, {X :: integer(), Y :: integer()}} |
80                     {size, {W :: integer(), H :: integer()}} |
81                     {style, integer()} |
82                     {validator, wx:wx_object()}
83
84              Creates this widget with the given parameters.
85
86              Return: true if the control was successfully created or false if
87              creation failed.
88
89       getPath(This) -> unicode:charlist()
90
91              Types:
92
93                 This = wxFilePickerCtrl()
94
95              Returns the absolute path of the currently selected file.
96
97       setPath(This, Filename) -> ok
98
99              Types:
100
101                 This = wxFilePickerCtrl()
102                 Filename = unicode:chardata()
103
104              Sets the absolute path of the currently selected file.
105
106              If the control  uses  wxFLP_FILE_MUST_EXIST  and  does  not  use
107              wxFLP_USE_TEXTCTRL  style, the filename must be a name of an ex‐
108              isting file and will be simply ignored by the native  wxGTK  im‐
109              plementation if this is not the case (the generic implementation
110              used under the other platforms accepts even invalid  file  names
111              currently,  but  this  is subject to change in the future, don't
112              rely on being able to use non-existent paths with it).
113
114       destroy(This :: wxFilePickerCtrl()) -> ok
115
116              Destroys the object.
117
118
119
120wxWidgets team.                     wx 2.1                 wxFilePickerCtrl(3)