wxruby3 1.6.1 → 1.7.0

data/lib/wx/doc/gen/file_dialog.rb

@@ -0,0 +1,353 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  FD_DEFAULT_STYLE = 1
+  
+  # 
+  OSX_FILEDIALOG_ALWAYS_SHOW_TYPES = "osx.openfiledialog.always-show-types"
+  
+  # 
+  # 
+  FD_OPEN = 1
+  
+  # 
+  # 
+  FD_SAVE = 2
+  
+  # 
+  # 
+  FD_OVERWRITE_PROMPT = 4
+  
+  # 
+  # 
+  FD_NO_FOLLOW = 8
+  
+  # 
+  # 
+  FD_FILE_MUST_EXIST = 16
+  
+  # 
+  # 
+  FD_CHANGE_DIR = 128
+  
+  # 
+  # 
+  FD_PREVIEW = 256
+  
+  # 
+  # 
+  FD_MULTIPLE = 512
+  
+  # 
+  # 
+  FD_SHOW_HIDDEN = 1024
+  
+  # Default wildcard string used in {Wx::FileDialog} corresponding to all files.
+  # 
+  FILE_SELECTOR_DEFAULT_WILDCARD_STR = "*"
+  
+  # This class represents the file chooser dialog.
+  # 
+  # The path and filename are distinct elements of a full file pathname. If path is {Wx::EmptyString}, the current directory will be used. If filename is {Wx::EmptyString}, no default filename will be supplied. The wildcard determines what files are displayed in the file selector, and file extension supplies a type extension for the required filename.
+  # The typical usage for the open file dialog is: 
+  # ```ruby
+  # class MyFrame
+  #   ...
+  #   def on_open(event)
+  #     if (...current content has not been saved...)
+  #       if Wx.message_box('Current content has not been saved! Proceed?', 'Please confirm',
+  #                         Wx::ICON_QUESTION | Wx::YES_NO, self) == Wx::NO
+  #         return 
+  #       #else: proceed asking to the user the new file to open
+  #       end
+  #     end
+  #   
+  #     Wx::FileDialog(self, "Open XYZ file", "", "",
+  #                         "XYZ files (*.xyz)|*.xyz", Wx::FD_OPEN|Wx::FD_FILE_MUST_EXIST) do |dlg|
+  #       return if dlg.show_modal == Wx::ID_CANCEL # the user changed idea...?
+  # 
+  #       # proceed loading the file chosen by the user
+  #       file = File.open(dlg.path, 'r') rescue nil
+  #       unless file
+  #          Wx.log_error("Cannot open file '#{dlg.path}'.")
+  #          return
+  #       end
+  #       ...
+  #     end
+  #   end
+  # 
+  # end
+  # ```
+  # 
+  # The typical usage for the save file dialog is instead somewhat simpler: 
+  # ```ruby
+  # class MyFrame
+  #   ...
+  #   def on_save_as(event)
+  #     Wx::FileDialog(self, "Save XYZ file", "", "",
+  #                         "XYZ files (*.xyz)|*.xyz", Wx::FD_SAVE|Wx::FD_OVERWRITE_PROMPT) do |dlg|
+  #       return if dlg.show_modal == Wx::ID_CANCEL # the user changed idea...?
+  #   
+  #       # save the current contents in the file
+  #       begin
+  #         File.open(dlg.path, 'w+') do |f|
+  #           # save to file
+  #         end
+  #       rescue 
+  #         Wx.log_error("Cannot save current contents in file '#{dlg.path}'.")
+  #         return
+  #       end
+  #     end
+  #     ...
+  #   end
+  # 
+  # end
+  # ```
+  # 
+  # ## Wildcard Filters
+  # All implementations of the {Wx::FileDialog} provide a wildcard filter. Typing a filename containing wildcards (*, ?) in the filename text item, and clicking on Ok, will result in only those files matching the pattern being displayed. The wildcard may be a specification for multiple types of file with a description for each, such as: 
+  # ```
+  #   "BMP and GIF files (*.bmp;*.gif)|*.bmp;*.gif|PNG files (*.png)|*.png"
+  # ```
+  # 
+  # On Mac macOS in the open file dialog the filter choice box is not shown by default. Instead all given wildcards are applied at the same time: So in the above example all bmp, gif and png files are displayed. To enforce the display of the filter choice set the corresponding {Wx::SystemOptions} before calling the file open dialog: 
+  # ```ruby
+  #   Wx::SystemOptions.set_option(Wx::OSX_FILEDIALOG_ALWAYS_SHOW_TYPES, 1)
+  # ```
+  #  But in contrast to Windows and Unix, where the file type choice filters only the selected files, on Mac macOS even in this case the dialog shows all files matching all file types. The files which do not match the currently selected file type are greyed out and are not selectable.
+  # 
+  # ## Dialog Customization
+  # Uniquely among the other standard dialogs, {Wx::FileDialog} can be customized by adding extra controls to it. Moreover, there are two ways to do it: the first one is to define a callback function and use {Wx::FileDialog#set_extra_control_creator} to tell the dialog to call it, while the second one requires defining a class inheriting from {Wx::FileDialogCustomizeHook} and implementing its virtual functions, notably {Wx::FileDialogCustomizeHook#add_custom_controls} where the extra controls have to be created, and finally calling {Wx::FileDialog#set_customize_hook} with this custom hook object.
+  # The first approach is somewhat simpler and more flexible, as it allows to create any kind of custom controls, but is not supported by the "new style" (where "new" means used since Windows Vista, i.e. circa 2007) file dialogs under MSW. Because of this, calling {Wx::FileDialog#set_extra_control_creator} in WXMSW forces the use of old style (Windows XP) dialogs, that may look out of place. The second approach is implemented by the MSW dialogs natively and doesn't suffer from this limitation, so its use is recommended, especially if the few simple control types supported by it (see {Wx::FileDialogCustomize} for more information about the supported controls) are sufficient for your needs.
+  # Both of the approaches to the dialog customization are demonstrated in the page_samples_dialogs, please check it for more details.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>New style file dialogs can only be used in WXMSW when the apartment, COM threading model is used. This is the case by default, but if the application initializes COM on its own using multi-threaded model, old style dialogs are used, at least when they must have a parent, as the new style dialog doesn't support this threading model.
+  # </p>
+  # </div>
+  # 
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::FD_DEFAULT_STYLE}: Equivalent to {Wx::FD_OPEN}. 
+  # 
+  # - {Wx::FD_OPEN}: This is an open dialog; usually this means that the default button's label of the dialog is "Open". Cannot be combined with {Wx::FD_SAVE}. 
+  # 
+  # - {Wx::FD_SAVE}: This is a save dialog; usually this means that the default button's label of the dialog is "Save". Cannot be combined with {Wx::FD_OPEN}. 
+  # 
+  # - {Wx::FD_OVERWRITE_PROMPT}: For save dialog only: prompt for a confirmation if a file will be overwritten. This style is always enabled on WXOSX and cannot be disabled. 
+  # 
+  # - {Wx::FD_NO_FOLLOW}: Directs the dialog to return the path and file name of the selected shortcut file, not its target as it does by default. Currently this flag is only implemented in WXMSW and WXOSX (where it prevents aliases from being resolved). The non-dereferenced link path is always returned, even without this flag, under Unix and so using it there doesn't do anything. This flag was added in wxWidgets 3.1.0. 
+  # 
+  # - {Wx::FD_FILE_MUST_EXIST}: For open dialog only: the user may only select files that actually exist. Notice that under macOS the file dialog with {Wx::FD_OPEN} style always behaves as if this style was specified, because it is impossible to choose a file that doesn't exist from a standard macOS file dialog. 
+  # 
+  # - {Wx::FD_MULTIPLE}: For open dialog only: allows selecting multiple files. 
+  # 
+  # - {Wx::FD_CHANGE_DIR}: Change the current working directory (when the dialog is dismissed) to the directory where the file(s) chosen by the user are. 
+  # 
+  # - {Wx::FD_PREVIEW}: Show the preview of the selected files (currently only supported by WXGTK). 
+  # 
+  # - {Wx::FD_SHOW_HIDDEN}: Show hidden files. This flag was added in wxWidgets 3.1.3 
+  # 
+  # Category:  Common Dialogs
+  # @see wxFileDialog Overview
+  # @see  file_selector 
+  # 
+  # 
+  # @wxrb_require USE_FILEDLG
+  class FileDialog < Dialog
+  
+    # @overload initialize(parent, message=Wx::FILE_SELECTOR_PROMPT_STR, defaultDir=(''), defaultFile=(''), wildcard=Wx::FILE_SELECTOR_DEFAULT_WILDCARD_STR, style=Wx::FD_DEFAULT_STYLE, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, name=Wx::FILE_DIALOG_NAME_STR)
+    #   Constructor.
+    #   
+    #   Use {Wx::FileDialog#show_modal} to show the dialog.
+    #   @param parent [Wx::Window]  Parent window.
+    #   @param message [String]  Message to show on the dialog.
+    #   @param defaultDir [String]  The default directory, or the empty string.
+    #   @param defaultFile [String]  The default filename, or the empty string.
+    #   @param wildcard [String]  A wildcard, such as "*.*" or "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".
+    #   @param style [Integer]  A dialog style. See <code>wxFD_*</code> styles for more info.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Dialog position. Not implemented.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Dialog size. Not implemented.
+    #   @param name [String]  Dialog name. Not implemented.
+    #   @return [Wx::FileDialog]
+    # @overload initialize(parent, message=Wx::FILE_SELECTOR_PROMPT_STR, defaultDir=(''), defaultFile=(''), wildcard=Wx::FILE_SELECTOR_DEFAULT_WILDCARD_STR, style=Wx::FD_DEFAULT_STYLE, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, name=Wx::FILE_DIALOG_NAME_STR, &block)
+    #   Constructor.
+    #   
+    #   Use {Wx::FileDialog#show_modal} to show the dialog.
+    #   @param parent [Wx::Window]  Parent window.
+    #   @param message [String]  Message to show on the dialog.
+    #   @param defaultDir [String]  The default directory, or the empty string.
+    #   @param defaultFile [String]  The default filename, or the empty string.
+    #   @param wildcard [String]  A wildcard, such as "*.*" or "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".
+    #   @param style [Integer]  A dialog style. See <code>wxFD_*</code> styles for more info.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Dialog position. Not implemented.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Dialog size. Not implemented.
+    #   @param name [String]  Dialog name. Not implemented.
+    #   @yieldparam [Wx::FileDialog] win new instance
+    #   @return [Wx::FileDialog]
+    def initialize(*args) end
+    
+    # Returns the path of the file currently selected in dialog.
+    # 
+    # Notice that this file is not necessarily going to be accepted by the user, so calling this function mostly makes sense from an update UI event handler of a custom file dialog extra control to update its state depending on the currently selected file.
+    # Currently this function is fully implemented under GTK and MSW and always returns an empty string elsewhere.
+    # 
+    # The path of the currently selected file or an empty string if nothing is selected.
+    # @see Wx::FileDialog#set_extra_control_creator 
+    # @return [String]
+    def get_currently_selected_filename; end
+    alias_method :currently_selected_filename, :get_currently_selected_filename
+    
+    # Returns the file type filter index currently selected in dialog.
+    # 
+    # Notice that this file type filter is not necessarily going to be the one finally accepted by the user, so calling this function mostly makes sense from an update UI event handler of a custom file dialog extra control to update its state depending on the currently selected file type filter.
+    # Currently this function is fully implemented under macOS and MSW and always returns {Wx::NOT_FOUND} elsewhere.
+    # 
+    # The 0-based index of the currently selected file type filter or {Wx::NOT_FOUND} if nothing is selected.
+    # @see Wx::FileDialog#set_extra_control_creator 
+    # 
+    # @see Wx::FileDialog#get_filter_index 
+    # 
+    # @see Wx::FileDialog#set_filter_index 
+    # @return [Integer]
+    def get_currently_selected_filter_index; end
+    alias_method :currently_selected_filter_index, :get_currently_selected_filter_index
+    
+    # Returns the default directory.
+    # @return [String]
+    def get_directory; end
+    alias_method :directory, :get_directory
+    
+    # If functions {Wx::FileDialog#set_extra_control_creator} and {Wx::FileDialog#show_modal} were called, returns the extra window.
+    # 
+    # Otherwise returns nil.
+    # @return [Wx::Window]
+    def get_extra_control; end
+    alias_method :extra_control, :get_extra_control
+    
+    # Returns the default filename.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This function can't be used with dialogs which have the {Wx::FD_MULTIPLE} style, use {Wx::FileDialog#get_filenames} instead. 
+    # </p>
+    # </div>
+    # @return [String]
+    def get_filename; end
+    alias_method :filename, :get_filename
+    
+    # Fills the array filenames with the names of the files chosen.
+    # 
+    # This function should only be used with the dialogs which have {Wx::FD_MULTIPLE} style, use {Wx::FileDialog#get_filename} for the others.
+    # Note that under Windows, if the user selects shortcuts, the filenames include paths, since the application cannot determine the full path of each referenced file by appending the directory containing the shortcuts to the filename.
+    # @return [Array<String>]
+    def get_filenames; end
+    alias_method :filenames, :get_filenames
+    
+    # Returns the index into the list of filters supplied, optionally, in the wildcard parameter.
+    # 
+    # Before the dialog is shown, this is the index which will be used when the dialog is first displayed.
+    # After the dialog is shown, this is the index selected by the user.
+    # @return [Integer]
+    def get_filter_index; end
+    alias_method :filter_index, :get_filter_index
+    
+    # Returns the message that will be displayed on the dialog.
+    # @return [String]
+    def get_message; end
+    alias_method :message, :get_message
+    
+    # Returns the full path (directory and filename) of the selected file.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This function can't be used with dialogs which have the {Wx::FD_MULTIPLE} style, use {Wx::FileDialog#get_paths} instead. 
+    # </p>
+    # </div>
+    # @return [String]
+    def get_path; end
+    alias_method :path, :get_path
+    
+    # Fills the array paths with the full paths of the files chosen.
+    # 
+    # This function should only be used with the dialogs which have {Wx::FD_MULTIPLE} style, use {Wx::FileDialog#get_path} for the others.
+    # @return [Array<String>]
+    def get_paths; end
+    alias_method :paths, :get_paths
+    
+    # Returns the file dialog wildcard.
+    # @return [String]
+    def get_wildcard; end
+    alias_method :wildcard, :get_wildcard
+    
+    # Set the hook to be used for customizing the dialog contents.
+    # 
+    # This function can be called before calling {Wx::FileDialog#show_modal} to specify that the dialog contents should be customized using the provided hook. See {Wx::FileDialogCustomizeHook} documentation and page_samples_dialogs for the examples of using it.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>In order to define a custom hook object, <code>Wx::/filedlgcustomize.h</code> must be included in addition to the usual <code>Wx::/filedlg.h</code> header.
+    # </p>
+    # </div>
+    # 
+    # true if the hook was successfully set or false if customizing the file dialog is not supported by the current platform.
+    # @param customizeHook [Wx::FileDialogCustomizeHook]  The hook object that will be used by the dialog. This object must remain valid at least until {Wx::FileDialog#show_modal} returns.
+    # @return [Boolean]
+    def set_customize_hook(customizeHook) end
+    alias_method :customize_hook=, :set_customize_hook
+    
+    # Sets the default directory.
+    # @param directory [String] 
+    # @return [void]
+    def set_directory(directory) end
+    alias_method :directory=, :set_directory
+    
+    # Sets the default filename.
+    # 
+    # In WXGTK this will have little effect unless a default directory has previously been set.
+    # @param setfilename [String] 
+    # @return [void]
+    def set_filename(setfilename) end
+    alias_method :filename=, :set_filename
+    
+    # Sets the default filter index, starting from zero.
+    # @param filterIndex [Integer] 
+    # @return [void]
+    def set_filter_index(filterIndex) end
+    alias_method :filter_index=, :set_filter_index
+    
+    # Sets the message that will be displayed on the dialog.
+    # @param message [String] 
+    # @return [void]
+    def set_message(message) end
+    alias_method :message=, :set_message
+    
+    # Sets the path (the combined directory and filename that will be returned when the dialog is dismissed).
+    # @param path [String] 
+    # @return [void]
+    def set_path(path) end
+    alias_method :path=, :set_path
+    
+    # Sets the wildcard, which can contain multiple file types, for example: "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".
+    # @param wildCard [String] 
+    # @return [void]
+    def set_wildcard(wildCard) end
+    alias_method :wildcard=, :set_wildcard
+    
+    # Shows the dialog, returning {Wx::StandardID::ID_OK} if the user pressed OK, and {Wx::StandardID::ID_CANCEL} otherwise.
+    # @return [Integer]
+    def show_modal; end
+    
+  end # FileDialog
+  
+
+end

