wxruby3 0.9.2 → 0.9.4

data/lib/wx/doc/num_validator.rb

@@ -0,0 +1,387 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  # Validator for text entries used for integer entry.
+  #
+  # This validator can be used with Wx::TextCtrl or Wx::ComboBox (and potentially
+  # any other class implementing Wx::TextEntry interface) to check that only
+  # valid integer values can be entered into them.
+  #
+  # By default this validator accepts any signed integer values in the 64 bit range.
+  # This range can be restricted further by calling #set_min and #set_max or #set_range
+  # methods inherited from the base class.
+  #
+  # When the validator displays integers with thousands separators, the
+  # character used for the separators (usually "." or ",") depends on the locale
+  # set with Wx::Locale (note that you shouldn't change locale with `setlocale()`
+  # as this can result in a mismatch between the thousands separator used by
+  # Wx::Locale and the one used by the run-time library).
+  #
+  # @example A simple example of using this class:
+  #   class MyDialog < Wx::Dialog
+  #
+  #     def initialize
+  #       super(...)
+  #       ...
+  #       # Allow integers and display them with thousands
+  #       # separators.
+  #       @value = 0
+  #       val = Wx::IntegerValidator.new(Wx::NUM_VAL_THOUSANDS_SEPARATOR)
+  #       val.on_transfer_to_window { @value }
+  #       val.on_transfer_from_window { |val| @value = val }
+  #
+  #       # If the would like to accept only positive integers we could
+  #       # call val.set_min(0) or alternatively use {Wx::UnsignedValidator}.
+  #
+  #       # Associate it with the text control:
+  #       Wx::TextCtrl.new(self, ..., val)
+  #     end
+  #
+  #   end
+  #
+  # @see Wx::Validator
+  # @see Wx::GenericValidator
+  # @see Wx::TextValidator
+  # @see Wx::UnsignedValidator
+  # @see Wx::FloatValidator
+  # @wxrb_require USE_VALIDATORS
+  class IntegerValidator < Validator
+
+    # @overload initialize(style=Wx::NumValidatorStyle::NUM_VAL_DEFAULT)
+    #   Constructor.
+    #   @param [Wx::NumValidatorStyle] style A combination of Wx::NumValidatorStyle enum values with the exception of Wx::NUM_VAL_NO_TRAILING_ZEROES which can't be used here.
+    #   @return [Wx::IntegerValidator]
+    # @overload initialize(min, max, style=Wx::NumValidatorStyle::NUM_VAL_DEFAULT)
+    #   Constructor with specified range.
+    #   @param [Integer] min The minimum value accepted by the validator.
+    #   @param [Integer] max The maximum value accepted by the validator.
+    #   @param [Wx::NumValidatorStyle] style A combination of Wx::NumValidatorStyle enum values with the exception of Wx::NUM_VAL_NO_TRAILING_ZEROES which can't be used here.
+    #   @return [Wx::IntegerValidator]
+    # @overload initialize(other)
+    #   Copy constructor.
+    #   @param [Wx::IntegerValidator] other
+    #   @return [Wx::IntegerValidator]
+    def initialize(*arg) end
+
+    # Sets the minimal value accepted by the validator.
+    #
+    # This value is inclusive, i.e. the value equal to min is accepted.
+    # @param [Integer] min
+    def set_min(min) end
+    alias :min= :set_min
+
+    # Gets the minimal value accepted by the validator.
+    # @return [Integer]
+    def get_min; end
+    alias :min :get_min
+
+    # Sets the maximal value accepted by the validator.
+    #
+    # This value is inclusive, i.e. the value equal to max is accepted.
+    # @param [Integer] max
+    def set_max(max) end
+    alias :max= :set_max
+
+    # Gets the maximum value accepted by the validator.
+    # @return [Integer]
+    def get_max; end
+    alias :max :get_max
+
+    # Sets both minimal and maximal values accepted by the validator.
+    #
+    # Calling this is equivalent to calling both #set_min and #set_max.
+    # @param [Integer] min
+    # @param [Integer] max
+    def set_range(min, max) end
+    alias :range= :set_range
+
+    # Gets both minimal and maximal values accepted by the validator.
+    #
+    # Returns an array with `[min, max]`
+    # @return [Array<Integer,Integer>]
+    def get_range; end
+    alias :range :get_range
+
+    # Change the validator style.
+    #
+    # Can be used to change the style of the validator after its creation.
+    # @param [Wx::NumValidatorStyle] style A combination of Wx::NumValidatorStyle enum values with the exception of Wx::NUM_VAL_NO_TRAILING_ZEROES which can't be used here.
+    def set_style(style) end
+    alias :style= :set_style
+
+    # Returns the value store attribute. Initially 0.
+    # @return [Integer]
+    def get_value; end
+    alias :value :get_value
+
+    # Sets the value store attribute.
+    # @param [Integer] val
+    def set_value(val) end
+    alias :value= :set_value
+
+  end
+
+  # Validator for text entries used for unsigned integer entry.
+  #
+  # This validator can be used with Wx::TextCtrl or Wx::ComboBox (and potentially
+  # any other class implementing Wx::TextEntry interface) to check that only
+  # valid integer values can be entered into them.
+  #
+  # By default this validator accepts any unsigned integer values in the 64 bit range.
+  # This range can be restricted further by calling #set_min and #set_max or #set_range
+  # methods inherited from the base class.
+  #
+  # When the validator displays integers with thousands separators, the
+  # character used for the separators (usually "." or ",") depends on the locale
+  # set with Wx::Locale (note that you shouldn't change locale with `setlocale()`
+  # as this can result in a mismatch between the thousands separator used by
+  # Wx::Locale and the one used by the run-time library).
+  #
+  # @example A simple example of using this class:
+  #   class MyDialog < Wx::Dialog
+  #
+  #     def initialize
+  #       super(...)
+  #       ...
+  #       # Allow unsigned integers and display them with thousands
+  #       # separators.
+  #       @value = 0
+  #       val = Wx::UnsignedValidator.new(Wx::NUM_VAL_THOUSANDS_SEPARATOR)
+  #       val.on_transfer_to_window { @value }
+  #       val.on_transfer_from_window { |val| @value = val }
+  #
+  #       # Associate it with the text control:
+  #       Wx::TextCtrl.new(self, ..., val)
+  #     end
+  #
+  #   end
+  #
+  # @see Wx::Validator
+  # @see Wx::GenericValidator
+  # @see Wx::TextValidator
+  # @see Wx::IntegerValidator
+  # @see Wx::FloatValidator
+  # @wxrb_require USE_VALIDATORS
+  class UnsignedValidator < Validator
+
+    # @overload initialize(style=Wx::NumValidatorStyle::NUM_VAL_DEFAULT)
+    #   Constructor.
+    #   @param [Wx::NumValidatorStyle] style A combination of Wx::NumValidatorStyle enum values with the exception of Wx::NUM_VAL_NO_TRAILING_ZEROES which can't be used here.
+    #   @return [Wx::UnsignedValidator]
+    # @overload initialize(min, max, style=Wx::NumValidatorStyle::NUM_VAL_DEFAULT)
+    #   Constructor with specified range.
+    #   @param [Integer] min The minimum value accepted by the validator.
+    #   @param [Integer] max The maximum value accepted by the validator.
+    #   @param [Wx::NumValidatorStyle] style A combination of Wx::NumValidatorStyle enum values with the exception of Wx::NUM_VAL_NO_TRAILING_ZEROES which can't be used here.
+    #   @return [Wx::UnsignedValidator]
+    # @overload initialize(other)
+    #   Copy constructor.
+    #   @param [Wx::UnsignedValidator] other
+    #   @return [Wx::UnsignedValidator]
+    def initialize(*arg) end
+
+    # Sets the minimal value accepted by the validator.
+    #
+    # This value is inclusive, i.e. the value equal to min is accepted.
+    # @param [Integer] min
+    def set_min(min) end
+    alias :min= :set_min
+
+    # Gets the minimal value accepted by the validator.
+    # @return [Integer]
+    def get_min; end
+    alias :min :get_min
+
+    # Sets the maximal value accepted by the validator.
+    #
+    # This value is inclusive, i.e. the value equal to max is accepted.
+    # @param [Integer] max
+    def set_max(max) end
+    alias :max= :set_max
+
+    # Gets the maximum value accepted by the validator.
+    # @return [Integer]
+    def get_max; end
+    alias :max :get_max
+
+    # Sets both minimal and maximal values accepted by the validator.
+    #
+    # Calling this is equivalent to calling both #set_min and #set_max.
+    # @param [Integer] min
+    # @param [Integer] max
+    def set_range(min, max) end
+    alias :range= :set_range
+
+    # Gets both minimal and maximal values accepted by the validator.
+    #
+    # Returns an array with `[min, max]`
+    # @return [Array<Integer,Integer>]
+    def get_range; end
+    alias :range :get_range
+
+    # Change the validator style.
+    #
+    # Can be used to change the style of the validator after its creation.
+    # @param [Wx::NumValidatorStyle] style A combination of Wx::NumValidatorStyle enum values with the exception of Wx::NUM_VAL_NO_TRAILING_ZEROES which can't be used here.
+    def set_style(style) end
+    alias :style= :set_style
+
+    # Returns the value store attribute. Initially 0.
+    # @return [Integer]
+    def get_value; end
+    alias :value :get_value
+
+    # Sets the value store attribute.
+    # @param [Integer] val
+    def set_value(val) end
+    alias :value= :set_value
+
+  end
+
+  # Validator for text entries used for floating point numbers entry.
+  #
+  # This validator can be used with Wx::TextCtrl or Wx::ComboBox (and potentially
+  # any other class implementing Wx::TextEntry interface) to check that only
+  # valid floating point values can be entered into them. Currently only fixed
+  # format is supported on input, i.e. scientific format with mantissa and
+  # exponent is not supported.
+  #
+  # Similarly to Wx::IntegerValidator, the range for the accepted values is by
+  # default set appropriately for the type (`double`). Additionally, this validator allows
+  # to specify the maximum number of digits that can be entered after the
+  # decimal separator. By default this is also set appropriately for the type
+  # used, e.g. 15 for `double` on a typical IEEE-754-based
+  # implementation. As with the range, the precision can be restricted after
+  # the validator creation if necessary.
+  #
+  # When the validator displays numbers with decimal or thousands separators,
+  # the characters used for the separators (usually "." or ",") depend on the
+  # locale set with Wx::Locale (note that you shouldn't change locale with
+  # `setlocale()` as this can result in a mismatch between the separators used by
+  # Wx::Locale and the one used by the run-time library).
+  #
+  # @example A simple example of using this class:
+  #   class MyDialog < Wx::Dialog
+  #     def initialize
+  #       super(..)
+  #       ...
+  #       # Allow floating point numbers from 0 to 100 with 2 decimal
+  #       # digits only and handle empty string as 0 by default.
+  #       val = Wx::FloatValidator.new(2, Wx::NUM_VAL_ZERO_AS_BLANK)
+  #       val.set_range(0, 100)
+  #
+  #       # Associate it with the text control:
+  #       Wx::TextCtrl.new(this, ..., val)
+  #     end
+  #
+  #   end
+  #
+  # @see Wx::Validator
+  # @see Wx::GenericValidator
+  # @see Wx::TextValidator
+  # @see Wx::IntegerValidator
+  # @see Wx::UnsignedValidator
+  # @wxrb_require USE_VALIDATORS
+  class FloatValidator < Validator
+
+    # @overload initialize(style=Wx::NumValidatorStyle::NUM_VAL_DEFAULT)
+    #   Constructor.
+    #   @param [Wx::NumValidatorStyle] style A combination of Wx::NumValidatorStyle enum values.
+    #   @return [Wx::FloatValidator]
+    # @overload initialize(precision, style)
+    #   Constructor for validator specifying the precision.
+    #   @param [Integer] precision The number of decimal digits after the decimal separator to show and accept.
+    #   @param [Wx::NumValidatorStyle] style A combination of Wx::NumValidatorStyle enum values.
+    #   @return [Wx::FloatValidator]
+    # @overload initialize(other)
+    #   Copy constructor.
+    #   @param [Wx::FloatValidator] other
+    #   @return [Wx::FloatValidator]
+    def initialize(*arg) end
+
+    # Sets the minimal value accepted by the validator.
+    #
+    # This value is inclusive, i.e. the value equal to min is accepted.
+    # @param [Float] min
+    def set_min(min) end
+    alias :min= :set_min
+
+    # Gets the minimal value accepted by the validator.
+    # @return [Float]
+    def get_min; end
+    alias :min :get_min
+
+    # Sets the maximal value accepted by the validator.
+    #
+    # This value is inclusive, i.e. the value equal to max is accepted.
+    # @param [Float] max
+    def set_max(max) end
+    alias :max= :set_max
+
+    # Gets the maximum value accepted by the validator.
+    # @return [Float]
+    def get_max; end
+    alias :max :get_max
+
+    # Sets both minimal and maximal values accepted by the validator.
+    #
+    # Calling this is equivalent to calling both #set_min and #set_max.
+    # @param [Float] min
+    # @param [Float] max
+    def set_range(min, max) end
+    alias :range= :set_range
+
+    # Gets both minimal and maximal values accepted by the validator.
+    #
+    # Returns an array with `[min, max]`
+    # @return [Array<Float,Float>]
+    def get_range; end
+    alias :range :get_range
+
+    # Change the validator style.
+    #
+    # Can be used to change the style of the validator after its creation.
+    # @param [Wx::NumValidatorStyle] style A combination of Wx::NumValidatorStyle enum values.
+    def set_style(style) end
+    alias :style= :set_style
+
+    # Set precision.
+    #
+    # Precision is the number of digits shown (and accepted on input)
+    # after the decimal point. By default this is set to the maximal
+    # precision supported by the type handled by the validator in its
+    # constructor.
+    # @param [Integer] precision
+    def set_precision(precision) end
+    alias :precision= :set_precision
+
+    # Set factor used for displaying the value.
+    #
+    # The value associated with the validator is multiplied by the factor
+    # before displaying it and divided by it when retrieving its value from
+    # the control. By default, the factor is 1, so the actual value is not
+    # affected by it, but it can be set to, for example, 100, to display the
+    # value in percents while still storing it as absolute value.
+    # @param [Float] factor
+    def set_factor(factor) end
+    alias :factor= :set_factor
+
+    # Returns the value store attribute. Initially 0.
+    # @return [Float]
+    def get_value; end
+    alias :value :get_value
+
+    # Sets the value store attribute.
+    # @param [Float] val
+    def set_value(val) end
+    alias :value= :set_value
+
+  end
+
+end

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/persistence_manager.rb

