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

data/lib/wx/doc/stream.rb

@@ -5,40 +5,44 @@
 # :startdoc:
 
 
-class Wx::InputStream
-
-  # @overload read(size)
-  #   Reads max size bytes from stream.
-  #   @param [Integer] size max number of bytes to read
-  #   @return [String,nil] string with bytes read (nil if none read)
-  # @overload read(output)
-  #   Reads bytes from stream and writes these to output stream until eof or error.
-  #   @param [IO,Wx::OutputStream] output output stream to write to
-  #   @return [self]
-  def read(*args); end
-
-  #   Reads size bytes from stream (until eof or error).
-  #   @param [Integer] size number of bytes to read
-  #   @return [String,nil] string with bytes read (nil if none read)
-  def read_all(size); end
-
-end
-
-class Wx::OutputStream
-
-  # @overload write(buffer)
-  #   Writes some or all bytes from buffer to stream.
-  #   @param [String] buffer string with bytes to write
-  #   @return [Integer] number of bytes written
-  # @overload write(input)
-  #   Write bytes read from input stream (until eof or error)
-  #   @param [IO,Wx::InputStream] input input stream to read from
-  #   @return [self]
-  def write(*args); end
-
-  # Writes bytes from buffer to stream.
-  # @param [String] buffer string with bytes to write
-  # @return [Integer] number of bytes written
-  def write_all(buffer); end
+module Wx
+
+  class InputStream
+
+    # @overload read(size)
+    #   Reads max size bytes from stream.
+    #   @param [Integer] size max number of bytes to read
+    #   @return [String,nil] string with bytes read (nil if none read)
+    # @overload read(output)
+    #   Reads bytes from stream and writes these to output stream until eof or error.
+    #   @param [IO,Wx::OutputStream] output output stream to write to
+    #   @return [self]
+    def read(*args); end
+
+    #   Reads size bytes from stream (until eof or error).
+    #   @param [Integer] size number of bytes to read
+    #   @return [String,nil] string with bytes read (nil if none read)
+    def read_all(size); end
+
+  end
+
+  class OutputStream
+
+    # @overload write(buffer)
+    #   Writes some or all bytes from buffer to stream.
+    #   @param [String] buffer string with bytes to write
+    #   @return [Integer] number of bytes written
+    # @overload write(input)
+    #   Write bytes read from input stream (until eof or error)
+    #   @param [IO,Wx::InputStream] input input stream to read from
+    #   @return [self]
+    def write(*args); end
+
+    # Writes bytes from buffer to stream.
+    # @param [String] buffer string with bytes to write
+    # @return [Integer] number of bytes written
+    def write_all(buffer); end
+
+  end
 
 end

data/lib/wx/doc/system_settings.rb

@@ -5,31 +5,35 @@
 # :startdoc:
 
 
-class Wx::SystemSettings
-
-  # Return the name of the current system appearance if available or empty string otherwise.
-  #
-  # This is currently only implemented for macOS and returns a not necessarily user-readable
-  # string such as "NSAppearanceNameAqua" there and an empty string under all the other platforms.
-  # @return [String]
-  def get_appearance_name; end
-  alias :appearance_name :get_appearance_name
-
-  # Return true if the current system there is explicitly recognized as being a dark theme or if
-  # the default window background is dark.
-  #
-  # This method should be used to check whether custom colours more appropriate for the default (light)
-  # or dark appearance should be used.
-  # return [true,false]
-  def is_appearance_dark; end
-  alias :appearance_dark? :is_appearance_dark
-
-  # Return true if the default window background is significantly darker than foreground.
-  #
-  # This is used by #is_appearance_dark if there is no platform-specific way to determine whether a dark
-  # mode is being used and is generally not very useful to call directly.
-  # return [true,false]
-  def is_appearance_using_dark_background; end
-  alias :appearance_using_dark_background? :is_appearance_using_dark_background
+module Wx
+
+  class SystemSettings
+
+    # Return the name of the current system appearance if available or empty string otherwise.
+    #
+    # This is currently only implemented for macOS and returns a not necessarily user-readable
+    # string such as "NSAppearanceNameAqua" there and an empty string under all the other platforms.
+    # @return [String]
+    def get_appearance_name; end
+    alias :appearance_name :get_appearance_name
+
+    # Return true if the current system there is explicitly recognized as being a dark theme or if
+    # the default window background is dark.
+    #
+    # This method should be used to check whether custom colours more appropriate for the default (light)
+    # or dark appearance should be used.
+    # return [true,false]
+    def is_appearance_dark; end
+    alias :appearance_dark? :is_appearance_dark
+
+    # Return true if the default window background is significantly darker than foreground.
+    #
+    # This is used by #is_appearance_dark if there is no platform-specific way to determine whether a dark
+    # mode is being used and is generally not very useful to call directly.
+    # return [true,false]
+    def is_appearance_using_dark_background; end
+    alias :appearance_using_dark_background? :is_appearance_using_dark_background
+
+  end
 
 end

