wxruby3 0.9.1 → 0.9.3

data/lib/wx/doc/owner_drawn_combobox.rb

@@ -0,0 +1,96 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class OwnerDrawnComboBox
+
+    # Returns the label of the selected item or an empty string if no item is selected.
+    #
+    # @see Wx::OwnerDrawnComboBox#get_selection
+    # @return [String]
+    def get_list_string_selection; end
+    alias :list_string_selection :get_list_string_selection
+
+    # Selects the item with the specified string in the control.
+    #
+    # This method doesn't cause any command events to be emitted.
+    # Notice that this method is case-insensitive, i.e. the string is compared with all the elements of the control
+    # case-insensitively and the first matching entry is selected, even if it doesn't have exactly the same case as
+    # this string and there is an exact match afterwards.
+    #
+    # true if the specified string has been selected, false if it wasn't found in the control.
+    # @param string [String]  The string to select.
+    # @return [Boolean]
+    def set_list_string_selection(string) end
+    alias :list_string_selection= :set_list_string_selection
+
+    # Returns the index of the selected item or {Wx::NOT_FOUND} if no item is selected.
+    #
+    # The position of the current selection.
+    # @see Wx::OwnerDrawnComboBox#set_list_selection
+    # @see  Wx::OwnerDrawnComboBox#get_list_string_selection
+    # @return [Integer]
+    def get_list_selection; end
+    alias :list_selection :get_list_selection
+
+    # Sets the selection to the given item n or removes the selection entirely if n == {Wx::NOT_FOUND}.
+    #
+    # Note that this does not cause any command events to be emitted nor does it deselect any other items in the controls which support multiple selections.
+    # @see Wx::OwnerDrawnComboBox#set_string
+    # @see  Wx::OwnerDrawnComboBox#set_list_string_selection
+    # @param n [Integer]  The string position to select, starting from zero.
+    # @return [void]
+    def set_list_selection(n) end
+    alias :list_selection= :set_list_selection
+
+    # Returns the number of items in the control.
+    #
+    # @see Wx::OwnerDrawnComboBox#is_list_empty
+    # @return [Integer]
+    def get_count; end
+    alias_method :count, :get_count
+
+    # Returns the label of the item with the given index.
+    #
+    # The index must be valid, i.e. less than the value returned by {Wx::OwnerDrawnComboBox#get_count},
+    # otherwise an assert is triggered. Notably, this function can't be called if the control is empty.
+    #
+    # The label of the item.
+    # @param n [Integer]  The zero-based index.
+    # @return [String]
+    def get_string(n) end
+    alias_method :string, :get_string
+
+    # Returns the array of the labels of all items in the control.
+    # @return [Array<String>]
+    def get_strings; end
+    alias_method :strings, :get_strings
+
+    # Sets the label for the given item.
+    # @param n [Integer]  The zero-based item index.
+    # @param string [String]  The label to set.
+    # @return [void]
+    def set_string(n, string) end
+
+    # Finds an item whose label matches the given string.
+    #
+    # The zero-based position of the item, or {Wx::NOT_FOUND} if the string was not found.
+    # @param string [String]  String to find.
+    # @param caseSensitive [Boolean]  Whether search is case sensitive (default is not).
+    # @return [Integer]
+    def find_string(string, caseSensitive=false) end
+
+    # This is the same as {Wx::OwnerDrawnComboBox#set_list_selection} and exists only because it is slightly
+    # more natural for controls which support multiple selection.
+    # @param n [Integer]
+    # @return [void]
+    def select(n) 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/numeric_property_validator.rb

@@ -0,0 +1,33 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::PG
+
+  class NumericPropertyValidator < TextValidator
+
+    # @overload initialize(validator)
+    #   Copy constructor.
+    #   @param [Wx::wxNumericPropertyValidator] validator validator to copy
+    # @overload initialize(numericType, base=10)
+    #   @param numericType [Wx::wxNumericPropertyValidator::NumericType]
+    #   @param base [Integer]
+    #   @return [Wx::PG::NumericPropertyValidator]
+    def initialize(*args) end
+
+    # Returns the value store attribute. Initially an empty string.
+    # @return [String]
+    def get_value; end
+    alias :value :get_value
+
+    # Sets the value store attribute.
+    # @param [String] val
+    def set_value(val) end
+    alias :value= :set_value
+
+  end # NumericPropertyValidator
+  
+
+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

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

@@ -5,11 +5,19 @@
 # :startdoc:
 
 
-class Wx::RBN::RibbonToolBar
+module Wx
 
-  # Iterate tool items if block given or return enumerator.
-  # @yieldparam [Integer] tool_id A tool item id
-  # @return [Object,Enumerator] result from last block execution or an enumerator
-  def tools; end
+  module RBN
+
+    class RibbonToolBar
+
+      # Iterate tool items if block given or return enumerator.
+      # @yieldparam [Integer] tool_id A tool item id
+      # @return [Object,Enumerator] result from last block execution or an enumerator
+      def tools; end
+
+    end
+
+  end
 
 end

data/lib/wx/doc/region_iterator.rb

@@ -5,33 +5,37 @@
 # :startdoc:
 
 
-class Wx::RegionIterator
-
-  # Creates a Wx::RegionIterator and passes that to the given block.
-  # Removes the iterator after the block finishes.
-  # @param [Wx::Region] region
-  # @yieldparam [Wx::RegionIterator] region_it
-  def self.for_region(region)  end
-
-  # Creates a Wx::RegionIterator and iterates each rectangle in the region executing the given block
-  # for each iteration passing the region iterator.
-  # @param [Wx::Region] region
-  # @yieldparam [Wx::RegionIterator] region_it
-  def self.iterate(region) end
-
-  alias :have_rects? :have_rects
-
-  # Moves to the next rectangle of the iterated region.
-  # @return [void]
-  def next_rect; end
-
-  # If a block is given the given block is called for each rectangle in the region passing the rectangle.
-  # If no block is given an Enumerator is returned.
-  # @overload each(&block)
-  #   @yieldparam [Wx::Rect] rect
-  #   @return [Object]
-  # @overload each()
-  #   @return [Enumerator]
-  def each; end
+module Wx
+
+  class RegionIterator
+
+    # Creates a Wx::RegionIterator and passes that to the given block.
+    # Removes the iterator after the block finishes.
+    # @param [Wx::Region] region
+    # @yieldparam [Wx::RegionIterator] region_it
+    def self.for_region(region)  end
+
+    # Creates a Wx::RegionIterator and iterates each rectangle in the region executing the given block
+    # for each iteration passing the region iterator.
+    # @param [Wx::Region] region
+    # @yieldparam [Wx::RegionIterator] region_it
+    def self.iterate(region) end
+
+    alias :have_rects? :have_rects
+
+    # Moves to the next rectangle of the iterated region.
+    # @return [void]
+    def next_rect; end
+
+    # If a block is given the given block is called for each rectangle in the region passing the rectangle.
+    # If no block is given an Enumerator is returned.
+    # @overload each(&block)
+    #   @yieldparam [Wx::Rect] rect
+    #   @return [Object]
+    # @overload each()
+    #   @return [Enumerator]
+    def each; end
+
+  end
 
 end

data/lib/wx/doc/rtc/rich_text_composite_object.rb

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