wxruby3 0.9.4-x64-mingw-ucrt → 0.9.7-x64-mingw-ucrt

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

@@ -22,7 +22,6 @@ module Wx
   # Category:  {Wx::Events}
   # 
   # ## Delayed Action Mechanism
-  # 
   # {Wx::IdleEvent} can be used to perform some action "at slightly later time". This can be necessary in several circumstances when, for whatever reason, something can't be done in the current event handler. For example, if a mouse event handler is called with the mouse button pressed, the mouse can be currently captured and some operations with it  notably capturing it again  might be impossible or lead to undesirable results. If you still want to capture it, you can do it from {Wx::EVT_IDLE} handler when it is called the next time instead of doing it immediately.
   # This can be achieved in two different ways: when using static event tables, you will need a flag indicating to the (always connected) idle event handler whether the desired action should be performed. The originally called handler would then set it to indicate that it should indeed be done and the idle handler itself would reset it to prevent it from doing the same action again.
   # Using dynamically connected event handlers things are even simpler as the original event handler can simply {Wx::EvtHandler#connect} or {Wx::EvtHandler#bind} the idle event handler which would only be executed then and could {Wx::EvtHandler#disconnect} or {Wx::EvtHandler#unbind} itself.
@@ -107,7 +106,6 @@ module Wx
   # Note that scrolled windows send the {Wx::ScrollWinEvent} which does not derive from {Wx::CommandEvent}, but from {Wx::Event} directly - don't confuse these two kinds of events and use the event table macros mentioned below only for the scrollbar-like controls.
   # 
   # ## The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
-  # 
   # The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed by an EVT_SCROLL_CHANGED event).
   # The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE event does not happen).
   # In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/ moving has finished independently of the way it had started. Please see the Widgets Sample ("Slider" page) to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
@@ -1612,14 +1610,6 @@ module Wx
     # 
     class Reason < Wx::Enum
     
-      # Window activated by mouse click.
-      # 
-      Reason_Mouse = Wx::ActivateEvent::Reason.new(0)
-      
-      # Window was activated with some other method than mouse click.
-      # 
-      Reason_Unknown = Wx::ActivateEvent::Reason.new(1)
-      
     end # Reason
     
     # Constructor.
@@ -1628,7 +1618,7 @@ module Wx
     # @param id [Integer] 
     # @param activationReason [Wx::ActivateEvent::Reason] 
     # @return [Wx::ActivateEvent]
-    def initialize(eventType=Wx::EVT_NULL, active=true, id=0, activationReason=Wx::ActivateEvent::Reason::Reason_Unknown) end
+    def initialize(eventType=Wx::EVT_NULL, active=true, id=0, activationReason=REASON_UNKNOWN) end
     
     # Returns true if the application or window is being activated, false otherwise.
     # @return [Boolean]
@@ -2672,18 +2662,6 @@ module Wx
     # 
     class Origin < Wx::Enum
     
-      # unrecognized event source.
-      # 
-      Origin_Unknown = Wx::HelpEvent::Origin.new(0)
-      
-      # event generated from F1 key press.
-      # 
-      Origin_Keyboard = Wx::HelpEvent::Origin.new(1)
-      
-      # event generated by {Wx::ContextHelp} or from the [?] button on the title bar (Windows).
-      # 
-      Origin_HelpButton = Wx::HelpEvent::Origin.new(2)
-      
     end # Origin
     
     # Constructor.
@@ -2692,7 +2670,7 @@ module Wx
     # @param pt [Array(Integer, Integer), Wx::Point] 
     # @param origin [Wx::HelpEvent::Origin] 
     # @return [Wx::HelpEvent]
-    def initialize(type=Wx::EVT_NULL, winid=0, pt=Wx::DEFAULT_POSITION, origin=Wx::HelpEvent::Origin::Origin_Unknown) end
+    def initialize(type=Wx::EVT_NULL, winid=0, pt=Wx::DEFAULT_POSITION, origin=ORIGIN_UNKNOWN) end
     
     # Returns the origin of the help event which is one of the {Wx::HelpEvent::Origin} values.
     # 