@@ -0,0 +1,36 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  # Function used to create the correct persistent adapter for the given object.
+  #
+  # This is a compatibility function that simply redirects the call to the object itself. Any object class
+  # supporting persistence should implement the #create_persistent_object method to return a Wx::PersistentObject
+  # instance for the object it is called for.
+  # This method raises a NoImplementError if the object class does not support persistence.
+  # @see Defining Custom Persistent Windows
+  # @param obj [Object]
+  # @return [Wx::PersistentObject]
+  def self.create_persistent_object(obj) end
+
+  # A shorter synonym for {Wx::PersistenceManager#register_and_restore}.
+  #
+  # This function simply calls {Wx::PersistenceManager#register_and_restore} but using it results in slightly shorter
+  # code as it calls {Wx::PersistenceManager.get} internally. As an additional convenience, this function can also set the window name.
+  #
+  # Returns true if the settings were restored or false otherwise (this will always be the case when the program runs
+  # for the first time, for example).
+  # @param obj [Wx::Window]  window to register with persistence manager and to try to restore the settings for.
+  # @param name [String]  If specified non-empty, window name is changed to the provided value before registering it.
+  # @return [Boolean]
+  def self.persistent_register_and_restore(obj, name=nil) end
+
+  # class alias
+  PersistentWindow = PersistentWindowBase
+
+end

