wxruby3 0.9.0.pre.rc.3-x64-mingw-ucrt → 0.9.0-x64-mingw-ucrt

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

@@ -41,7 +41,7 @@ module Wx
     # 
     # true if this handler of one of those chained to it processed the event.
     # @param event [Wx::Event]  Event to process.
-    # @return [true,false]
+    # @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.
@@ -50,7 +50,7 @@ module Wx
     # 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 [true,false]
+    # @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.
@@ -67,7 +67,7 @@ module Wx
     # Returns true if the event handler is enabled, false otherwise.
     # 
     # @see Wx::EvtHandler#set_evt_handler_enabled 
-    # @return [true,false]
+    # @return [Boolean]
     def get_evt_handler_enabled; end
     alias_method :evt_handler_enabled, :get_evt_handler_enabled
     
@@ -96,7 +96,7 @@ module Wx
     # Enables or disables the event handler.
     # 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.
     # @see Wx::EvtHandler#get_evt_handler_enabled 
-    # @param enabled [true,false]  true if the event handler is to be enabled, false if it is to be disabled.
+    # @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
@@ -131,7 +131,7 @@ module Wx
     # 
     # @see Wx::EvtHandler#set_previous_handler
     # @see  Wx::EvtHandler#set_next_handler 
-    # @return [true,false]
+    # @return [Boolean]
     def is_unlinked; end
     alias_method :unlinked?, :is_unlinked
     
@@ -171,7 +171,7 @@ module Wx
     # ```
     # @see Wx::EvtHandler#process_event 
     # @param event [Wx::Event] 
-    # @return [true,false]
+    # @return [Boolean]
     def try_before(event) end
     
     # Method called by {Wx::EvtHandler#process_event} as last resort.
@@ -191,7 +191,7 @@ module Wx
     # ```
     # @see Wx::EvtHandler#process_event 
     # @param event [Wx::Event] 
-    # @return [true,false]
+    # @return [Boolean]
     def try_after(event) end
     
   end # EvtHandler

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

@@ -36,19 +36,19 @@ module Wx
     # 
     # true on success
     # @param dir [String]  directory name where to fine the help files
-    # @return [true,false]
+    # @return [Boolean]
     def init(dir) end
     
     # Display list of all help entries.
     # true on success
-    # @return [true,false]
+    # @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 [HelpSearchMode]  optional parameter allows the search the index ({Wx::HelpSearchMode::HELP_SEARCH_INDEX}) but this currently only supported by the {Wx::HTML::HtmlHelpController}.
-    # @return [true,false]
+    # @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.
@@ -57,28 +57,28 @@ module Wx
     
     # Call the browser using a relative URL.
     # @param relativeURL [String] 
-    # @return [true,false]
+    # @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 [true,false] 
+    # @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 [true,false]
+    # @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 [true,false]
+    # @return [Boolean]
     def display_text_popup(text, pos) end
     
     # Returns the window to be used as the parent for the help window.

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

@@ -121,9 +121,11 @@ module Wx
   # 
   # == 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.
+  # 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 Dialogs Sample, please check it for more details.
+  # 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.
+  # 
   # === Styles
   # 
   # This class supports the following styles:
@@ -254,7 +256,7 @@ module Wx
     # 
     # 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 [true,false]
+    # @return [Boolean]
     def set_customize_hook(customizeHook) end
     alias_method :customize_hook=, :set_customize_hook
     

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