@@ -2836,4 +2814,4 @@ module Wx
   end # ChildFocusEvent
   
 
-end
+  end

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

@@ -243,4 +243,4 @@ module Wx
   end # EvtHandler
   
 
-end
+  end

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

@@ -106,4 +106,4 @@ module Wx
   end # ExtHelpController
   
 
-end
+  end

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

@@ -215,4 +215,4 @@ module Wx
   end # FileCtrl
   
 
-end
+  end

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

@@ -80,4 +80,4 @@ module Wx
   end # FileCtrlEvent
   
 
-end
+  end

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

@@ -108,7 +108,6 @@ module Wx
   # ```
   # 
   # ## 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"
@@ -121,7 +120,6 @@ module Wx
   #  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 does 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 Dialogs Sample, please check it for more details.
@@ -335,4 +333,4 @@ module Wx
   end # FileDialog
   
 
-end
+  end

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

@@ -162,4 +162,4 @@ module Wx
   end # FileDialogStaticText
   
 
-end
+  end

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

@@ -10,67 +10,59 @@ module Wx
   # 
   # {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 ...
-  #       }
-  #   }
+  # ```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
@@ -164,4 +156,4 @@ module Wx
   end # FileDialogCustomize
   
 
-end
+  end

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

@@ -97,4 +97,4 @@ module Wx
   end # FileDirPickerEvent
   
 
-end
+  end

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

@@ -115,4 +115,4 @@ module Wx
   end # FilePickerCtrl
   
 
-end
+  end

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

@@ -91,14 +91,7 @@ module Wx
     
     # Returns true if the handler is able to open this file.
     # 
-    # This function doesn't check whether the file exists or not, it only checks if it knows the protocol. Example:
-    # 
-    # ```
-    #   bool MyHand::CanOpen(const wxString& location)
-    #   {
-    #       return (GetProtocol(location) == "http");
-    #   }
-    # ```
+    # This function doesn't check whether the file exists or not, it only checks if it knows the protocol. 
     # 
     # Must be overridden in derived handlers.
     # @param location [String] 
@@ -132,10 +125,6 @@ module Wx
     # Returns the MIME type based on <b>extension</b> of location.
     # 
     # (While {Wx::FSFile#get_mime_type} returns real MIME type - either extension-based or queried from HTTP.)
-    # Example: 
-    # ```
-    #   GetMimeTypeFromExt("index.htm") == "text/html"
-    # ```
     # @param location [String] 
     # @return [String]
     def self.get_mime_type_from_ext(location) end
@@ -161,52 +150,6 @@ module Wx
   # 
   # It is particularly suitable for storing bitmaps from resources or included XPM files so that they can be used with {Wx::HTML} or {Wx::WebView}.
   # Filenames are prefixed with <code>"memory:"</code>, e.g. <code>"memory:myfile.html"</code>.
