wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,229 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A class that can handle events from the windowing system.
+  # 
+  # {Wx::Window} is (and therefore all window classes are) derived from this class.
+  # When events are received, {Wx::EvtHandler} invokes the method listed in the event table using itself as the object. When using multiple inheritance <b>it is imperative that the {Wx::EvtHandler}(-derived) class is the first class inherited</b> such that the this pointer for the overall object will be identical to the this pointer of the {Wx::EvtHandler} portion.
+  # 
+  # Category:  {Wx::Events}
+  # @see How Events are Processed
+  # @see  Wx::EventBlocker
+  # @see  Wx::EventLoopBase 
+  # 
+  # 
+  class EvtHandler < Object
+  
+    # Queue event for a later processing.
+    # 
+    # This method is similar to {Wx::EvtHandler#process_event} but while the latter is synchronous, i.e. the event is processed immediately, before the function returns, this one is asynchronous and returns immediately while the event will be processed at some later time (usually during the next event loop iteration).
+    # Another important difference is that this method takes ownership of the event parameter. This implies that the event (or any of it's member objects) should not be used/changed after the function returns (as it can be handled and subsequently discarded at any moment).
+    # 
+    # Finally, notice that this method automatically wakes up the event loop if it is currently idle by calling {wake_up_idle} so there is no need to do it manually when using it.
+    # @param event [Wx::Event]  A heap-allocated event to be queued, {Wx::EvtHandler#queue_event} takes ownership of it. This parameter shouldn't be nil.
+    # @return [void]
+    def queue_event(event) end
+    
+    # Post an event to be processed later.
+    # 
+    # This function is similar to {Wx::EvtHandler#queue_event}.
+    # Other than {Wx::EvtHandler#queue_event} this method creates a (shallow) copy of event before queueing the copied event. In case (user defined) event classes require deep copying of Ruby member object these classes should override the #initialize_clone method (**NOT** #clone as wxRuby3 does not currently support overriding event class #clone methods).
+    # @param event [Wx::Event]  Event to add to the pending events queue.
+    # @return [void]
+    def add_pending_event(event) end
+    
+    # Try to process the event in this handler and all those chained to it.
+    # 
+    # As explained in {Wx::EvtHandler#process_event} documentation, the event handlers may be chained in a doubly-linked list. This function tries to process the event in this handler (including performing any pre-processing done in {Wx::EvtHandler#try_before}, e.g. applying validators) and all those following it in the chain until the event is processed or the chain is exhausted.
+    # This function is called from {Wx::EvtHandler#process_event} and, in turn, calls {Wx::EvtHandler#try_before} and {Wx::EvtHandler#try_after}. It is not virtual and so cannot be overridden but can, and should, be called to forward an event to another handler instead of {Wx::EvtHandler#process_event} which would result in a duplicate call to {Wx::EvtHandler#try_after}, e.g. resulting in all unprocessed events being sent to the application object multiple times.
+    # 
+    # true if this handler of one of those chained to it processed the event.
+    # @param event [Wx::Event]  Event to process.
+    # @return [Boolean]
+    def process_event_locally(event) end
+    
+    # Processes an event by calling {Wx::EvtHandler#process_event} and handles any exceptions that occur in the process.
+    # 
+    # If an exception is thrown in event handler, {Wx::App::OnExceptionInMainLoop} is called.
+    # 
+    # true if the event was processed, false if no handler was found or an exception was thrown.
+    # @see Wx::Window#handle_window_event 
+    # @param event [Wx::Event]  Event to process.
+    # @return [Boolean]
+    def safely_process_event(event) end
+    
+    # Processes the pending events previously queued using {Wx::EvtHandler#queue_event} or {Wx::EvtHandler#add_pending_event}; you must call this function only if you are sure there are pending events for this handler, otherwise a {Wx::CHECK} will fail.
+    # 
+    # The real processing still happens in {Wx::EvtHandler#process_event} which is called by this function.
+    # Note that this function needs a valid application object (see Wx::AppConsole#get_instance) because {Wx::App} holds the list of the event handlers with pending events and this function manipulates that list.
+    # @return [void]
+    def process_pending_events; end
+    
+    # Deletes all events queued on this event handler using {Wx::EvtHandler#queue_event} or {Wx::EvtHandler#add_pending_event}.
+    # 
+    # Use with care because the events which are deleted are (obviously) not processed and this may have unwanted consequences (e.g. user actions events will be lost).
+    # @return [void]
+    def delete_pending_events; end
+    
+    # Returns a pointer to the user-supplied client data object.
+    # 
+    # 
+    # @see Wx::EvtHandler#set_client_object
+    # @see  Wx::ClientData 
+    # @return [Object]
+    def get_client_object; end
+    alias_method :client_object, :get_client_object
+    
+    # Set the client data object.
+    # 
+    # Any previous object will be deleted.
+    # @see Wx::EvtHandler#get_client_object
+    # @see  Wx::ClientData 
+    # @param data [Object] 
+    # @return [void]
+    def set_client_object(data) end
+    alias_method :client_object=, :set_client_object
+    
+    # Returns true if the event handler is enabled, false otherwise.
+    # 
+    # 
+    # @see Wx::EvtHandler#set_evt_handler_enabled 
+    # @return [Boolean]
+    def get_evt_handler_enabled; end
+    alias_method :evt_handler_enabled, :get_evt_handler_enabled
+    
+    # Returns the pointer to the next handler in the chain.
+    # 
+    # 
+    # @see Wx::EvtHandler#set_next_handler
+    # @see  Wx::EvtHandler#get_previous_handler
+    # @see  Wx::EvtHandler#set_previous_handler
+    # @see  Wx::Window#push_event_handler
+    # @see  Wx::Window#pop_event_handler 
+    # @return [Wx::EvtHandler]
+    def get_next_handler; end
+    alias_method :next_handler, :get_next_handler
+    
+    # Returns the pointer to the previous handler in the chain.
+    # 
+    # 
+    # @see Wx::EvtHandler#set_previous_handler
+    # @see  Wx::EvtHandler#get_next_handler
+    # @see  Wx::EvtHandler#set_next_handler
+    # @see  Wx::Window#push_event_handler
+    # @see  Wx::Window#pop_event_handler 
+    # @return [Wx::EvtHandler]
+    def get_previous_handler; end
+    alias_method :previous_handler, :get_previous_handler
+    
+    # Enables or disables the event handler.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>You can use this function to avoid having to remove the event handler from the chain, for example when implementing a dialog editor and changing from edit to test mode.
+    # </p>
+    # </div>
+    # @see Wx::EvtHandler#get_evt_handler_enabled 
+    # @param enabled [Boolean]  true if the event handler is to be enabled, false if it is to be disabled.
+    # @return [void]
+    def set_evt_handler_enabled(enabled) end
+    alias_method :evt_handler_enabled=, :set_evt_handler_enabled
+    
+    # Inserts the given handler as the next handler in the chain.
+    # 
+    # In wxRuby this fully handles double linking, i.e. wxRuby will take care of pointing the handler given
+    # back to this handler as well. There is no need to call set_previous_handler so this method is not supported 
+    # in wxRuby3.
+    # @param handler [Wx::EvtHandler]  The event handler to be set as the next handler. Cannot be nil.
+    # @return [void]
+    def set_next_handler(handler) end
+    alias_method :next_handler=, :set_next_handler
+    
+    # Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted).
+    # 
+    # E.g. if before calling {Wx::EvtHandler#unlink} you have the following chain: 
+    #  then after calling <code>B->Wx::EvtHandler#unlink</code> you'll have:
+    # @return [void]
+    def unlink; end
+    
+    # Returns true if the next and the previous handler pointers of this event handler instance are nil.
+    # 
+    # 
+    # @see Wx::EvtHandler#set_previous_handler
+    # @see  Wx::EvtHandler#set_next_handler 
+    # @return [Boolean]
+    def is_unlinked; end
+    alias_method :unlinked?, :is_unlinked
+    
+    # Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.
+    # 
+    # The filters are called in LIFO order and {Wx::App} is registered as an event filter by default. The pointer must remain valid until it's removed with {Wx::EvtHandler.remove_filter} and is not deleted by {Wx::EvtHandler}.
+    # @param filter [Wx::EventFilter,Wx::App] 
+    # @return [void]
+    def self.add_filter(filter) end
+    
+    # Remove a filter previously installed with {Wx::EvtHandler.add_filter}.
+    # 
+    # It's an error to remove a filter that hadn't been previously added or was already removed.
+    # @param filter [Wx::EventFilter,Wx::App] 
+    # @return [void]
+    def self.remove_filter(filter) end
+    
+    # Constructor.
+    # @return [Wx::EvtHandler]
+    def initialize; end
+    
+    
+    protected
+    
+    # Method called by {Wx::EvtHandler#process_event} before examining this object event tables.
+    # 
+    # This method can be overridden to hook into the event processing logic as early as possible. You should usually call the base class version when overriding this method, even if {Wx::EvtHandler} itself does nothing here, some derived classes do use this method, e.g. {Wx::Window} implements support for {Wx::Validator} in it.
+    # Example: 
+    # ```ruby
+    #   class MyClass < BaseClass # inheriting from Wx::EvtHandler
+    #   ...
+    #   protected
+    #     def try_before(event)
+    #       if my_pre_process(event)
+    #         return true
+    #   
+    #       super
+    #     end
+    #   end
+    # ```
+    # @see Wx::EvtHandler#process_event 
+    # @param event [Wx::Event] 
+    # @return [Boolean]
+    def try_before(event) end
+    
+    # Method called by {Wx::EvtHandler#process_event} as last resort.
+    # 
+    # This method can be overridden to implement post-processing for the events which were not processed anywhere else.
+    # The base class version handles forwarding the unprocessed events to {Wx::App} at {Wx::EvtHandler} level and propagating them upwards the window child-parent chain at {Wx::Window} level and so should usually be called when overriding this method: 
+    # ```ruby
+    #   class MyClass < BaseClass # inheriting from Wx::EvtHandler
+    #   ...
+    #   protected
+    #     def try_after(event)
+    #       if super
+    #         return true
+    # 
+    #       my_post_process(event)
+    #     end
+    #   end
+    # ```
+    # @see Wx::EvtHandler#process_event 
+    # @param event [Wx::Event] 
+    # @return [Boolean]
+    def try_after(event) end
+    
+  end # EvtHandler
+  
+
+end

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

