wxruby3 0.9.1 → 0.9.3

data/lib/wx/doc/validator.rb

@@ -0,0 +1,113 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class Validator < EvtHandler
+
+    # @overload initialize()
+    #   Constructor.
+    #   @return [Wx::Validator]
+    # @overload initialize(other)
+    #   Copy constructor.
+    #   @param [Wx::Validator] other
+    #   @return [Wx::Validator]
+    def initialize(*arg) end
+
+    # Method called when transferring data from window.
+    # Should retrieve and return the data from the associated window (#get_window).
+    # By default returns nil (which indicates there is no custom data to transfer).
+    # Overload for customized functionality.
+    # @return [Object] retrieved data from window
+    def do_transfer_from_window; end
+    protected :do_transfer_from_window
+
+    # Method called when transferring data to window.
+    # Should transfer the given data to the associated window and return true if successful.
+    # By default does nothing and just returns true.
+    # Overload for customized functionality.
+    # @param [Object] data
+    # @return [Boolean]
+    def do_transfer_to_window(data) end
+    protected :do_transfer_to_window
+
+    # Mixin module providing data binding options for validators.
+    module Binding
+
+      # Installs a callback handler to capture the data retrieved from the associated window.
+      # The callback handler can be specified as a (name of a) method, a Proc or a block.
+      #
+      # @example This can be used to implement data binding like:
+      #   class MyValidator < Wx::Validator
+      #     def initialize(data_store)
+      #       @data_store = data_store
+      #       self.on_transfer_from_window :store_data
+      #       self.on_transfer_to_window :load_data
+      #     end
+      #     protected
+      #     def store_data(data)
+      #       @data_store.save_the_data(data)
+      #     end
+      #     def load_data
+      #       @data_store.get_the_data
+      #     end
+      #   end
+      #   val = MyValidator.new(a_data_store)
+      #   win.set_validator(val)
+      #
+      # @param [String,Symbol,Method,Proc] meth (name of) method or event handling proc; to be supplied when no block is given
+      # @yieldparam [Object] data the data retrieved from the window
+      def on_transfer_from_window(meth=nil, &block) end
+
+      # Installs a callback handler to provide the data to transfer to the associated window.
+      # The callback handler can be specified as a (name of a) method, a Proc or a block.
+      #
+      # @example This can be used to implement data binding like:
+      #   class MyValidator < Wx::Validator
+      #     def initialize(data_store)
+      #       @data_store = data_store
+      #       self.on_transfer_from_window :store_data
+      #       self.on_transfer_to_window :load_data
+      #     end
+      #     protected
+      #     def store_data(data)
+      #       @data_store.save_the_data(data)
+      #     end
+      #     def load_data
+      #       @data_store.get_the_data
+      #     end
+      #   end
+      #   val = MyValidator.new(a_data_store)
+      #   win.set_validator(val)
+      #
+      # @param [String,Symbol,Method,Proc] meth (name of) method or event handling proc; to be supplied when no block is given
+      # @yieldreturn [Object] the data to transfer to the window
+      def on_transfer_to_window(meth=nil, &block) end
+
+      # Method called with data transferred from window.
+      # By default will call the on_transfer_from_window handler if defined.
+      # Returns true if successful or none defined.
+      # @param [Object] data
+      # @return [Boolean]
+      def do_on_transfer_from_window(data) end
+      protected :do_on_transfer_from_window
+
+      # Method called to get data to transfer to window.
+      # By default will call the on_transfer_to_window handler if defined.
+      # Returns the handler's result if successful.
+      # Otherwise returns nil.
+      # @return [Object]
+      def do_on_transfer_to_window; end
+      protected :do_on_transfer_to_window
+
+    end
+
+    include Binding
+
+  end
+
+end

data/lib/wx/doc/variant.rb

@@ -5,165 +5,169 @@
 # :startdoc:
 
 
