wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -10,6 +10,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_XRC
   class XmlResourceFlags < Wx::Enum
   
     # Translatable strings will be translated via {_}.
@@ -31,16 +32,16 @@ module Wx
   end # XmlResourceFlags
   
   # This is the main class for interacting with the XML-based resource system.
+  # 
   # The class holds XML resources from one or more .xml files, binary files or zip archive files.
   # Note that this is a singleton class and you'll never allocate/deallocate it. Just use the static {Wx::XmlResource.get} getter.
   # 
-  # === 
-  # 
   # Category:  XML Based Resource System (XRC)
   # @see XML Based Resource System (XRC)
   # @see  XRC File Format
   # 
   # 
+  # @wxrb_require USE_XRC
   class XmlResource < Object
   
     # @overload initialize(filemask, flags=Wx::XmlResourceFlags::XRC_USE_LOCALE, domain=(''))
@@ -57,6 +58,7 @@ module Wx
     def initialize(*args) end
     
     # Attaches an unknown control to the given panel/window/dialog.
+    # 
     # Unknown controls are used in conjunction with <object class="unknown">.
     # @param name [String] 
     # @param control [Wx::Window] 
@@ -65,6 +67,7 @@ module Wx
     def attach_unknown_control(name, control, parent=nil) end
     
     # Compares the XRC version to the argument.
+    # 
     # Returns -1 if the XRC version is less than the argument, +1 if greater, and 0 if they are equal.
     # @param major [Integer] 
     # @param minor [Integer] 
@@ -84,6 +87,7 @@ module Wx
     alias_method :flags, :get_flags
     
     # Returns the {Wx::XmlNode} containing the definition of the object with the given name or NULL.
+    # 
     # This function recursively searches all the loaded XRC files for an object with the specified name. If the object is found, the {Wx::XmlNode} corresponding to it is returned, so this function can be used to access additional information defined in the XRC file and not used by {Wx::XmlResource} itself, e.g. contents of application-specific XML tags.
     # 
     # The node corresponding to the resource with the given name or NULL.
@@ -98,11 +102,13 @@ module Wx
     alias_method :version, :get_version
     
     # Initializes handlers for all supported controls/windows.
+    # 
     # This will make the executable quite big because it forces linking against most of the wxWidgets library.
     # @return [void]
     def init_all_handlers; end
     
     # Loads resources from XML files that match given filemask.
+    # 
     # Example: 
     # ```ruby
     #   if !Wx::XmlResource.get.load('rc/*.xrc')
@@ -110,9 +116,17 @@ module Wx
     #   end
     # ```
     # 
-    # If {Wx::Setup::USE_FILESYSTEM} is enabled, this method understands {Wx::FileSystem} URLs.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>If {Wx::Setup::USE_FILESYSTEM} is enabled, this method understands {Wx::FileSystem} URLs.
+    # </p>
+    # </div>
     # 
-    # If you are sure that the argument is name of single XRC file (rather than an URL or a wildcard), use {Wx::XmlResource#load_file} instead.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>If you are sure that the argument is name of single XRC file (rather than an URL or a wildcard), use {Wx::XmlResource#load_file} instead.
+    # </p>
+    # </div>
     # @see Wx::XmlResource#load_file
     # @see  Wx::XmlResource#load_all_files 
     # @param filemask [String] 
@@ -121,6 +135,7 @@ module Wx
     
     # Simpler form of {Wx::XmlResource#load} for loading a single XRC file.
     # 
+    # 
     # @see Wx::XmlResource#load
     # @see  Wx::XmlResource#load_all_files
     # @see  Wx::XmlResource#load_document 
@@ -129,6 +144,7 @@ module Wx
     def load_file(file) end
     
     # Loads all .xrc files from directory dirname.
+    # 
     # Tries to load as many files as possible; if there's an error while loading one file, it still attempts to load other files.
     # @see Wx::XmlResource#load_file
     # @see  Wx::XmlResource#load 
@@ -142,6 +158,7 @@ module Wx
     def load_bitmap(name) end
     
     # Loads a dialog.
+    # 
     # parent points to parent window (if any).
     # @param parent [Wx::Window] 
     # @param name [String] 