data/lib/wx/doc/gen/file_dialog_custom_control.rb

@@ -0,0 +1,165 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # The base class for all {Wx::FileDialog} custom controls.
+  # 
+  # Unlike normal controls, inheriting from {Wx::Window}, custom controls in {Wx::FileDialog} are not actual windows, but they do provide some window-like operations, and can be disabled or hidden, just as the windows are.
+  # Also, similarly to the normal windows, objects of this and derived classes belong to wxWidgets and must not be deleted by the application code.
+  # Unlike windows, custom controls cannot be created directly, but can only be returned from {Wx::FileDialogCustomize} functions that are specifically provided for creating them.
+  # 
+  # @wxrb_require USE_FILEDLG
+  class FileDialogCustomControl < EvtHandler
+  
+    # Show or hide this control.
+    # @param show [Boolean] 
+    # @return [void]
+    def show(show=true) end
+    
+    # Hide this control.
+    # 
+    # This is equivalent to <code>Show(false)</code>.
+    # @return [void]
+    def hide; end
+    
+    # Enable or disable this control.
+    # @param enable [Boolean] 
+    # @return [void]
+    def enable(enable=true) end
+    
+    # Disable this control.
+    # 
+    # This is equivalent to <code>Enable(false)</code>.
+    # @return [void]
+    def disable; end
+    
+  end # FileDialogCustomControl
+  
+  # Represents a custom button inside {Wx::FileDialog}.
+  # 
+  # Objects of this class can only be created by {Wx::FileDialogCustomize#add_button}.
+  # It is possible to bind to {Wx::EVT_BUTTON} events on this object, which will be generated when the button is clicked.
+  # See {Wx::FileDialogCustomControl} for more information.
+  # 
+  # @wxrb_require USE_FILEDLG
+  class FileDialogButton < FileDialogCustomControl
+  
+  end # FileDialogButton
+  
+  # Represents a custom checkbox inside {Wx::FileDialog}.
+  # 
+  # Objects of this class can only be created by {Wx::FileDialogCustomize#add_check_box}.
+  # It is possible to bind to {Wx::EVT_CHECKBOX} events on this object, which will be generated when the checkbox is clicked.
+  # See {Wx::FileDialogCustomControl} for more information.
+  # 
+  # @wxrb_require USE_FILEDLG
+  class FileDialogCheckBox < FileDialogCustomControl
+  
+    # Return true if the checkbox is checked.
+    # @return [Boolean]
+    def get_value; end
+    alias_method :value, :get_value
+    
+    # Check or uncheck the checkbox.
+    # @param value [Boolean] 
+    # @return [void]
+    def set_value(value) end
+    alias_method :value=, :set_value
+    
+  end # FileDialogCheckBox
+  
+  # Represents a custom radio button inside {Wx::FileDialog}.
+  # 
+  # Objects of this class can only be created by {Wx::FileDialogCustomize#add_radio_button}.
+  # It is possible to bind to {Wx::EVT_RADIOBUTTON} events on this object, which will be generated when the radio button is selected.
+  # See {Wx::FileDialogCustomControl} for more information.
+  # 
+  # @wxrb_require USE_FILEDLG
+  class FileDialogRadioButton < FileDialogCustomControl
+  
+    # Return true if the radio button is selected.
+    # @return [Boolean]
+    def get_value; end
+    alias_method :value, :get_value
+    
+    # Select the value of the radio button.
+    # 
+    # Using false for value is not supported, this argument only exists for consistency with {Wx::RadioButton#set_value}.
+    # @param value [Boolean] 
+    # @return [void]
+    def set_value(value) end
+    alias_method :value=, :set_value
+    
+  end # FileDialogRadioButton
+  
+  # Represents a custom read-only combobox inside {Wx::FileDialog}.
+  # 
+  # Objects of this class can only be created by {Wx::FileDialogCustomize#add_choice}.
+  # It is possible to bind to {Wx::EVT_CHOICE} events on this object, which will be generated when the selection in the combobox changes.
+  # See {Wx::FileDialogCustomControl} for more information.
+  # 
+  # @wxrb_require USE_FILEDLG
+  class FileDialogChoice < FileDialogCustomControl
+  
+    # Return the index of the selected item, possibly {Wx::NOT_FOUND}.
+    # @return [Integer]
+    def get_selection; end
+    alias_method :selection, :get_selection
+    
+    # Set the selection to the item with the given index.
+    # 
+    # Using {Wx::NOT_FOUND} for n is not supported, once a selection is made it cannot be undone.
+    # @param n [Integer] 
+    # @return [void]
+    def set_selection(n) end
+    alias_method :selection=, :set_selection
+    
+  end # FileDialogChoice
+  
+  # Represents a custom text control inside {Wx::FileDialog}.
+  # 
+  # Objects of this class can only be created by {Wx::FileDialogCustomize#add_text_ctrl}.
+  # Objects of this class don't generate any events currently.
+  # See {Wx::FileDialogCustomControl} for more information.
+  # 
+  # @wxrb_require USE_FILEDLG
+  class FileDialogTextCtrl < FileDialogCustomControl
+  
+    # Get the current value entered into the control.
+    # @return [String]
+    def get_value; end
+    alias_method :value, :get_value
+    
+    # Set the current control value.
+    # @param text [String] 
+    # @return [void]
+    def set_value(text) end
+    alias_method :value=, :set_value
+    
+  end # FileDialogTextCtrl
+  
+  # Represents a custom static text inside {Wx::FileDialog}.
+  # 
+  # Objects of this class can only be created by {Wx::FileDialogCustomize#add_static_text}.
+  # Objects of this class don't generate any events.
+  # See {Wx::FileDialogCustomControl} for more information.
+  # 
+  # @wxrb_require USE_FILEDLG
+  class FileDialogStaticText < FileDialogCustomControl
+  
+    # Set the text shown in the label.
+    # 
+    # Any ampersands in the text will be escaped, there is no need to do it manually, e.g. using {Wx::Control.escape_mnemonics}.
+    # @param text [String] 
+    # @return [void]
+    def set_label_text(text) end
+    alias_method :label_text=, :set_label_text
+    
+  end # FileDialogStaticText
+  
+
+end