-class Wx::Variant
-
-  include ::Enumerable
-
-  # When a block is given iterates all items of a variant list passing
-  # each item to the block.
-  # Returns an enumerator when no block is given.
-  # @overload each(&block)
-  #   @yieldparam item [Wx::Variant] variant list item
-  #   @return [Object] result of last block execution
-  # @overload each
-  #   @return [Enumerator] an enumerator
-  def each; end
-
-  # Replaces the value of the current variant with the given value
-  # @overload assign(value)
-  #   Equality test operator.
-  #   @param value [Wx::Variant]
-  #   @return [self]
-  # @overload assign(value)
-  #   Equality test operator.
-  #   @param value [String]
-  #   @return [self]
-  # @overload assign(value)
-  #   Equality test operator.
-  #   @param value [Integer]
-  #   @return [self]
-  # @overload assign(value)
-  #   Equality test operator.
-  #   @param value [true,false]
-  #   @return [self]
-  # @overload assign(value)
-  #   Equality test operator.
-  #   @param value [Float]
-  #   @return [self]
-  # @overload assign(value)
-  #   Equality test operator.
-  #   @param value [Integer]
-  #   @return [self]
-  # @overload assign(value)
-  #   Equality test operator.
-  #   @param value [Integer]
-  #   @return [self]
-  # @overload assign(value)
-  #   Equality test operator.
-  #   @param value [Object]
-  #   @return [self]
-  # @overload assign(value)
-  #   Equality test operator.
-  #   @param value [Wx::Object]
-  #   @return [self]
-  # @overload assign(value)
-  #   Equality test operator.
-  #   @param value [Array<Wx::Variant>]
-  #   @return [self]
-  # @overload assign(value)
-  #   Equality test operator.
-  #   @param value [Array<String>]
-  #   @return [self]
-  # @overload assign(value)
-  #   Equality test operator.
-  #   @param value [Time,Date,DateTime]
-  #   @return [self]
-  def assign(*args) end
-  alias :<< :assign
-
-  # Convert contained object to integer value if possible.
-  # Raises TypeError exception if incompatible.
-  # @return [Integer] integer value
-  def to_i; end
-
-  # Convert contained object to floating point value if possible.
-  # Raises TypeError exception if incompatible.
-  # @return [Float] floating point value
-  def to_f; end
-
-  # Convert contained object to string value if possible.
-  # Raises TypeError exception if incompatible.
-  # @return [String] string value
-  def to_s; end
-
-  # Checks if Variant contains a String value (not null).
-  # @return [true,false]
-  def string?; end
-
-  # Checks if Variant contains a boolean value (not null).
-  # @return [true,false]
-  def bool?; end
-
-  # Checks if Variant contains a long value (not null).
-  # @return [true,false]
-  def long?; end
-
-  # Checks if Variant contains a long long value (not null).
-  # @return [true,false]
-  def long_long?; end
-
-  # Checks if Variant contains an unsigned long long value (not null).
-  # @return [true,false]
-  def u_long_long?; end
-
-  # Checks if Variant contains an integer value (long|long long|unsigned long long).
-  # @return [true,false]
-  def integer?; end
-
-  # Checks if Variant contains a (wx)DateTime value (not null).
-  # (Note that the DateTime values in question concern wxDateTime
-  # and not the Ruby DateTime class; in fact wxDateTime is normally
-  # returned as a Ruby Time value)
-  # @return [true,false]
-  def date_time?; end
-
-  # Checks if Variant contains a double value (not null).
-  # @return [true,false]
-  def double?; end
-
-  # Checks if Variant contains an integer value (integer | double).
-  # @return [true,false]
-  def numeric?; end
-
-  # Checks if Variant contains a VariantList (array of Variant) value (not null).
-  # @return [true,false]
-  def list?; end
-
-  # Checks if Variant contains an ArrayString (array of String) value (not null).
-  # @return [true,false]
-  def array_string?; end
-
-  # Checks if Variant contains a Font value (not null).
-  # @return [true,false]
-  def font?; end
-
-  # Returns font value.
-  # @return [Wx::Font]
-  def get_font; end
-  alias :font :get_font
-
-  # Checks if Variant contains a Colour value (not null).
-  # @return [true,false]
-  def colour?; end
-
-  # Returns colour value.
-  # @return [Wx::Colour]
-  def get_colour; end
-  alias :colour :get_colour
-
-  # Checks if Variant contains a ColourPropertyValue value (not null).
-  # @return [true,false]
-  def colour_property_value?; end
-
-  # Returns colour property value.
-  # @return [Wx::PG::ColourPropertyValue]
-  def get_colour_property_value; end
-  alias :colour_property_value :get_colour_property_value
-
-  # Checks if Variant contains an unspecified Ruby object (not null or
-  # nil and not one of the other value types).
-  # @param [Class] klass the (base) class of the Ruby object to check
-  # @return [true,false]
-  def object?(klass=Object) end
+module Wx
+
+  class Variant
+
+    include ::Enumerable
+
+    # When a block is given iterates all items of a variant list passing
+    # each item to the block.
+    # Returns an enumerator when no block is given.
+    # @overload each(&block)
+    #   @yieldparam item [Wx::Variant] variant list item
+    #   @return [Object] result of last block execution
+    # @overload each
+    #   @return [Enumerator] an enumerator
+    def each; end
+
+    # Replaces the value of the current variant with the given value
+    # @overload assign(value)
+    #   Equality test operator.
+    #   @param value [Wx::Variant]
+    #   @return [self]
+    # @overload assign(value)
+    #   Equality test operator.
+    #   @param value [String]
+    #   @return [self]
+    # @overload assign(value)
+    #   Equality test operator.
+    #   @param value [Integer]
+    #   @return [self]
+    # @overload assign(value)
+    #   Equality test operator.
+    #   @param value [true,false]
+    #   @return [self]
+    # @overload assign(value)
+    #   Equality test operator.
+    #   @param value [Float]
+    #   @return [self]
+    # @overload assign(value)
+    #   Equality test operator.
+    #   @param value [Integer]
+    #   @return [self]
+    # @overload assign(value)
+    #   Equality test operator.
+    #   @param value [Integer]
+    #   @return [self]
+    # @overload assign(value)
+    #   Equality test operator.
+    #   @param value [Object]
+    #   @return [self]
+    # @overload assign(value)
+    #   Equality test operator.
+    #   @param value [Wx::Object]
+    #   @return [self]
+    # @overload assign(value)
+    #   Equality test operator.
+    #   @param value [Array<Wx::Variant>]
+    #   @return [self]
+    # @overload assign(value)
+    #   Equality test operator.
+    #   @param value [Array<String>]
+    #   @return [self]
+    # @overload assign(value)
+    #   Equality test operator.
+    #   @param value [Time,Date,DateTime]
+    #   @return [self]
+    def assign(*args) end
+    alias :<< :assign
+
+    # Convert contained object to integer value if possible.
+    # Raises TypeError exception if incompatible.
+    # @return [Integer] integer value
+    def to_i; end
+
+    # Convert contained object to floating point value if possible.
+    # Raises TypeError exception if incompatible.
+    # @return [Float] floating point value
+    def to_f; end
+
+    # Convert contained object to string value if possible.
+    # Raises TypeError exception if incompatible.
+    # @return [String] string value
+    def to_s; end
+
+    # Checks if Variant contains a String value (not null).
+    # @return [true,false]
+    def string?; end
+
+    # Checks if Variant contains a boolean value (not null).
+    # @return [true,false]
+    def bool?; end
+
+    # Checks if Variant contains a long value (not null).
+    # @return [true,false]
+    def long?; end
+
+    # Checks if Variant contains a long long value (not null).
+    # @return [true,false]
+    def long_long?; end
+
+    # Checks if Variant contains an unsigned long long value (not null).
+    # @return [true,false]
+    def u_long_long?; end
+
+    # Checks if Variant contains an integer value (long|long long|unsigned long long).
+    # @return [true,false]
+    def integer?; end
+
+    # Checks if Variant contains a (wx)DateTime value (not null).
+    # (Note that the DateTime values in question concern wxDateTime
+    # and not the Ruby DateTime class; in fact wxDateTime is normally
+    # returned as a Ruby Time value)
+    # @return [true,false]
+    def date_time?; end
+
+    # Checks if Variant contains a double value (not null).
+    # @return [true,false]
+    def double?; end
+
+    # Checks if Variant contains an integer value (integer | double).
+    # @return [true,false]
+    def numeric?; end
+
+    # Checks if Variant contains a VariantList (array of Variant) value (not null).
+    # @return [true,false]
+    def list?; end
+
+    # Checks if Variant contains an ArrayString (array of String) value (not null).
+    # @return [true,false]
+    def array_string?; end
+
+    # Checks if Variant contains a Font value (not null).
+    # @return [true,false]
+    def font?; end
+
+    # Returns font value.
+    # @return [Wx::Font]
+    def get_font; end
+    alias :font :get_font
+
+    # Checks if Variant contains a Colour value (not null).
+    # @return [true,false]
+    def colour?; end
+
+    # Returns colour value.
+    # @return [Wx::Colour]
+    def get_colour; end
+    alias :colour :get_colour
+
+    # Checks if Variant contains a ColourPropertyValue value (not null).
+    # @return [true,false]
+    def colour_property_value?; end
+
+    # Returns colour property value.
+    # @return [Wx::PG::ColourPropertyValue]
+    def get_colour_property_value; end
+    alias :colour_property_value :get_colour_property_value
+
+    # Checks if Variant contains an unspecified Ruby object (not null or
+    # nil and not one of the other value types).
+    # @param [Class] klass the (base) class of the Ruby object to check
+    # @return [true,false]
+    def object?(klass=Object) end
+
+  end
 
 end