-  # Example:
-  # 
-  # ```
-  #   \#ifndef __WXMSW__
-  #   \#include "logo.xpm"
-  #   \#endif
-  #   
-  #   void MyFrame::OnAbout(wxCommandEvent&)
-  #   {
-  #       wxFileSystem::AddHandler(new wxMemoryFSHandler);
-  #       wxMemoryFSHandler::AddFile("logo.png", wxBITMAP(logo), wxBITMAP_TYPE_PNG);
-  #       wxMemoryFSHandler::AddFile("about.htm",
-  #                               "<html><body>About: "
-  #                               "<img src=\"memory:logo.png\"></body></html>");
-  #   
-  #       wxDialog dlg(this, -1, wxString(_("About")));
-  #       wxBoxSizer *topsizer;
-  #       topsizer = new wxBoxSizer(wxVERTICAL);
-  #   \#ifdef USE_WEBVIEW
-  #       wxWebView* browser = wxWebView::New(&dlg, wxID_ANY, wxWebViewDefaultURLStr,
-  #                                wxDefaultPosition, wxSize(380, 160));
-  #       browser->RegisterHandler(wxSharedPtr<wxWebViewHandler>(new wxWebViewFSHandler("memory")));
-  #       browser->LoadURL("memory:about.htm");
-  #   \#else // Use wxHtml
-  #       wxHtmlWindow *browser;
-  #       browser = new wxHtmlWindow(&dlg, -1, wxDefaultPosition,
-  #                                  wxSize(380, 160), wxHW_SCROLLBAR_NEVER);
-  #       browser->SetBorders(0);
-  #       browser->LoadPage("memory:about.htm");
-  #       browser->SetSize(browser->GetInternalRepresentation()->GetWidth(),
-  #                   browser->GetInternalRepresentation()->GetHeight());
-  #   \#endif
-  #       topsizer->Add(browser, 1, wxALL, 10);
-  #       topsizer->Add(new wxStaticLine(&dlg, -1), 0, wxEXPAND | wxLEFT | wxRIGHT, 10);
-  #       topsizer->Add(new wxButton(&dlg, wxID_OK, "Ok"),
-  #                   0, wxALL | wxALIGN_RIGHT, 15);
-  #       dlg.SetAutoLayout(true);
-  #       dlg.SetSizer(topsizer);
-  #       topsizer->Fit(&dlg);
-  #       dlg.Centre();
-  #       dlg.ShowModal();
-  #   
-  #       wxMemoryFSHandler::RemoveFile("logo.png");
-  #       wxMemoryFSHandler::RemoveFile("about.htm");
-  #   }
-  # ```
   # 
   # Category:  Virtual File System
   # @see Wx::MemoryFSHandler.add_file_with_mime_type 
@@ -286,4 +229,4 @@ module Wx
   end # MemoryFSHandler
   
 
-end
+  end

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

@@ -123,4 +123,4 @@ module Wx
   end # FindDialogEvent
   
 
-end
+  end

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

@@ -57,4 +57,4 @@ module Wx
   end # FindReplaceData
   
 
-end
+  end

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

@@ -44,4 +44,4 @@ module Wx
   end # FindReplaceDialog
   
 
-end
+  end

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

@@ -160,4 +160,4 @@ module Wx
   end # FlexGridSizer
   
 
-end
+  end

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

@@ -1375,4 +1375,4 @@ module Wx
   end # FontInfo
   
 
-end
+  end

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

@@ -148,4 +148,4 @@ module Wx
   end # FontData
   
 
-end
+  end

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

@@ -72,4 +72,4 @@ module Wx
   end # FontDialog
   
 
-end
+  end

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

@@ -128,4 +128,4 @@ module Wx
   end # FontPickerCtrl
   
 
-end
+  end

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

@@ -62,4 +62,4 @@ module Wx
   end # FontPickerEvent
   
 
-end
+  end

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

@@ -28,7 +28,6 @@ module Wx
   # </div>
   # 
   # ## Default event processing
-  # 
   # {Wx::Frame} processes the following events:
   # 
   # - {Wx::EVT_SIZE}: if the frame has exactly one child window, not counting the status and toolbar, this child is resized to take the entire frame client area. If two or more windows are present, they should be laid out explicitly either by manually handling {Wx::EVT_SIZE} or using sizers; 
@@ -341,4 +340,4 @@ module Wx
   end # Frame
   
 
-end
+  end

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

@@ -330,4 +330,4 @@ module Wx
   end # OutputStream
   
 
-end
+  end

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

@@ -7,4 +7,4 @@
 module Wx
 
 
-end
+  end

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

@@ -139,4 +139,4 @@ module Wx
   end # Gauge
   
 
-end
+  end

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

@@ -65,4 +65,4 @@ module Wx
   end # GBSizerItem
   
 
-end
+  end

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

@@ -43,4 +43,4 @@ module Wx
   end # GCDC
   
 
-end
+  end

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

@@ -293,11 +293,11 @@ module Wx
   
   # Global instance of a {Wx::Point} initialized with values (-1,-1).
   # 