@@ -149,6 +166,7 @@ module Wx
     def load_dialog(parent, name) end
     
     # Loads a dialog.
+    # 
     # parent points to parent window (if any).
     # This form is used to finish creation of an already existing instance (the main reason for this is that you may want to use derived class with a new event table). Example:
     # 
@@ -166,6 +184,7 @@ module Wx
     def load_dialog_subclass(dlg, parent, name) end
     
     # Loads a frame from the resource.
+    # 
     # parent points to parent window (if any).
     # @param parent [Wx::Window] 
     # @param name [String] 
@@ -173,6 +192,7 @@ module Wx
     def load_frame(parent, name) end
     
     # Loads the contents of a frame onto an existing {Wx::Frame}.
+    # 
     # This form is used to finish creation of an already existing instance (the main reason for this is that you may want to use derived class with a new event table).
     # @param frame [Wx::Frame] 
     # @param parent [Wx::Window] 
@@ -186,6 +206,7 @@ module Wx
     def load_icon(name) end
     
     # Loads menu from resource.
+    # 
     # Returns NULL on failure.
     # @param name [String] 
     # @return [Wx::Menu]
@@ -193,6 +214,7 @@ module Wx
     
     # @overload load_menu_bar(parent, name)
     #   Loads a menubar from resource.
+    #   
     #   Returns NULL on failure.
     #   @param parent [Wx::Window] 
     #   @param name [String] 
@@ -204,6 +226,7 @@ module Wx
     
     # @overload load_object(parent, name, classname)
     #   Load an object from the resource specifying both the resource name and the class name.
+    #   
     #   The first overload lets you load nonstandard container windows and returns NULL on failure. The second one lets you finish the creation of an existing instance and returns false on failure.
     #   In either case, only the resources defined at the top level of XRC files can be loaded by this function, use {Wx::XmlResource#load_object_recursively} if you need to load an object defined deeper in the hierarchy.
     #   @param parent [Wx::Window] 
@@ -220,6 +243,7 @@ module Wx
     
     # @overload load_object_recursively(parent, name, classname)
     #   Load an object from anywhere in the resource tree.
+    #   
     #   These methods are similar to {Wx::XmlResource#load_object} but may be used to load an object from anywhere in the resource tree and not only the top level. Note that you will very rarely need to do this as in normal use the entire container window (defined at the top level) is loaded and not its individual children but this method can be useful in some particular situations.
     #   @param parent [Wx::Window] 
     #   @param name [String] 
@@ -234,6 +258,7 @@ module Wx
     def load_object_recursively(*args) end
     
     # Loads a panel.
+    # 
     # parent points to the parent window.
     # @param parent [Wx::Window] 
     # @param name [String] 
@@ -241,6 +266,7 @@ module Wx
     def load_panel(parent, name) end
     
     # Loads a panel.
+    # 
     # parent points to the parent window. This form is used to finish creation of an already existing instance.
     # @param panel [Wx::Panel] 
     # @param parent [Wx::Window] 
@@ -267,18 +293,21 @@ module Wx
     alias_method :flags=, :set_flags
     
     # This function unloads a resource previously loaded by {Wx::XmlResource#load}.
+    # 
     # Returns true if the resource was successfully unloaded and false if it hasn't been found in the list of loaded resources.
     # @param filename [String] 
     # @return [Boolean]
     def unload(filename) end
     
     # Registers subclasses factory for use in XRC.
+    # 
     # This is useful only for language bindings developers who need a way to implement subclassing in wxWidgets ports that don't support {Wx::RTTI} (e.g. {Wx::Python}).
     # @param factory [Wx::XmlSubclassFactory] 
     # @return [void]
     def self.add_subclass_factory(factory) end
     
     # Returns a string ID corresponding to the given numeric ID.
+    # 
     # The string returned is such that calling {Wx::XmlResource.get_xrcid} with it as parameter yields numId. If there is no string identifier corresponding to the given numeric one, an empty string is returned.
     # Notice that, unlike {Wx::XmlResource.get_xrcid}, this function is slow as it checks all of the identifiers used in XRC.
     # @param numId [Integer] 