@@ -0,0 +1,109 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This class implements help via an external browser.
+  # 
+  # It requires the name of a directory containing the documentation and a file mapping numerical Section numbers to relative URLS.
+  # The map file contains two or three fields per line: numeric_id relative_URL [; comment/documentation]
+  # The numeric_id is the id used to look up the entry in {Wx::ExtHelpController#display_section}/DisplayBlock(). The relative_URL is a filename of an html file, relative to the help directory. The optional comment/documentation field (after a ';') is used for keyword searches, so some meaningful text here does not hurt. If the documentation itself contains a ';', only the part before that will be displayed in the listbox, but all of it used for search.
+  # Lines starting with ';' will be ignored.
+  # 
+  # Category:  {Wx::HELP}
+  # @see Wx::HelpController 
+  # 
+  # 
+  # @wxrb_require USE_HELP
+  class ExtHelpController < Object
+  
+    # @param parentWindow [Wx::Window] 
+    # @return [Wx::ExtHelpController]
+    def initialize(parentWindow=nil) end
+    
+    # Tell it which browser to use.
+    # 
+    # The Netscape support will check whether Netscape is already running (by looking at the .netscape/lock file in the user's home directory) and tell it to load the page into the existing window.
+    # @param viewer [String]  The command to call a browser/html viewer.
+    # @param flags [Integer]  Set this to {Wx::HELP_NETSCAPE} if the browser is some variant of Netscape.
+    # @return [void]
+    def set_viewer(viewer=(''), flags=Wx::HELP_NETSCAPE) end
+    alias_method :viewer=, :set_viewer
+    
+    # This must be called to tell the controller where to find the documentation.
+    # 
+    # If a locale is set, look in file/localename, i.e. If passed "/usr/local/myapp/help" and the current {Wx::Locale} is set to be "de", then look in "/usr/local/myapp/help/de/" first and fall back to "/usr/local/myapp/help" if that doesn't exist.
+    # 
+    # true on success
+    # @param dir [String]  directory name where to fine the help files
+    # @return [Boolean]
+    def init(dir) end
+    
+    # Display list of all help entries.
+    # 
+    # true on success
+    # @return [Boolean]
+    def display_contents; end
+    
+    # Search comment/documentation fields in map file and present a list to chose from.
+    # 
+    # true on success
+    # @param k [String]  string to search for, empty string will list all entries
+    # @param mode [Wx::HelpSearchMode]  optional parameter allows the search the index ({Wx::HelpSearchMode::HELP_SEARCH_INDEX}) but this currently only supported by the {Wx::HTML::HtmlHelpController}.
+    # @return [Boolean]
+    def keyword_search(k, mode=Wx::HelpSearchMode::HELP_SEARCH_ALL) end
+    
+    # Does nothing.
+    # @return [void]
+    def on_quit; end
+    
+    # Call the browser using a relative URL.
+    # @param relativeURL [String] 
+    # @return [Boolean]
+    def display_help(relativeURL) end
+    
+    # Allows one to override the default settings for the help frame.
+    # @param titleFormat [String] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param newFrameEachTime [Boolean] 
+    # @return [void]
+    def set_frame_parameters(titleFormat, size, pos=Wx::DEFAULT_POSITION, newFrameEachTime=false) end
+    
+    # Displays the section as a popup window using a context id.
+    # 
+    # Returns false if unsuccessful or not implemented.
+    # @param contextId [Integer] 
+    # @return [Boolean]
+    def display_context_popup(contextId) end
+    
+    # Displays the text in a popup window, if possible.
+    # 
+    # Returns false if unsuccessful or not implemented.
+    # @param text [String] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @return [Boolean]
+    def display_text_popup(text, pos) end
+    
+    # Returns the window to be used as the parent for the help window.
+    # 
+    # This window is used by {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}.
+    # @return [Wx::Window]
+    def get_parent_window; end
+    alias_method :parent_window, :get_parent_window
+    
+    # Sets the window to be used as the parent for the help window.
+    # 
+    # This is used by {Wx::CHMHelpController}, {Wx::WinHelpController} and {Wx::HTML::HtmlHelpController}.
+    # @param parentWindow [Wx::Window] 
+    # @return [void]
+    def set_parent_window(parentWindow) end
+    alias_method :parent_window=, :set_parent_window
+    
+  end # ExtHelpController
+  
+
+end

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