data/lib/wx/doc/persistent_object.rb

@@ -0,0 +1,27 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class PersistentObject < ::Object
+
+    # Save the specified value using the given name.
+    # @param [String] name The name of the value in the configuration file.
+    # @param [Object] value The value to save, currently must be a type supported by wxConfig.
+    # @return [Boolean] true if the value was saved or false if an error occurred.
+    def save_value(name, value); end
+    protected :save_value
+
+    # Restore a value saved by {#save_value}.
+    # @param [String] name The name of the value in the configuration file.
+    # @return [Object,nil] The value if successfully read, nil otherwise
+    def restore_value(name); end
+    protected :restore_value
+
+  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/static_bitmap.rb

@@ -0,0 +1,25 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  # A generic (non-native) static bitmap control to display bitmap.
+  #
+  # Unlike the native control implemented by {Wx::StaticBitmap}, which on some platforms is only meant for display of
+  # the small icons in the dialog boxes, you may use this implementation to display larger images portably.
+  # Notice that for the best results, the size of the control should be the same as the size of the image displayed in
+  # it, as happens by default if it's not resized explicitly. Otherwise, behaviour depends on the platform: under MSW,
+  # the bitmap is drawn centred inside the control, while elsewhere it is drawn at the origin of the control. You can
+  # use {Wx::GenericStaticBitmap#set_scale_mode} to control how the image is scaled inside the control.
+  #
+  # @see Wx::Bitmap
+  # @see Wx::StaticBitmap
+  class GenericStaticBitmap < Control
+
+  end
+
+end

data/lib/wx/doc/text_validator.rb

@@ -17,6 +17,16 @@ module Wx
     #   @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/top_level_window.rb

@@ -0,0 +1,19 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class TopLevelWindow < NonOwnedWindow
+
+    # Creates PersistentObject for this toplevel window instance (incl. Dialog and Frame).
+    # @see Wx.create_persistent_object
+    # @return [Wx::PersistentTLW]
+    def create_persistent_object; end
+
+  end
+
+end

data/lib/wx/doc/treebook.rb

@@ -7,13 +7,18 @@
 
 module Wx
 
-  class Treebook
+  class Treebook < BookCtrlBase
 
     # 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
 
+    # Creates PersistentObject for this treebook control instance.
+    # @see Wx.create_persistent_object
+    # @return [Wx::PersistentTreeBookCtrl]
+    def create_persistent_object; end
+
   end
 
 end