@@ -290,10 +319,16 @@ module Wx
     def self.get; end
     
     # Returns a numeric ID that is equivalent to the string ID used in an XML resource.
+    # 
     # If an unknown str_id is requested (i.e. other than {Wx::ID_XXX} or integer), a new record is created which associates the given string with a number.
     # If value_if_not_found is {Wx::StandardID::ID_NONE}, the number is obtained via {new_id}. Otherwise value_if_not_found is used.
     # Macro <code>XRCID(name)</code> is provided for convenient use in event tables.
-    # IDs returned by XRCID() cannot be used with the <code>EVT_*_RANGE</code> macros, because the order in which they are assigned to symbolic name values is not guaranteed.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>IDs returned by XRCID() cannot be used with the <code>EVT_*_RANGE</code> macros, because the order in which they are assigned to symbolic name values is not guaranteed. 
+    # </p>
+    # </div>
     # @param str_id [String] 
     # @param value_if_not_found [Integer] 
     # @return [Integer]

data/lib/wx/doc/generic_validator.rb

@@ -0,0 +1,95 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  # Wx::GenericValidator performs data transfer (but not validation or filtering)
+  # for many type of controls.
+  #
+  # Wx::GenericValidator supports:
+  # - boolean type controls
+  #   - Wx::CheckBox, Wx::RadioButton, Wx::ToggleButton, Wx::BitmapToggleButton
+  # - string type controls
+  #   - Wx::Button, Wx::StaticText, Wx::TextCtrl
+  #   - Wx::ComboBox in case it does not have style Wx::CB_READONLY
+  # - integer type controls
+  #   - Wx::RadioBox, Wx::SpinButton, Wx::SpinCtrl, Wx::Gauge, Wx::Slider, Wx::ScrollBar, Wx::Choice
+  #   - Wx::ComboBox in case it has style Wx::CB_READONLY
+  #   - Wx::ListBox and Wx::CheckListBox in case of style Wx::LB_SINGLE
+  # - integer array type controls
+  #   - Wx::ListBox and Wx::CheckListBox in case of style Wx::LB_MULTIPLE or Wx::LB_EXTENDED
+  # - date/time type controls
+  #   - Wx::DatePickerCtrl, Wx::TimePickerCtrl
+  #
+  # It checks the type of the window and uses an appropriate type for it.
+  # For example, Wx::Button and Wx::TextCtrl transfer data to and from a
+  # String variable; Wx::ListBox uses an Array of Integer (in case of multiple
+  # selection list) or an Integer (in case of a single choice list); Wx::CheckBox
+  # uses a boolean.
+  #
+  # In wxRuby this is a pure Ruby implementation derived from Wx::Validator and
+  # **not** a wrapper for the C++ wxGenericValidator class although the functionality
+  # is virtually identical.
+  #
+  # @see  Wx::Validator
+  # @see  Wx::TextValidator
+  # @see  Wx::IntegerValidator
+  # @see  Wx::UnsignedValidator
+  # @see  Wx::FloatValidator
+  #
+  # @wxrb_require USE_VALIDATORS
+  class GenericValidator < Wx::Validator
+
+    # Returns a Hash of handlers for the various control types this class supports.
+    # User defined extension (or re-definition) of these handlers is possible.
+    # @see GenericValidator.define_handler
+    # @return [Hash]
+    def self.handlers; end
+
+    # Defines a new handler for a control type (class).
+    #
+    # When called it should be supplied the control Class and either a Proc or Method
+    # instance or a block which should accept a single Wx::Window argument and an optional
+    # second argument.
+    # The handler will be called when transferring data from or to the associated window.
+    # The associated window is always passed as the first argument.
+    # In case of a transfer from the associated window that is the only argument and the
+    # handler should retrieve and return the data typical for the type of control window.
+    # In case of a transfer to the associated window the second argument will be the data
+    # to transfer to the associated control window.
+    #
+    # @example Definition of Wx::TextCtrl handler
+    #   GenericValidator.define_handler(Wx::TextCtrl) do |win, *val|
+    #     if val.empty?
+    #       win.get_value
+    #     else
+    #       win.set_value(val.shift)
+    #     end
+    #   end
+    #
+    # @param [Class] klass control window class
+    # @param [Proc,Method,nil] meth
+    # @return [void]
+    def self.define_handler(klass, meth=nil, &block) end
+
+    # @overload initialize
+    #   Default constructor.
+    #   @return [Wx::GenericValidator]
+    # @overload initialize(other)
+    #   Copy constructor.
+    #   @param [Wx::GenericValidator] other
+    #   @return [Wx::GenericValidator]
+    def initialize(*arg)end
+
+    # The value store attribute. Initially nil. When set the type should
+    # be appropriate for the associated control type.
+    # No forced conversions will be applied.
+    attr_accessor :value
+
+  end
+
+end