@@ -0,0 +1,146 @@
+# :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.
+  # 
+  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.
+  # 
+  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.
+  # 
+  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.
+  # 
+  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.
+  # 
+  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.
+  # 
+  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.
+  # 
+  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,159 @@
+# :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: 
+  # ```
+  #   class EncryptHook : public wxFileDialogCustomizeHook
+  #   {
+  #   public:
+  #       // Override to add custom controls using the provided customizer object.
+  #       void AddCustomControls(wxFileDialogCustomize& customizer) override
+  #       {
+  #           // Suppose we can encrypt files when saving them.
+  #           m_checkbox = customizer.AddCheckBox("Encrypt");
+  #   
+  #           // While m_checkbox is not a wxCheckBox, it looks almost like one
+  #           // and, in particular, we can bind to custom control events as usual.
+  #           m_checkbox->Bind(wxEVT_CHECKBOX, [this](wxCommandEvent& event) {
+  #               // We can also call wxWindow-like functions on them.
+  #               m_button->Enable(event.IsChecked());
+  #           });
+  #   
+  #           // The encryption parameters can be edited in a dedicated dialog.
+  #           m_button = customizer.AddButton("Parameters...");
+  #           m_button->Bind(wxEVT_BUTTON, [](wxCommandEvent&) {
+  #               ... show the encryption parameters dialog here ...
+  #           });
+  #       }
+  #   
+  #       // Override to save the values of the custom controls.
+  #       void TransferDataFromCustomControls() override
+  #       {
+  #           // Save the checkbox value, as we won't be able to use it any more
+  #           // once this function returns.
+  #           m_encrypt = m_checkbox->GetValue();
+  #       }
+  #   
+  #       // Just a simple accessor to get the results.
+  #       bool Encrypt() const { return m_encrypt; }
+  #   
+  #   private:
+  #       wxFileDialogButton* m_button;
+  #       wxFileDialogCheckBox* m_checkbox;
+  #   
+  #       bool m_encrypt = false;
+  #   };
+  #   
+  #   void SomeFunc()
+  #   {
+  #       wxFileDialog dialog(NULL, "Save document", wxString(), "file.my",
+  #                           "My files (*.my)|*.my",
+  #                           wxFD_SAVE | wxFD_OVERWRITE_PROMPT);
+  #   
+  #       // This object may be destroyed before the dialog, but must remain
+  #       // alive until ShowModal() returns.
+  #       EncryptHook customizeHook;
+  #       dialog.SetCustomizeHook(customHook);
+  #   
+  #       if ( dialog.ShowModal() == wxID_OK )
+  #       {
+  #           if ( customizeHook.Encrypt() )
+  #               ... save with encryption ...
+  #           else
+  #               ... save without encryption ...
+  #       }
+  #   }
+  # ```
+  # 
+  # === 
+  # 
+  # Category:  Common Dialogs
+  # @see Wx::FileDialog
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  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
+  # 
+  # 
+  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 n [Integer]  The number of strings, must be positive, as there is no way to add more strings later and creating an empty combobox is not very useful.
+    # @param strings [String]  A non-NULL pointer to an array of n strings.
+    # @return [Wx::FileDialogChoice]
+    def add_choice(n, 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

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

@@ -76,7 +76,7 @@ module Wx
     #   @return [Wx::FileDirPickerEvent]
     # @overload initialize(type, generator, id, path)
     #   The constructor is not normally used by the user code.
-    #   @param type [Wx::AUI::AuiMDIChildFrame::EventType] 
+    #   @param type [Wx::CommandLinkButton::EventType] 
     #   @param generator [Wx::Object] 
     #   @param id [Integer] 
     #   @param path [String] 

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

@@ -76,11 +76,11 @@ module Wx
     # @param style [Integer]  The window style, see {Wx::FLP_}* flags.
     # @param validator [Wx::Validator]  Validator which can be used for additional data checks.
     # @param name [String]  Control name.
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, path=(''), message=Wx::FileSelectorPromptStr, wildcard=Wx::FILE_SELECTOR_DEFAULT_WILDCARD_STR, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::FLP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::FilePickerCtrlNameStr) end
     
     # Similar to {Wx::FilePickerCtrl#get_path} but returns the path of the currently selected file as a {Wx::FileName} object.
-    # @return [Wx::FileName]
+    # @return [String]
     def get_file_name; end
     alias_method :file_name, :get_file_name
     
@@ -90,7 +90,7 @@ module Wx
     alias_method :path, :get_path
     
     # This method does the same thing as {Wx::FilePickerCtrl#set_path} but takes a {Wx::FileName} object instead of a string.
-    # @param filename [Wx::FileName] 
+    # @param filename [String] 
     # @return [void]
     def set_file_name(filename) end
     alias_method :file_name=, :set_file_name