data/lib/wx/doc/text_validator.rb

@@ -5,14 +5,28 @@
 # :startdoc:
 
 
-class Wx::TextValidator
-
-  # @overload initialize(validator)
-  #   Copy constructor.
-  #   @param [Wx::TextValidator] validator validator to copy
-  # @overload initialize(style=Wx::FILTER_NONE)
-  #   Constructor taking a style.
-  #   @param [Integer] style One or more of the {Wx::TextValidatorStyle} styles. See #set_style.
-  def initialize(*args) end
+module Wx
+
+  class TextValidator
+
+    # @overload initialize(validator)
+    #   Copy constructor.
+    #   @param [Wx::TextValidator] validator validator to copy
+    # @overload initialize(style=Wx::FILTER_NONE)
+    #   Constructor taking a style.
+    #   @param [Integer] style One or more of the {Wx::TextValidatorStyle} styles. See #set_style.
+    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
 
 end

data/lib/wx/doc/textctrl.rb

@@ -23,6 +23,7 @@ module Wx
   #   ````
   #
   # This class is only available if `Wx.has_feature?(:USE_SPELLCHECK)` returns true.
+  # @wxrb_require USE_SPELLCHECK
   class TextProofOptions
     def initialize(schk=false, gchk=false, lang='')end
 
@@ -59,6 +60,18 @@ module Wx
 
   class TextCtrl
 
+    # Appends the string representation of `obj` to the text value of the control.
+    # Calls #to_s to get the string representation of `obj`.
+    # @param [Object] obj
+    # @return [self]
+    def <<(obj) end
+
+    # Yield each line to the given block.
+    # Returns an Enumerator if no block given.
+    # @yieldparam [String] line the line yielded
+    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    def each_line; end
+
     # @overload enable_proof_check(text_proof_options = Wx::TextProofOptions.default)
     #   Enable or disable native spell checking on this text control if it is available on the current platform.
     #   Currently this is supported in WXMSW (when running under Windows 8 or later), WXGTK when using GTK 3 and wxOSX.
@@ -67,6 +80,7 @@ module Wx
     #   When using WXGTK, this method only works if gspell library was available during the wxWidgets library build.
     #   @param [Wx::TextProofOptions] text_proof_options A Wx::TextProofOptions object specifying the desired behaviour of the proof checker (e.g. language to use, spell check, grammar check, etc.) and whether the proof checks should be enabled at all. By default, spelling checks for the current language are enabled. Passing Wx::TextProofOptions.disable disables all the checks.
     #   @return [Boolean] true if proof checking has been successfully enabled or disabled, false otherwise (usually because the corresponding functionality is not available under the current platform or for this type of text control).
+    #   @wxrb_require USE_SPELLCHECK
     # @overload enable_proof_check(spell_checking, grammar_checking, language)
     #   Enable or disable native spell checking on this text control if it is available on the current platform.
     #   Currently this is supported in WXMSW (when running under Windows 8 or later), WXGTK when using GTK 3 and wxOSX.
@@ -77,11 +91,13 @@ module Wx
     #   @param [Boolean] grammar_checking
     #   @param [String] language
     #   @return [Boolean] true if proof checking has been successfully enabled or disabled, false otherwise (usually because the corresponding functionality is not available under the current platform or for this type of text control).
+    #   @wxrb_require USE_SPELLCHECK
     def enable_proof_check(*opts) end
 
     # Returns the current text proofing options.
     # Only available if `Wx.has_feature?(:USE_SPELLCHECK)` returns true.
     # @return [Wx::TextProofOptions]
+    # @wxrb_require USE_SPELLCHECK
     def get_proof_check_options; end
 
   end