-  DEFAULT_POSITION = nil
+  DEFAULT_POSITION = Wx::Point.new(-1, -1)
   
   # Global instance of a {Wx::Size} object initialized to (-1,-1).
   # 
-  DEFAULT_SIZE = nil
+  DEFAULT_SIZE = Wx::Size.new(-1, -1)
   
   # Returns true if the display is colour, false otherwise.
   # 
@@ -1181,4 +1181,4 @@ module Wx
   end # ColourDatabase
   
 
-end
+  end

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

@@ -28,4 +28,4 @@ module Wx
   end # GDIObject
   
 
-end
+  end

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

@@ -207,4 +207,4 @@ module Wx
   end # GenericDirCtrl
   
 
-end
+  end

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

@@ -1030,4 +1030,4 @@ module Wx
   end # GraphicsPenInfo
   
 
-end
+  end

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

@@ -468,4 +468,4 @@ module Wx
   end # GraphicsBitmap
   
 
-end
+  end

data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb

@@ -6,31 +6,35 @@
 
 module Wx::GRID
 
-  # Base class for activatable editors.
-  # 
-  # Inheriting from this class makes it simpler to implement editors that support only activation, but not in-place editing, as they only need to implement {Wx::GRID::GridCellActivatableEditor#try_activate}, {Wx::GRID::GridCellActivatableEditor#do_activate} and {Wx::GRID::GridCellActivatableEditor#clone} methods, but not all the other pure virtual methods of {Wx::GRID::GridCellEditor}.
-  # 
-  # @wxrb_require USE_GRID
-  class GridCellActivatableEditor < GridCellEditor
-  
-    # Same method as in {Wx::GRID::GridCellEditor}, but pure virtual.
+  module Wx::GRID
+
+    # Base class for activatable editors.
+    # 
+    # Inheriting from this class makes it simpler to implement editors that support only activation, but not in-place editing, as they only need to implement {Wx::GRID::GridCellActivatableEditor#try_activate}, {Wx::GRID::GridCellActivatableEditor#do_activate} and {Wx::GRID::GridCellActivatableEditor#clone} methods, but not all the other pure virtual methods of {Wx::GRID::GridCellEditor}.
     # 
-    # Note that the implementation of this method must never return Wx::GridActivationResult#do_edit for the editors inheriting from this class, as it doesn't support normal editing.
-    # @param row [Integer] 
-    # @param col [Integer] 
-    # @param grid [Wx::GRID::Grid] 
-    # @param actSource [Wx::GridActivationSource] 
-    # @return [Wx::GridActivationResult]
-    def try_activate(row, col, grid, actSource) end
+    # @wxrb_require USE_GRID
+    class GridCellActivatableEditor < GridCellEditor
     
-    # Same method as in {Wx::GRID::GridCellEditor}, but pure virtual.
-    # @param row [Integer] 
-    # @param col [Integer] 
-    # @param grid [Wx::GRID::Grid] 
-    # @return [void]
-    def do_activate(row, col, grid) end
+      # Same method as in {Wx::GRID::GridCellEditor}, but pure virtual.
+      # 
+      # Note that the implementation of this method must never return Wx::GridActivationResult#do_edit for the editors inheriting from this class, as it doesn't support normal editing.
+      # @param row [Integer] 
+      # @param col [Integer] 
+      # @param grid [Wx::GRID::Grid] 
+      # @param actSource [Wx::GridActivationSource] 
+      # @return [Wx::GridActivationResult]
+      def try_activate(row, col, grid, actSource) end
+      
+      # Same method as in {Wx::GRID::GridCellEditor}, but pure virtual.
+      # @param row [Integer] 
+      # @param col [Integer] 
+      # @param grid [Wx::GRID::Grid] 
+      # @return [void]
+      def do_activate(row, col, grid) end
+      
+    end # GridCellActivatableEditor
     
-  end # GridCellActivatableEditor
-  
 
-end
+    end
+
+  end