data/lib/wx/doc/graphics_context.rb

@@ -35,6 +35,7 @@ module Wx
     #   @see  Printing Under Unix (GTK+)
     #   @param printerDC [Wx::PrinterDC]
     #   @return [Wx::GraphicsContext]
+    #   @wxrb_require USE_PRINTING_ARCHITECTURE,WXMSW|WXOSX|USE_GTKPRINT
     # @overload self.draw_on(image)
     #   Creates a {Wx::GraphicsContext} associated with a {Wx::Image} and passes that object to the given block.
     #   Deletes the gc object after the block returns.

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

@@ -23,9 +23,30 @@ module Wx::GRID
 
     # Iterates all selected blocks passing each corresponding Wx::GRID::GridBlockCoords to the given block
     # or returns an enumerator if no block given.
+    # Notice that the blocks returned by this method are not ordered in any particular way and may overlap.
+    # For grids using rows or columns-only selection modes, #each_selected_row_block or #each_selected_col_block
+    # can be more convenient, as they return ordered and non-overlapping blocks.
     # @yieldparam [Wx::GRID::GridBlockCoords] selected_block
     # @return [Object,Enumerator] result of last block execution or an Enumerator if no block given
-    def selected_blocks; end
+    def each_selected_block; end
+
+    # Iterates an ordered range of non-overlapping selected rows passing each corresponding Wx::GRID::GridBlockCoords
+    # to the given block or returns an enumerator if no block given.
+    #
+    # For the grids using GridSelectRows selection mode, iterates (possibly none) the coordinates of non-overlapping
+    # selected row blocks in the natural order, i.e. from smallest to the biggest row indices.
+    # @yieldparam [Wx::GRID::GridBlockCoords] selected_block
+    # @return [Object,Enumerator] result of last block execution or an Enumerator if no block given
+    def each_selected_row_block; end
+
+    # Iterates an ordered range of non-overlapping selected columns passing each corresponding Wx::GRID::GridBlockCoords
+    # to the given block or returns an enumerator if no block given.
+    #
+    # For the grids using GridSelectColumn selection mode, iterates (possibly none) the coordinates of non-overlapping
+    # selected column blocks in the natural order, i.e. from smallest to the biggest column indices.
+    # @yieldparam [Wx::GRID::GridBlockCoords] selected_block
+    # @return [Object,Enumerator] result of last block execution or an Enumerator if no block given
+    def each_selected_col_block; end
 
   end
 

data/lib/wx/doc/help_controller.rb

@@ -5,16 +5,20 @@
 # :startdoc:
 
 
-class Wx::HelpController
+module Wx
 
-  # @return [void] Only does something for Wx::HTML::HtmlHelpController
-  def get_frame_parameters; end
+  class HelpController
 
-end
+    # @return [void] Only does something for Wx::HTML::HtmlHelpController
+    def get_frame_parameters; end
+
+  end
+
+  class ExtHelpController
 
-class Wx::ExtHelpController
+    # @return [void] Only does something for Wx::HTML::HtmlHelpController
+    def get_frame_parameters; end
 
-  # @return [void] Only does something for Wx::HTML::HtmlHelpController
-  def get_frame_parameters; end
+  end
 
 end

data/lib/wx/doc/html/html_help_controller.rb

@@ -5,10 +5,18 @@
 # :startdoc:
 
 
-class Wx::HTML::HelpController
+module Wx
 