data/lib/wx/doc/tree_ctrl.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
+
+  class TreeCtrl
+
+    # Yield each tree item id (recursively) to the given block.
+    # Starts at tree item specified or at root if none specified.
+    # Returns an Enumerator if no block given.
+    # @param [Wx::TreeItemId,nil] start_id
+    # @yieldparam [Wx::TreeItemId] child_id the child tree item id yielded
+    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    def traverse(start_id=nil) end
+    alias :each :traverse
+
+    # Returns the first child; call #get_next_child() for the next child.
+    # For this enumeration method a 'cookie' is returned which is opaque for the application but is necessary
+    # for the library to make these methods reentrant (i.e. allow more than one enumeration on one and the
+    # same object simultaneously). The cookie returned from (and passed to) #get_first_child() and #get_next_child()
+    # should be the same variable.
+    #
+    # Returns an invalid tree item (i.e. Wx::TreeItemId#ok? returns false) if there are no further children.
+    # @param [Wx::TreeItemId] parent_id the id of the parent tree item for which to iterate children
+    # @return [Array(Wx::TreeItemId, Object)] first child item id (if any) and cookie value
+    def get_first_child(parent_id) end
+
+    # Returns the next child; call #get_first_child() for the first child.
+    # For this enumeration function you must pass in a 'cookie' parameter which is opaque for the application
+    # but is necessary for the library to make these functions reentrant (i.e. allow more than one enumeration
+    # on one and the same object simultaneously). The cookie returned from (and passed to) #get_first_child()
+    # and #get_next_child() should be the same variable.
+    #
+    # Returns an invalid tree item if there are no further children.
+    # @param [Wx::TreeItemId] parent_id the id of the parent tree item for which to iterate children
+    # @param [Object] cookie cookie value as returned from previous #get_first_cild or #get_next_child call.
+    # @return [Array(Wx::TreeItemId, Object)] first child item id (if any) and cookie value
+    def get_next_child(parent_id, cookie) end
+
+    # Iterate all child items of the given parent and yield it's id to the given block.
+    # Returns an Enumerator if no block given.
+    # @param [Wx::TreeItemId] parent_id
+    # @yieldparam [Wx::TreeItemId] child_id the child tree item id yielded
+    # @return [Object,Enumerator] last result of block or Enumerator if no block given.
+    def each_item_child(parent_id) end
+
+    # Returns an array of tree item ids of the child items of the given parent.
+    # @param [Wx::TreeItemId] parent_id
+    # @return [Array<Wx::TreeItemId>]
+    def get_item_children(parent_id) end
+    alias :item_children :get_item_children
+
+    # Returns an array of tree item ids of the current child items of the root.
+    # Mainly useful for tree control using TR_HIDE_ROOT style where there are
+    # multiple root-like items.
+    # @return [Array<Wx::TreeItemId>]
+    def get_root_items; end
+
+    # Returns an array of tree item ids of the currently selected items.
+    # This function can be called only if the control has the wxTR_MULTIPLE style.
+    # @return [Array<Wx::TreeItemId>]
+    def get_selections; end
+
+    # Inserts an item before one identified by its position (pos).
+    # pos must be less than or equal to the number of children.
+    # The image and selImage parameters are an index within the normal image list specifying
+    # the image to use for unselected and selected items, respectively. If image > -1 and
+    # selImage is -1, the same image is used for both selected and unselected items.
+    # @param [Wx::TreeItemId] parent parent tree item id to insert child item for
+    # @param [Integer] pos child item's position to insert before
+    # @param [Integer] image image index for unselected item
+    # @param [Integer] selImage image index for selected item
+    # @param data [Object]
+    # @return [Wx::TreeItemId] id of inserted tree item
+    def insert_item_before(parent, pos, text, image=-1, selImage=-1, data=nil) end
+
+    # Starts editing the label of the given item.
+    # This function generates a EVT_TREE_BEGIN_LABEL_EDIT event which can be vetoed to prevent the editing from starting.
+    # If it does start, a text control, which can be retrieved using GetEditControl(), allowing the user to edit the
+    # label interactively is shown.
+    # When the editing ends, EVT_TREE_END_LABEL_EDIT event is sent and this event can be vetoed as well to prevent the
+    # label from changing. Note that this event is sent both when the user accepts (e.g. by pressing Enter) or cancels
+    # (e.g. by pressing Escape) and its handler can use wxTreeEvent::IsEditCancelled() to distinguish between these
+    # situations.
+    # @param [Wx::TreeItemId] item_id
+    # @return [void]
+    def edit_label(item_id) end
+
+  end
+
+end

data/lib/wx/doc/treebook.rb

@@ -5,11 +5,15 @@
 # :startdoc:
 
 
-class Wx::Treebook
+module Wx
 
-  # Returns the Wx::TreeCtrl used for this Treebook
-  # @return [Wx::TreeCtrl] the tree control
-  def get_tree_ctrl; end
-  alias :tree_ctrl :get_tree_ctrl
+  class Treebook
+
+    # Returns the Wx::TreeCtrl used for this Treebook
+    # @return [Wx::TreeCtrl] the tree control
+    def get_tree_ctrl; end
+    alias :tree_ctrl :get_tree_ctrl
+
+  end
 
 end

data/lib/wx/doc/v_list_box.rb

@@ -5,11 +5,15 @@
 # :startdoc:
 
 
-class Wx::VListBox
+module Wx
 
-  # Iterate selected items. Returns Enumerator if no block given.
-  # @yieldparam [Integer] sel selected item index
-  # @return [Enumerator,Object] if block given returns last return value of block, Enumerator otherwise
-  def each_selected; end
+  class VListBox
+
+    # Iterate selected items. Returns Enumerator if no block given.
+    # @yieldparam [Integer] sel selected item index
+    # @return [Enumerator,Object] if block given returns last return value of block, Enumerator otherwise
+    def each_selected; end
+
+  end
 
 end

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