data/lib/wx/doc/window.rb

@@ -5,52 +5,92 @@
 # :startdoc:
 
 
-class Wx::Window
-
-  # Creates an appropriate (temporary) DC to paint on and
-  # passes that to the given block. Deletes the DC when the block returns.
-  # Creates a Wx::PaintDC when called from an evt_paint handler and a
-  # Wx::ClientDC otherwise.
-  # @yieldparam [Wx::PaintDC,Wx::ClientDC] dc dc to paint on
-  # @return [Object] result from block
-  def paint; end
-
-  # Similar to #paint but this time creates a Wx::AutoBufferedPaintDC when called
-  # from an evt_paint handler and a Wx::ClientDC otherwise.
-  # @yieldparam [Wx::AutoBufferedPaintDC,Wx::ClientDC] dc dc to paint on
-  # @return [Object] result from block
-  def paint_buffered; end
-
-  # Locks the window from updates while executing the given block.
-  # @param [Proc] block
-  def locked(&block); end
-
-  # Find the first child window with the given id recursively in the window hierarchy of this window.
-  #
-  # Window with the given id or nil if not found.
-  # @see Wx::Window.find_window_by_id
-  # @param id [Integer]
-  # @return [Wx::Window]
-  def find_window_by_id(id) end
-
-  # Find the first child window with the given label recursively in the window hierarchy of this window.
-  #
-  # Window with the given label or nil if not found.
-  # @see Wx::Window.find_window_by_label
-  # @param label [String]
-  # @return [Wx::Window]
-  def find_window_by_label(label) end
-
-  # Find the first child window with the given name (as given in a window constructor or {Wx::Window#create} function call) recursively in the window hierarchy of this window.
-  #
-  # Window with the given name or nil if not found.
-  # @param name [String]
-  # @return [Wx::Window]
-  def find_window_by_name(name) end
-
-  # Switches the current sizer with the given sizer and detaches and returns the 'old' sizer.
-  # @param [Wx::Sizer] new_sizer new sizer for window
-  # @return [Wx::Sizer] previous window sizer
-  def switch_sizer(new_sizer) end
+module Wx
+
+  class Window
+
+    # Lowers the window to the bottom of the window hierarchy (Z-order).
+    # This method has been renamed in wxRuby to be consistent with the renamed #raise_window method.
+    #
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function only works for {Wx::TopLevelWindow}-derived classes.
+    # </p>
+    # </div>
+    # @see Wx::Window#raise_window
+    # @return [void]
+    def lower_window; end
+    alias :send_to_back :lower_window
+
+    # Raises the window to the top of the window hierarchy (Z-order).
+    # This method has been renamed in wxRuby to avoid clashing with the standard Kernel#raise method.
+    #
+    # Notice that this function only requests the window manager to raise this window to the top of Z-order. Depending
+    # on its configuration, the window manager may raise the window, not do it at all or indicate that a window
+    # requested to be raised in some other way, e.g. by flashing its icon if it is minimized.
+    #
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function only works for {Wx::TopLevelWindow}-derived classes.
+    # </p>
+    # </div>
+    # @see Wx::Window#lower_window
+    # @return [void]
+    def raise_window; end
+    alias :bring_to_front :raise_window
+
+    # Creates an appropriate (temporary) DC to paint on and
+    # passes that to the given block. Deletes the DC when the block returns.
+    # Creates a Wx::PaintDC when called from an evt_paint handler and a
+    # Wx::ClientDC otherwise.
+    # @yieldparam [Wx::PaintDC,Wx::ClientDC] dc dc to paint on
+    # @return [Object] result from block
+    def paint; end
+
+    # Similar to #paint but this time creates a Wx::AutoBufferedPaintDC when called
+    # from an evt_paint handler and a Wx::ClientDC otherwise.
+    # @yieldparam [Wx::AutoBufferedPaintDC,Wx::ClientDC] dc dc to paint on
+    # @return [Object] result from block
+    def paint_buffered; end
+
+    # Yield each child window to the given block.
+    # Returns an Enumerator if no block given.
+    # @yieldparam [Wx::Window] child the child window yielded
+    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    def each_child; end
+
+    # Locks the window from updates while executing the given block.
+    # @param [Proc] block
+    def locked(&block); end
+
+    # Find the first child window with the given id recursively in the window hierarchy of this window.
+    #
+    # Window with the given id or nil if not found.
+    # @see Wx::Window.find_window_by_id
+    # @param id [Integer]
+    # @return [Wx::Window]
+    def find_window_by_id(id) end
+
+    # Find the first child window with the given label recursively in the window hierarchy of this window.
+    #
+    # Window with the given label or nil if not found.
+    # @see Wx::Window.find_window_by_label
+    # @param label [String]
+    # @return [Wx::Window]
+    def find_window_by_label(label) end
+
+    # Find the first child window with the given name (as given in a window constructor or {Wx::Window#create} function call) recursively in the window hierarchy of this window.
+    #
+    # Window with the given name or nil if not found.
+    # @param name [String]
+    # @return [Wx::Window]
+    def find_window_by_name(name) end
+
+    # Switches the current sizer with the given sizer and detaches and returns the 'old' sizer.
+    # @param [Wx::Sizer] new_sizer new sizer for window
+    # @return [Wx::Sizer] previous window sizer
+    def switch_sizer(new_sizer) end
+
+  end
 
 end