@@ -0,0 +1,231 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  FC_DEFAULT_STYLE = 1
+  
+  # 
+  # 
+  FC_OPEN = 1
+  
+  # 
+  # 
+  FC_SAVE = 2
+  
+  # 
+  # 
+  FC_MULTIPLE = 4
+  
+  # 
+  # 
+  FC_NOSHOWHIDDEN = 8
+  
+  # 
+  # 
+  EVT_FILECTRL_SELECTIONCHANGED = 10158
+  
+  # 
+  # 
+  EVT_FILECTRL_FILEACTIVATED = 10159
+  
+  # 
+  # 
+  EVT_FILECTRL_FOLDERCHANGED = 10160
+  
+  # 
+  # 
+  EVT_FILECTRL_FILTERCHANGED = 10161
+  
+  # This control allows the user to select a file.
+  # 
+  # Two implementations of this class exist, one for Gtk and another generic one for all the other ports.
+  # This class is only available if {Wx::Setup::USE_FILECTRL} is set to 1.
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::FC_DEFAULT_STYLE}: The default style: {Wx::FC_OPEN} 
+  # 
+  # - {Wx::FC_OPEN}: Creates an file control suitable for opening files. Cannot be combined with {Wx::FC_SAVE}. 
+  # 
+  # - {Wx::FC_SAVE}: Creates an file control suitable for saving files. Cannot be combined with {Wx::FC_OPEN}. 
+  # 
+  # - {Wx::FC_MULTIPLE}: For open control only, Allows selecting multiple files. Cannot be combined with {Wx::FC_SAVE} 
+  # 
+  # - {Wx::FC_NOSHOWHIDDEN}: Hides the "Show Hidden Files" checkbox (Generic only) 
+  # 
+  # ### Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FileCtrlEvent} events.
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_filectrl_fileactivated}(id, meth = nil, &block): The user activated a file(by double-clicking or pressing Enter) 
+  # 
+  # - {Wx::EvtHandler#evt_filectrl_selectionchanged}(id, meth = nil, &block): The user changed the current selection(by selecting or deselecting a file) 
+  # 
+  # - {Wx::EvtHandler#evt_filectrl_folderchanged}(id, meth = nil, &block): The current folder of the file control has been changed 
+  # 
+  # - {Wx::EvtHandler#evt_filectrl_filterchanged}(id, meth = nil, &block): The current file filter of the file control has been changed. 
+  # 
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
+  #   </td></tr></table></div>
+  # Implementations:  native under WXGTK port; a generic implementation is used elsewhere.
+  # @see Wx::GenericDirCtrl 
+  # 
+  # 
+  # @wxrb_require USE_FILECTRL
+  class FileCtrl < Control
+  
+    # @overload initialize()
+    #   @return [Wx::FileCtrl]
+    # @overload initialize(parent, id, defaultDirectory=(''), defaultFilename=(''), wildCard=Wx::FILE_SELECTOR_DEFAULT_WILDCARD_STR, style=Wx::FC_DEFAULT_STYLE, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, name=Wx::FILE_CTRL_NAME_STR)
+    #   Constructs the window.
+    #   @param parent [Wx::Window]  Parent window, must not be non-null.
+    #   @param id [Integer]  The identifier for the control.
+    #   @param defaultDirectory [String]  The initial directory shown in the control. Must be a valid path to a directory or the empty string. In case it is the empty string, the current working directory is used.
+    #   @param defaultFilename [String]  The default filename, or the empty string.
+    #   @param wildCard [String]  A wildcard specifying which files can be selected, such as "*.*" or "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".
+    #   @param style [Integer]  The window style, see {Wx::FC_}* flags.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Initial position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Initial size.
+    #   @param name [String]  Control name.
+    #   @return [Wx::FileCtrl]
+    # @overload initialize(parent, id, defaultDirectory=(''), defaultFilename=(''), wildCard=Wx::FILE_SELECTOR_DEFAULT_WILDCARD_STR, style=Wx::FC_DEFAULT_STYLE, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, name=Wx::FILE_CTRL_NAME_STR, &block)
+    #   Constructs the window.
+    #   @param parent [Wx::Window]  Parent window, must not be non-null.
+    #   @param id [Integer]  The identifier for the control.
+    #   @param defaultDirectory [String]  The initial directory shown in the control. Must be a valid path to a directory or the empty string. In case it is the empty string, the current working directory is used.
+    #   @param defaultFilename [String]  The default filename, or the empty string.
+    #   @param wildCard [String]  A wildcard specifying which files can be selected, such as "*.*" or "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".
+    #   @param style [Integer]  The window style, see {Wx::FC_}* flags.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Initial position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Initial size.
+    #   @param name [String]  Control name.
+    #   @yieldparam [Wx::FileCtrl] win new instance
+    #   @return [Wx::FileCtrl]
+    def initialize(*args) end
+    
+    # Create function for two-step construction.
+    # 
+    # See {Wx::FileCtrl#initialize} for details.
+    # true if the control was successfully created or false if creation failed.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param defaultDirectory [String] 
+    # @param defaultFilename [String] 
+    # @param wildCard [String] 
+    # @param style [Integer] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param name [String] 
+    # @return [Boolean]
+    def create(parent, id, defaultDirectory=(''), defaultFilename=(''), wildCard=Wx::FILE_SELECTOR_DEFAULT_WILDCARD_STR, style=Wx::FC_DEFAULT_STYLE, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, name=Wx::FILE_CTRL_NAME_STR) end
+    
+    # Returns the current directory of the file control (i.e. the directory shown by it).
+    # @return [String]
+    def get_directory; end
+    alias_method :directory, :get_directory
+    
+    # Returns the currently selected filename.
+    # 
+    # For the controls having the {Wx::FC_MULTIPLE} style, use {Wx::FileCtrl#get_filenames} instead.
+    # @return [String]
+    def get_filename; end
+    alias_method :filename, :get_filename
+    
+    # Fills the array filenames with the filenames only of selected items.
+    # 
+    # This function should only be used with the controls having the {Wx::FC_MULTIPLE} style, use {Wx::FileCtrl#get_filename} for the others.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>filenames is emptied first. 
+    # </p>
+    # </div>
+    # @return [Array<String>]
+    def get_filenames; end
+    alias_method :filenames, :get_filenames
+    
+    # Returns the zero-based index of the currently selected filter.
+    # @return [Integer]
+    def get_filter_index; end
+    alias_method :filter_index, :get_filter_index
+    
+    # Returns the full path (directory and filename) of the currently selected file.
+    # 
+    # For the controls having the {Wx::FC_MULTIPLE} style, use {Wx::FileCtrl#get_paths} instead.
+    # @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 be used with the controls having the {Wx::FC_MULTIPLE} style, use {Wx::FileCtrl#get_path} otherwise.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>paths is emptied first. 
+    # </p>
+    # </div>
+    # @return [Array<String>]
+    def get_paths; end
+    alias_method :paths, :get_paths
+    
+    # Returns the current wildcard.
+    # @return [String]
+    def get_wildcard; end
+    alias_method :wildcard, :get_wildcard
+    
+    # Sets(changes) the current directory displayed in the control.
+    # 
+    # Returns true on success, false otherwise.
+    # @param directory [String] 
+    # @return [Boolean]
+    def set_directory(directory) end
+    alias_method :directory=, :set_directory
+    
+    # Selects a certain file.
+    # 
+    # Returns true on success, false otherwise
+    # @param filename [String] 
+    # @return [Boolean]
+    def set_filename(filename) end
+    alias_method :filename=, :set_filename
+    
+    # Changes to a certain directory and selects a certain file.
+    # 
+    # If path includes the directory part, it must exist, otherwise false is returned and nothing else is done.
+    # Returns true on success, false otherwise
+    # @param path [String] 
+    # @return [Boolean]
+    def set_path(path) end
+    alias_method :path=, :set_path
+    
+    # Sets the current 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 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
+    
+    # Sets whether hidden files and folders are shown or not.
+    # @param show [Boolean] 
+    # @return [void]
+    def show_hidden(show) end
+    
+  end # FileCtrl
+  
+
+end

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

