wxruby3 0.9.1 → 0.9.2

data/lib/wx/doc/font.rb

@@ -6,6 +6,7 @@
 
 
 module Wx
+
   class Font
 
     # @overload find_or_create_font(point_size, family, style, weight, underline=false, facename='', encoding=Wx::FontEncoding::FONTENCODING_DEFAULT)

data/lib/wx/doc/gc_dc.rb

@@ -14,10 +14,15 @@ module Wx
     # Creates a Wx::GCDC instance for target and
     # passes the instance to the given block to draw on.
     # @overload draw_on(dc)
-    #   @param [Wx::WindowDC,Wx::MemoryDC,Wx::PrinterDC] target DC to draw on
+    #   @param [Wx::WindowDC,Wx::MemoryDC] target DC to draw on
     #   @yieldparam [Wx::GCDC] dc GCDC instance to draw on
     #   @return [Object] result from block
     # @overload draw_on(dc)
+    #   @param [Wx::PrinterDC] target DC to draw on
+    #   @yieldparam [Wx::GCDC] dc GCDC instance to draw on
+    #   @return [Object] result from block
+    #   @wxrb_require USE_PRINTING_ARCHITECTURE,WXMSW|WXOSX|USE_GTKPRINT
+    # @overload draw_on(gc)
     #   @param [Wx::GraphicsContext] gc GraphicsContext to draw on
     #   @yieldparam [Wx::GCDC] dc GCDC instance to draw on
     #   @return [Object] result from block

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/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

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

@@ -5,17 +5,21 @@
 # :startdoc:
 
 
-class Wx::EvtHandler
+module Wx
 
-  # @!group PG Event handler methods
+  class EvtHandler
 
-  # Respond to {Wx::PG::EVT_PG_PAGE_CHANGED} event, generated when selected property page has been changed by the user.
-  # Processes a {Wx::PG::EVT_PG_PAGE_CHANGED} event.
-  # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
-  # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
-  # @yieldparam [Wx::PG::PropertyGridEvent] event the event to handle
-  def evt_pg_page_changed(id, meth = nil, &block) end
+    # @!group PG Event handler methods
 
-  # @!endgroup
+    # Respond to {Wx::PG::EVT_PG_PAGE_CHANGED} event, generated when selected property page has been changed by the user.
+    # Processes a {Wx::PG::EVT_PG_PAGE_CHANGED} event.
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::PG::PropertyGridEvent] event the event to handle
+    def evt_pg_page_changed(id, meth = nil, &block) end
+
+    # @!endgroup
+
+  end
 
 end

data/lib/wx/doc/pg/pg_property.rb

@@ -22,4 +22,22 @@ module Wx::PG
 
   end
 
+  class PGChoices
+
+    # Iterate each label.
+    # Passes each label string to the given block.
+    # Returns an Enumerator if no block given.
+    # @yieldparam [String] label label string
+    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    def each_label; end
+
+    # Iterate each choice entry.
+    # Passes each choice entry to the given block.
+    # Returns an Enumerator if no block given.
+    # @yieldparam [Wx::PG::ChoiceEntry] entry choice entry
+    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    def each_entry; end
+
+  end
+
 end

data/lib/wx/doc/progress_dialog.rb

@@ -5,39 +5,43 @@
 # :startdoc:
 
 
-class Wx::ProgressDialog
+module Wx
 
-  # Updates the dialog, setting the progress bar to the new value and updating the message if new one is specified.
-  #
-  # Returns <code>false</code> if the "Cancel" button has been pressed, <code>true</code> if neither "Cancel" nor
-  # "Skip" has been pressed and <code>:skipped</code> if "Skip" has been pressed.
-  #
-  # If false is returned, the application can either immediately destroy the dialog or ask the user for the confirmation
-  # and if the abort is not confirmed the dialog may be resumed with #resume method.
-  #
-  # If value is the maximum value for the dialog, the behaviour of the function depends on whether Wx::PD_AUTO_HIDE was
-  # used when the dialog was created. If it was, the dialog is hidden and the function returns immediately. If it was
-  # not, the dialog becomes a modal dialog and waits for the user to dismiss it, meaning that this function does not
-  # return until this happens.
-  #
-  # Notice that if newmsg is longer than the currently shown message, the dialog will be automatically made wider to
-  # account for it. However if the new message is shorter than the previous one, the dialog doesn't shrink back to
-  # avoid constant resizes if the message is changed often. To do this and fit the dialog to its current contents you
-  # may call fit explicitly. An alternative would be to keep the number of lines of text constant in order to avoid
-  # jarring dialog size changes. You may also want to make the initial message, specified when creating the dialog,
-  # wide enough to avoid having to resize the dialog later, e.g. by appending a long string of unbreakable spaces
-  # (wxString(L'\u00a0', 100)) to it.
-  # @param [Integer] value The new value of the progress meter. It should be less than or equal to the maximum value given to the constructor.
-  # @param [String] newmsg The new messages for the progress dialog text, if it is empty (which is the default) the message is not changed.
-  # @return [Boolean,:skipped]
-  def update(value, newmsg = '') end
+  class ProgressDialog
 