data/lib/wx/doc/window_disabler.rb

@@ -5,12 +5,16 @@
 # :startdoc:
 
 
-class Wx::WindowDisabler
+module Wx
 
-  # Disables all top level windows of the application (maybe with the exception of one of them) in
-  # and enables them back after the given block has returned.
-  # @param [Wx::Window,nil] to_skip window to exclude from disabling
-  # @return [void]
-  def self.disable(to_skip = nil) end
+  class WindowDisabler
+
+    # Disables all top level windows of the application (maybe with the exception of one of them) in
+    # and enables them back after the given block has returned.
+    # @param [Wx::Window,nil] to_skip window to exclude from disabling
+    # @return [void]
+    def self.disable(to_skip = nil) end
+
+  end
 
 end

data/lib/wx/grid/grid.rb

@@ -12,12 +12,35 @@ module Wx
       alias :set_table :assign_table
       alias :table= :assign_table
 
-      wx_selected_blocks = instance_method :selected_blocks
-      define_method :selected_blocks do
+      wx_each_selected_block = instance_method :each_selected_block
+      define_method :each_selected_block do
         if block_given?
-          wx_selected_blocks.bind(self).call
+          wx_each_selected_block.bind(self).call
         else
-          ::Enumerator.new { |y| wx_selected_blocks.bind(self).call { |sb| y << sb } }
+          ::Enumerator.new { |y| wx_each_selected_block.bind(self).call { |sb| y << sb } }
+        end
+      end
+
+      def get_selected_blocks
+        each_selected_block.to_a
+      end
+      alias :selected_blocks :get_selected_blocks
+
+      wx_each_selected_row_block = instance_method :each_selected_row_block
+      define_method :each_selected_row_block do
+        if block_given?
+          wx_each_selected_row_block.bind(self).call
+        else
+          ::Enumerator.new { |y| wx_each_selected_row_block.bind(self).call { |sb| y << sb } }
+        end
+      end
+
+      wx_each_selected_col_block = instance_method :each_selected_col_block
+      define_method :each_selected_col_block do
+        if block_given?
+          wx_each_selected_col_block.bind(self).call
+        else
+          ::Enumerator.new { |y| wx_each_selected_col_block.bind(self).call { |sb| y << sb } }
         end
       end