data/lib/wx/doc/gen/file_dialog_customize_hook.rb

@@ -0,0 +1,158 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Base class for customization hooks used with {Wx::FileDialog}.
+  # 
+  # {Wx::FileDialogCustomizeHook} is an abstract base class, i.e. in order to use a concrete class inheriting from it and implementing its pure virtual {Wx::FileDialogCustomizeHook#add_custom_controls} function must be defined. Then an object of this class should be passed to {Wx::FileDialog#set_customize_hook}, which will result in its {Wx::FileDialogCustomizeHook#add_custom_controls} being called before the dialog is shown, {Wx::FileDialogCustomizeHook#update_custom_controls} being called whenever something changes in the dialog while it is shown and, finally, {Wx::FileDialogCustomizeHook#transfer_data_from_custom_controls} being called when the user accepts their choice in the dialog.
+  # Putting all this together, here is an example of customizing the file dialog using this class: 
+  # ```ruby
+  # class EncryptHook < Wx::FileDialogCustomizeHook
+  # 
+  #   attr_reader :encrypt
+  # 
+  #   # Override to add custom controls using the provided customizer object.
+  #   def add_custom_controls(customizer)
+  #     # Suppose we can encrypt files when saving them.
+  #     @checkbox = customizer.add_check_box('Encrypt')
+  # 
+  #     # While @checkbox is not a Wx::CheckBox, it looks almost like one
+  #     # and, in particular, we can bind to custom control events as usual.
+  #     @checkbox.evt_checkbox(Wx::ID_ANY) do |event| 
+  #        # We can also call Wx::Window-like functions on them.
+  #        @button.enable(event.checked?)
+  #     end
+  # 
+  #     # The encryption parameters can be edited in a dedicated dialog.
+  #     @button = customizer.add_button('Parameters...')
+  #     @button.evt_button(Wx::ID_ANY) do |event|
+  #        # ... show the encryption parameters dialog here ...
+  #     end
+  #   end
+  # 
+  #   # Override to save the values of the custom controls.
+  #   def transfer_data_from_custom_controls 
+  #     # Save the checkbox value, as we won't be able to use it any more
+  #     # once this function returns.
+  #     @encrypt = @checkbox.get_value
+  #   end
+  # 
+  # end
+  # 
+  # # ...
+  # 
+  # def some_method
+  #   Wx.FileDialog(nil, 'Save document', '', 'file.my',
+  #                      'My files (*.my)|*.my',
+  #                      Wx::FD_SAVE | Wx::FD_OVERWRITE_PROMPT) do |dialog|
+  # 
+  #     # This object may be destroyed before the dialog, but must remain
+  #     # alive until #show_modal returns.
+  #     customize_hook = EncryptHook.new
+  #     dialog.set_customize_hook(custom_hook)
+  # 
+  #     if dialog.show_modal == Wx::ID_OK 
+  #       if customize_hook.encrypt 
+  #         # ... save with encryption ...
+  #       else
+  #         # ... save without encryption ...
+  #       end
+  #     end
+  # end
+  # ```
+  # 
+  # Category:  Common Dialogs
+  # @see Wx::FileDialog
+  # 
+  # 
+  # @wxrb_require USE_FILEDLG
+  class FileDialogCustomizeHook < ::Object
+  
+    # Must be overridden to add custom controls to the dialog using the provided customizer object.
+    # 
+    # Call {Wx::FileDialogCustomize} functions to add controls and possibly bind to their events.
+    # Note that there is no possibility to define the custom controls layout, they will appear more or less consecutively, but the exact layout is determined by the current platform.
+    # @param customizer [Wx::FileDialogCustomize] 
+    # @return [void]
+    def add_custom_controls(customizer) end
+    
+    # May be overridden to update the custom controls whenever something changes in the dialog.
+    # 
+    # This function is called when the user selects a file, changes the directory or changes the current filter in the dialog, for example. It can be used to update the custom controls state depending on the currently selected file, for example.
+    # Note that it is not necessarily called when the value of a custom control changes.
+    # Base class version does nothing.
+    # @return [void]
+    def update_custom_controls; end
+    
+    # Should typically be overridden to save the values of the custom controls when the dialog is accepted.
+    # 
+    # Custom controls are destroyed and cannot be used any longer once {Wx::FileDialog#show_modal} returns, so their values must be retrieved in this function, which is called just before this happens.
+    # This function is not called if the user cancels the dialog.
+    # Base class version does nothing.
+    # @return [void]
+    def transfer_data_from_custom_controls; end
+    
+  end # FileDialogCustomizeHook
+  
+  # Used with {Wx::FileDialogCustomizeHook} to add custom controls to {Wx::FileDialog}.
+  # 
+  # An object of this class is passed to {Wx::FileDialogCustomizeHook#add_custom_controls} to allow it to actually add controls to the dialog.
+  # The pointers returned by the functions of this class belong to wxWidgets and should not be deleted by the application, just as {Wx::Window}-derived objects (even if these controls do not inherit from {Wx::Window}). These pointers become invalid when {Wx::FileDialog#show_modal} returns, and the dialog containing them is destroyed, and the latest point at which they can be still used is when {Wx::FileDialogCustomizeHook#transfer_data_from_custom_controls} is called.
+  # 
+  # Category:  Common Dialogs
+  # @see Wx::FileDialog
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_FILEDLG
+  class FileDialogCustomize < ::Object
+  
+    # Add a button with the specified label.
+    # @param label [String] 
+    # @return [Wx::FileDialogButton]
+    def add_button(label) end
+    
+    # Add a checkbox with the specified label.
+    # @param label [String] 
+    # @return [Wx::FileDialogCheckBox]
+    def add_check_box(label) end
+    
+    # Add a radio button with the specified label.
+    # 
+    # The first radio button added will be initially checked. All the radio buttons added immediately after it will become part of the same radio group and will not be checked, but checking any one of them later will uncheck the first button and all the other ones.
+    # If two consecutive but distinct radio groups are required, {Wx::FileDialogCustomize#add_static_text} with an empty label can be used to separate them.
+    # @param label [String] 
+    # @return [Wx::FileDialogRadioButton]
+    def add_radio_button(label) end
+    
+    # Add a read-only combobox with the specified contents.
+    # 
+    # The combobox doesn't have any initial selection, i.e. {Wx::FileDialogChoice#get_selection} returns {Wx::NOT_FOUND}, if some item must be selected, use {Wx::FileDialogChoice#set_selection} explicitly to do it.
+    # @param strings [Array<String>]  A non-null pointer to an array of n strings.
+    # @return [Wx::FileDialogChoice]
+    def add_choice(strings) end
+    
+    # Add a text control with an optional label preceding it.
+    # 
+    # Unlike all the other functions for adding controls, the label parameter here doesn't specify the contents of the text control itself, but rather the label appearing before it. Unlike static controls added by {Wx::FileDialogCustomize#add_static_text}, this label is guaranteed to be immediately adjacent to it.
+    # If label is empty, no label is created.
+    # @param label [String] 
+    # @return [Wx::FileDialogTextCtrl]
+    def add_text_ctrl(label=('')) end
+    
+    # Add a static text with the given contents.
+    # 
+    # The contents of the static text can be updated later, i.e. it doesn't need to be actually static.
+    # @param label [String] 
+    # @return [Wx::FileDialogStaticText]
+    def add_static_text(label) end
+    
+  end # FileDialogCustomize
+  
+
+end