-  # Like #update but makes the gauge control run in indeterminate mode.
-  #
-  # In indeterminate mode the remaining and the estimated time labels (if present) are set to "Unknown" or to newmsg
-  # (if it's non-empty). Each call to this function moves the progress bar a bit to indicate that some progress was done.
-  # @param [String] newmsg
-  # @return [Boolean,:skipped]
-  def pulse(newmsg = '') end
+    # Updates the dialog, setting the progress bar to the new value and updating the message if new one is specified.
+    #
+    # Returns <code>false</code> if the "Cancel" button has been pressed, <code>true</code> if neither "Cancel" nor
+    # "Skip" has been pressed and <code>:skipped</code> if "Skip" has been pressed.
+    #
+    # If false is returned, the application can either immediately destroy the dialog or ask the user for the confirmation
+    # and if the abort is not confirmed the dialog may be resumed with #resume method.
+    #
+    # If value is the maximum value for the dialog, the behaviour of the function depends on whether Wx::PD_AUTO_HIDE was
+    # used when the dialog was created. If it was, the dialog is hidden and the function returns immediately. If it was
+    # not, the dialog becomes a modal dialog and waits for the user to dismiss it, meaning that this function does not
+    # return until this happens.
+    #
+    # Notice that if newmsg is longer than the currently shown message, the dialog will be automatically made wider to
+    # account for it. However if the new message is shorter than the previous one, the dialog doesn't shrink back to
+    # avoid constant resizes if the message is changed often. To do this and fit the dialog to its current contents you
+    # may call fit explicitly. An alternative would be to keep the number of lines of text constant in order to avoid
+    # jarring dialog size changes. You may also want to make the initial message, specified when creating the dialog,
+    # wide enough to avoid having to resize the dialog later, e.g. by appending a long string of unbreakable spaces
+    # (wxString(L'\u00a0', 100)) to it.
+    # @param [Integer] value The new value of the progress meter. It should be less than or equal to the maximum value given to the constructor.
+    # @param [String] newmsg The new messages for the progress dialog text, if it is empty (which is the default) the message is not changed.
+    # @return [Boolean,:skipped]
+    def update(value, newmsg = '') end
+
+    # Like #update but makes the gauge control run in indeterminate mode.
+    #
+    # In indeterminate mode the remaining and the estimated time labels (if present) are set to "Unknown" or to newmsg
+    # (if it's non-empty). Each call to this function moves the progress bar a bit to indicate that some progress was done.
+    # @param [String] newmsg
+    # @return [Boolean,:skipped]
+    def pulse(newmsg = '') end
+
+  end
 
 end

data/lib/wx/doc/prt/page_setup_dialog.rb

@@ -5,17 +5,25 @@
 # :startdoc:
 
 
-class Wx::PRT::PageSetupDialog
-
-  # Returns (a copy of) the page setup data of the dialog.
-  # @return [Wx::PRT::PageSetupDialogData] page setup data copy
-  def get_page_setup_data; end
-  alias :page_setup_data :get_page_setup_data
-
-  # Updates the page setup data for the dialog.
-  # @param [Wx::PRT::PageSetupDialogData] setup_data the page setup data to update the dialog with
-  # @return [void]
-  def set_page_setup_data(setup_data); end
-  alias :page_setup_data= :set_page_setup_data
+module Wx
+
+  module PRT
+
+    class PageSetupDialog
+
+      # Returns (a copy of) the page setup data of the dialog.
+      # @return [Wx::PRT::PageSetupDialogData] page setup data copy
+      def get_page_setup_data; end
+      alias :page_setup_data :get_page_setup_data
+
+      # Updates the page setup data for the dialog.
+      # @param [Wx::PRT::PageSetupDialogData] setup_data the page setup data to update the dialog with
+      # @return [void]
+      def set_page_setup_data(setup_data); end
+      alias :page_setup_data= :set_page_setup_data
+
+    end
+
+  end
 
 end

