oracular (3) wxFilePickerCtrl.3erl.gz

NAME

       wxFilePickerCtrl - Functions for wxFilePickerCtrl class

DESCRIPTION

       This  control  allows the user to select a file. The generic implementation is a button which brings up a
       wxFileDialog when clicked. Native implementation may differ but this is usually a  (small)  widget  which
       give  access  to  the  file-chooser dialog. It is only available if wxUSE_FILEPICKERCTRL is set to 1 (the
       default).

       Styles

       This class supports the following styles:

       See: wxFileDialog, wxFileDirPickerEvent

       This class is derived (and can use functions) from: wxPickerBase wxControl wxWindow wxEvtHandler

       wxWidgets docs: wxFilePickerCtrl

EVENTS

       Event types emitted from this class: command_filepicker_changed

DATA TYPES

       wxFilePickerCtrl() = wx:wx_object()

EXPORTS

       new() -> wxFilePickerCtrl()

       new(Parent, Id) -> wxFilePickerCtrl()

              Types:

                 Parent = wxWindow:wxWindow()
                 Id = integer()

       new(Parent, Id, Options :: [Option]) -> wxFilePickerCtrl()

              Types:

                 Parent = wxWindow:wxWindow()
                 Id = integer()
                 Option =
                     {path, unicode:chardata()} |
                     {message, unicode:chardata()} |
                     {wildcard, 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.

       create(This, Parent, Id) -> boolean()

              Types:

                 This = wxFilePickerCtrl()
                 Parent = wxWindow:wxWindow()
                 Id = integer()

       create(This, Parent, Id, Options :: [Option]) -> boolean()

              Types:

                 This = wxFilePickerCtrl()
                 Parent = wxWindow:wxWindow()
                 Id = integer()
                 Option =
                     {path, unicode:chardata()} |
                     {message, unicode:chardata()} |
                     {wildcard, unicode:chardata()} |
                     {pos, {X :: integer(), Y :: integer()}} |
                     {size, {W :: integer(), H :: integer()}} |
                     {style, integer()} |
                     {validator, wx:wx_object()}

              Creates this widget with the given parameters.

              Return: true if the control was successfully created or false if creation failed.

       getPath(This) -> unicode:charlist()

              Types:

                 This = wxFilePickerCtrl()

              Returns the absolute path of the currently selected file.

       setPath(This, Filename) -> ok

              Types:

                 This = wxFilePickerCtrl()
                 Filename = unicode:chardata()

              Sets the absolute path of the currently selected file.

              If the control uses wxFLP_FILE_MUST_EXIST and does not use wxFLP_USE_TEXTCTRL style, the  filename
              must  be  a name of an existing file and will be simply ignored by the native wxGTK implementation
              if this is not the case (the generic implementation used under the other  platforms  accepts  even
              invalid  file  names  currently,  but this is subject to change in the future, don't rely on being
              able to use non-existent paths with it).

       destroy(This :: wxFilePickerCtrl()) -> ok

              Destroys the object.