@@ -0,0 +1,83 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A file control event holds information about events associated with {Wx::FileCtrl} objects.
+  # 
+  # ### Events using this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FileCtrlEvent} events.
+  # Event handler methods:
+  # 
+  # - {Wx::EvtHandler#evt_filectrl_fileactivated}(id, meth = nil, &block): The user activated a file(by double-clicking or pressing Enter) 
+  # 
+  # - {Wx::EvtHandler#evt_filectrl_selectionchanged}(id, meth = nil, &block): The user changed the current selection(by selecting or deselecting a file) 
+  # 
+  # - {Wx::EvtHandler#evt_filectrl_folderchanged}(id, meth = nil, &block): The current folder of the file control has been changed 
+  # 
+  # - {Wx::EvtHandler#evt_filectrl_filterchanged}(id, meth = nil, &block): The current file filter of the file control has been changed 
+  # 
+  # Category:  {Wx::Events}
+  # 
+  # @wxrb_require USE_FILECTRL
+  class FileCtrlEvent < CommandEvent
+  
+    # Constructor.
+    # @param type [Wx::TipWindow::EventType] 
+    # @param evtObject [Wx::Object] 
+    # @param id [Integer] 
+    # @return [Wx::FileCtrlEvent]
+    def initialize(type, evtObject, id) end
+    
+    # Returns the current directory.
+    # 
+    # In case of a <b>EVT_FILECTRL_FOLDERCHANGED</b>, this method returns the new directory.
+    # @return [String]
+    def get_directory; end
+    alias_method :directory, :get_directory
+    
+    # Returns the file selected (assuming it is only one file).
+    # @return [String]
+    def get_file; end
+    alias_method :file, :get_file
+    
+    # Returns the files selected.
+    # 
+    # In case of a <b>EVT_FILECTRL_SELECTIONCHANGED</b>, this method returns the files selected after the event.
+    # @return [Array<String>]
+    def get_files; end
+    alias_method :files, :get_files
+    
+    # Returns the current file filter index.
+    # 
+    # For a <b>EVT_FILECTRL_FILTERCHANGED</b> event, this method returns the new file filter index.
+    # @return [Integer]
+    def get_filter_index; end
+    alias_method :filter_index, :get_filter_index
+    
+    # Sets the files changed by this event.
+    # @param files [Array<String>] 
+    # @return [void]
+    def set_files(files) end
+    alias_method :files=, :set_files
+    
+    # Sets the directory of this event.
+    # @param directory [String] 
+    # @return [void]
+    def set_directory(directory) end
+    alias_method :directory=, :set_directory
+    
+    # Sets the filter index changed by this event.
+    # @param index [Integer] 
+    # @return [void]
+    def set_filter_index(index) end
+    alias_method :filter_index=, :set_filter_index
+    
+  end # FileCtrlEvent
+  
+
+end