data/lib/wx/doc/prt/print_data.rb

@@ -5,11 +5,19 @@
 # :startdoc:
 
 
-class Wx::PRT::PrintDialogData
+module Wx
 
-  # Returns (a copy of) the print data.
-  # @return [Wx::PRT::PrintData] print data copy
-  def get_print_data; end
-  alias :print_data :get_print_data
+  module PRT
+
+    class PrintDialogData
+
+      # Returns (a copy of) the print data.
+      # @return [Wx::PRT::PrintData] print data copy
+      def get_print_data; end
+      alias :print_data :get_print_data
+
+    end
+
+  end
 
 end

data/lib/wx/doc/prt/print_dialog.rb

@@ -5,28 +5,36 @@
 # :startdoc:
 
 
-class Wx::PRT::PrintDialog
-
-  # Returns (a copy of) the print data of the dialog.
-  # @return [Wx::PRT::PrintData] print data copy
-  def get_print_data; end
-  alias :print_data :get_print_data
-
-  # Updates the print data for the dialog.
-  # @param [Wx::PRT::PrintData] prt_data the print data to update the dialog with
-  # @return [void]
-  def set_print_data(prt_data); end
-  alias :print_data= :set_print_data
-
-  # Returns (a copy of) the print dialog data of the dialog.
-  # @return [Wx::PRT::PrintDialogData] print dialog data copy
-  def get_print_dialog_data; end
-  alias :print_dialog_data :get_print_dialog_data
-
-  # Updates the print dialog data for the dialog.
-  # @param [Wx::PRT::PrintDialogData] prt_data the print dialog data to update the dialog with
-  # @return [void]
-  def set_print_dialog_data(prt_data); end
-  alias :print_dialog_data= :set_print_dialog_data
+module Wx
+
+  module PRT
+
+    class PrintDialog
+
+      # Returns (a copy of) the print data of the dialog.
+      # @return [Wx::PRT::PrintData] print data copy
+      def get_print_data; end
+      alias :print_data :get_print_data
+
+      # Updates the print data for the dialog.
+      # @param [Wx::PRT::PrintData] prt_data the print data to update the dialog with
+      # @return [void]
+      def set_print_data(prt_data); end
+      alias :print_data= :set_print_data
+
+      # Returns (a copy of) the print dialog data of the dialog.
+      # @return [Wx::PRT::PrintDialogData] print dialog data copy
+      def get_print_dialog_data; end
+      alias :print_dialog_data :get_print_dialog_data
+
+      # Updates the print dialog data for the dialog.
+      # @param [Wx::PRT::PrintDialogData] prt_data the print dialog data to update the dialog with
+      # @return [void]
+      def set_print_dialog_data(prt_data); end
+      alias :print_dialog_data= :set_print_dialog_data
+
+    end
+
+  end
 
 end

data/lib/wx/doc/prt/printer.rb

@@ -5,17 +5,25 @@
 # :startdoc:
 
 
-class Wx::PRT::Printer
-
-  # Returns (a copy of) the print dialog data of the printer.
-  # @return [Wx::PRT::PrintDialogData] print dialog data copy
-  def get_print_dialog_data; end
-  alias :print_dialog_data :get_print_dialog_data
-
-  # Updates the print dialog data for the printer.
-  # @param [Wx::PRT::PrintDialogData] prt_data the print dialog data to update the printer with
-  # @return [void]
-  def set_print_dialog_data(prt_data); end
-  alias :print_dialog_data= :set_print_dialog_data
+module Wx
+
+  module PRT
+
+    class Printer
+
+      # Returns (a copy of) the print dialog data of the printer.
+      # @return [Wx::PRT::PrintDialogData] print dialog data copy
+      def get_print_dialog_data; end
+      alias :print_dialog_data :get_print_dialog_data
+
+      # Updates the print dialog data for the printer.
+      # @param [Wx::PRT::PrintDialogData] prt_data the print dialog data to update the printer with
+      # @return [void]
+      def set_print_dialog_data(prt_data); end
+      alias :print_dialog_data= :set_print_dialog_data
+
+    end
+
+  end
 
 end