-  # Returns the latest frame size and position settings and whether a new frame is drawn with each invocation.
-  # @return [Array(Wx::Frame,Wx::Size,Wx::Point,Boolean)] latest frame settings
-  def get_frame_parameters; end
+  module HTML
+
+    class HelpController
+
+      # Returns the latest frame size and position settings and whether a new frame is drawn with each invocation.
+      # @return [Array(Wx::Frame,Wx::Size,Wx::Point,Boolean)] latest frame settings
+      def get_frame_parameters; end
+
+    end
+
+  end
 
 end

data/lib/wx/doc/html/simple_html_listbox.rb

@@ -0,0 +1,22 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+class Wx
+
+  module HTML
+
+    class SimpleHtmlListBox
+
+      alias :get_client_data :get_client_object
+
+      alias :set_client_data :set_client_object
+
+    end
+
+  end
+
+end

data/lib/wx/doc/list_ctrl.rb

@@ -5,34 +5,38 @@
 # :startdoc:
 
 
-class Wx::ListCtrl
-
-  include Enumerable
-
-  # Iterates all items in the list control passing each item (id) to the given block.
-  # @yieldparam [Integer] item
-  # @return [Object] result of last block iteration
-  def each(&block) end
-
-  # Iterates all selected items in the list control (like #get_next_item(item, Wx::LIST_NEXT_ALL, Wx::LIST_STATE_SELECTED))
-  # passing each item (id) to the given block.
-  # @yieldparam [Integer] item
-  # @return [Object] result of last block iteration
-  def each_selected(&block) end
-
-  # Returns array of selected items.
-  # @return [Array<Integer>] selected items
-  def get_selections; end
-
-  # Call this function to sort the items in the list control.
-  # The sorting method will call the given block repeatedly to compare two items from the list
-  # passing the <b>item data</b> for each item as well as the `data` argument given to the #sort_items method.
-  # The block should return 0 if the items are equal, negative value if the first item is less than the second
-  # one and positive value if the first one is greater than the second one.
-  # @param [Object] data user data to pass on to the sorting block
-  # @yieldparam [Object] item_data1 data for first item
-  # @yieldparam [Object] item_data2 data for second item
-  # @yieldparam [Object] data propagated data argument
-  def sort_items(data = nil, &block) end
+module Wx
+
+  class ListCtrl
+
+    include Enumerable
+
+    # Iterates all items in the list control passing each item (id) to the given block.
+    # @yieldparam [Integer] item
+    # @return [Object] result of last block iteration
+    def each(&block) end
+
+    # Iterates all selected items in the list control (like #get_next_item(item, Wx::LIST_NEXT_ALL, Wx::LIST_STATE_SELECTED))
+    # passing each item (id) to the given block.
+    # @yieldparam [Integer] item
+    # @return [Object] result of last block iteration
+    def each_selected(&block) end
+
+    # Returns array of selected items.
+    # @return [Array<Integer>] selected items
+    def get_selections; end
+
+    # Call this function to sort the items in the list control.
+    # The sorting method will call the given block repeatedly to compare two items from the list
+    # passing the <b>item data</b> for each item as well as the `data` argument given to the #sort_items method.
+    # The block should return 0 if the items are equal, negative value if the first item is less than the second
+    # one and positive value if the first one is greater than the second one.
+    # @param [Object] data user data to pass on to the sorting block
+    # @yieldparam [Object] item_data1 data for first item
+    # @yieldparam [Object] item_data2 data for second item
+    # @yieldparam [Object] data propagated data argument
+    def sort_items(data = nil, &block) end
+
+  end
 
 end

data/lib/wx/doc/menu.rb

@@ -0,0 +1,20 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class Menu
+
+    # Yield each menu item to the given block.
+    # Returns an Enumerator if no block given.
+    # @yieldparam [Wx::MenuItem] item the menu item yielded
+    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    def each_item; end
+
+  end
+
+end

data/lib/wx/doc/notebook.rb

@@ -0,0 +1,21 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class Notebook
+
+    # Iterate each notebook page.
+    # Passes each page to the given block.
+    # Returns an Enumerator if no block given.
+    # @yieldparam [Wx::Window] page notebook page
+    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    def each_page; end
+
+  end
+
+end