data/lib/wx/doc/radio_box.rb

@@ -5,22 +5,26 @@
 # :startdoc:
 
 
-class Wx::RadioBox
+module Wx
 
-  # Enables od disables individual buttons.
-  # true if the item has been enabled or disabled or false if nothing was done because it already was in the requested state.
-  # @see Wx::Window#enable
-  # @param item [Integer]  The zero-based position of the button to enable or disable.
-  # @param enable [true,false]  true to enable, false to disable.
-  # @return [true,false]
-  def enable_item(item, enable=true) end
+  class RadioBox
 
-  # Shows or hides individual buttons.
-  # true if the item has been shown or hidden or false if nothing was done because it already was in the requested state.
-  # @see Wx::Window#show
-  # @param item [Integer]  The zero-based position of the button to show or hide.
-  # @param show [true,false]  true to show, false to hide.
-  # @return [true,false]
-  def show_item(item, show=true) end
+    # Enables od disables individual buttons.
+    # true if the item has been enabled or disabled or false if nothing was done because it already was in the requested state.
+    # @see Wx::Window#enable
+    # @param item [Integer]  The zero-based position of the button to enable or disable.
+    # @param enable [true,false]  true to enable, false to disable.
+    # @return [true,false]
+    def enable_item(item, enable=true) end
+
+    # Shows or hides individual buttons.
+    # true if the item has been shown or hidden or false if nothing was done because it already was in the requested state.
+    # @see Wx::Window#show
+    # @param item [Integer]  The zero-based position of the button to show or hide.
+    # @param show [true,false]  true to show, false to hide.
+    # @return [true,false]
+    def show_item(item, show=true) end
+
+  end
 
 end

data/lib/wx/doc/rbn/ribbon_bar.rb

@@ -5,11 +5,19 @@
 # :startdoc:
 
 
-class Wx::RBN::RibbonBar
+module Wx
 
-  # Iterate ribbon pages if block given or return enumerator.
-  # @yieldparam [Wx::RBN::RibbonPage] page A ribbon page instance
-  # @return [Object,Enumerator] result from last block execution or an enumerator
-  def pages; end
+  module RBN
+
+    class RibbonBar
+
+      # Iterate ribbon pages if block given or return enumerator.
+      # @yieldparam [Wx::RBN::RibbonPage] page A ribbon page instance
+      # @return [Object,Enumerator] result from last block execution or an enumerator
+      def pages; end
+
+    end
+
+  end
 
 end

data/lib/wx/doc/rbn/ribbon_button_bar.rb

@@ -5,11 +5,19 @@
 # :startdoc:
 
 
-class Wx::RBN::RibbonButtonBar
+module Wx
 
-  # Iterate button items if block given else return enumerator.
-  # @yieldparam [Integer] button_id Id of a button item
-  # @return [Object,Enumerator] result from last block execution or an enumerator
-  def items; end
+  module RBN
+
+    class RibbonButtonBar
+
+      # Iterate button items if block given else return enumerator.
+      # @yieldparam [Integer] button_id Id of a button item
+      # @return [Object,Enumerator] result from last block execution or an enumerator
+      def items; end
+
+    end
+
+  end
 
 end

data/lib/wx/doc/rbn/ribbon_gallery.rb

@@ -5,11 +5,19 @@
 # :startdoc:
 
 
-class Wx::RBN::RibbonGallery
+module Wx
 
-  # Iterate gallery items if block given else return enumerator.
-  # @yieldparam [Integer] index Gallery item index
-  # @return [Object,Enumerator] result from last block execution or an enumerator
-  def items; end
+  module RBN
+
+    class RibbonGallery
+
+      # Iterate gallery items if block given else return enumerator.
+      # @yieldparam [Integer] index Gallery item index
+      # @return [Object,Enumerator] result from last block execution or an enumerator
+      def items; end
+
+    end
+
+  end
 
 end