wxruby3 0.9.0.pre.rc.3-x64-mingw-ucrt → 0.9.1-x64-mingw-ucrt

data/lib/wx/doc/gen/choice.rb

@@ -35,7 +35,7 @@ module Wx
   class Choice < ControlWithItems
   
     # Creates the choice for two-step construction.
-    # See {Wx::Choice#choice}.
+    # See {Wx::Choice#initialize}.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
     # @param pos [Array(Integer, Integer), Wx::Point] 
@@ -44,8 +44,8 @@ module Wx
     # @param style [Integer] 
     # @param validator [Wx::Validator] 
     # @param name [String] 
-    # @return [true,false]
-    def create(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ChoiceNameStr) end
+    # @return [Boolean]
+    def create(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::CHOICE_NAME_STR) end
     
     # @overload initialize()
     #   Default constructor.
@@ -53,7 +53,7 @@ module Wx
     #   @see Wx::Choice#create
     #   @see  Wx::Validator 
     #   @return [Wx::Choice]
-    # @overload initialize(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ChoiceNameStr)
+    # @overload initialize(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::CHOICE_NAME_STR)
     #   Constructor, creating and showing a choice.
     #   
     #   @see Wx::Choice#create
@@ -115,7 +115,7 @@ module Wx
     # 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 [true,false]  Whether search is case sensitive (default is not).
+    # @param caseSensitive [Boolean]  Whether search is case sensitive (default is not).
     # @return [Integer]
     def find_string(string, caseSensitive=false) end
     

data/lib/wx/doc/gen/choicebook.rb

@@ -92,7 +92,7 @@ module Wx
     # @param size [Array(Integer, Integer), Wx::Size] 
     # @param style [Integer] 
     # @param name [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=('')) end
     
     # Returns the {Wx::Choice} associated with the control.

data/lib/wx/doc/gen/clipboard.rb

@@ -55,7 +55,7 @@ module Wx
     # Call this function to add the data object to the clipboard.
     # This is an obsolete synonym for {Wx::Clipboard#set_data}.
     # @param data [Wx::DataObject] 
-    # @return [true,false]
+    # @return [Boolean]
     def add_data(data) end
     
     # Clears the global clipboard object and the system's clipboard if possible.
@@ -71,53 +71,53 @@ module Wx
     # On GTK, only the non-primary selection can be flushed. Calling this function when the clipboard is using the primary selection will return false and not make any data available after the program exits.
     # 
     # false if the operation is unsuccessful for any reason.
-    # @return [true,false]
+    # @return [Boolean]
     def flush; end
     
     # Call this function to fill data with data on the clipboard, if available in the required format.
     # Returns true on success.
     # @param data [Wx::DataObject] 
-    # @return [true,false]
+    # @return [Boolean]
     def get_data(data) end
     alias_method :data, :get_data
     
     # Returns true if the clipboard has been opened.
-    # @return [true,false]
+    # @return [Boolean]
     def is_opened; end
     alias_method :opened?, :is_opened
     
     # Returns true if there is data which matches the data format of the given data object currently <b>available</b> on the clipboard.
     # TodoThe name of this function is misleading. This should be renamed to something that more accurately indicates what it does.
     # @param format [Wx::DataFormat] 
-    # @return [true,false]
+    # @return [Boolean]
     def is_supported(format) end
     alias_method :supported?, :is_supported
     
     # Returns true if we are using the primary selection, false if clipboard one.
     # 
     # @see Wx::Clipboard#use_primary_selection 
-    # @return [true,false]
+    # @return [Boolean]
     def is_using_primary_selection; end
     alias_method :using_primary_selection?, :is_using_primary_selection
     
     # Call this function to open the clipboard before calling {Wx::Clipboard#set_data} and {Wx::Clipboard#get_data}.
     # Call {Wx::Clipboard#close} when you have finished with the clipboard. You should keep the clipboard open for only a very short time.
     # true on success. This should be tested (as in the sample shown above).
-    # @return [true,false]
+    # @return [Boolean]
     def open; end
     
     # Call this function to set the data object to the clipboard.
     # The new data object replaces any previously set one, so if the application wants to provide clipboard data in several different formats, it must use a composite data object supporting all of the formats instead of calling this function several times with different data objects as this would only leave data from the last one in the clipboard.
     # After this function has been called, the clipboard owns the data, so do not delete the data explicitly.
     # @param data [Wx::DataObject] 
-    # @return [true,false]
+    # @return [Boolean]
     def set_data(data) end
     alias_method :data=, :set_data
     
     # On platforms supporting it (all X11-based ports), {Wx::Clipboard} uses the CLIPBOARD X11 selection by default.
     # When this function is called with true, all subsequent clipboard operations will use PRIMARY selection until this function is called again with false.
     # On the other platforms, there is no PRIMARY selection and so all clipboard operations will fail. This allows implementing the standard X11 handling of the clipboard which consists in copying data to the CLIPBOARD selection only when the user explicitly requests it (i.e. by selecting the "Copy" menu command) but putting the currently selected text into the PRIMARY selection automatically, without overwriting the normal clipboard contents with the currently selected text on the other platforms.
-    # @param primary [true,false] 
+    # @param primary [Boolean] 
     # @return [void]
     def use_primary_selection(primary=false) end
     

data/lib/wx/doc/gen/collapsible_pane.rb

@@ -68,7 +68,7 @@ module Wx
     # @overload initialize()
     #   Default constructor.
     #   @return [Wx::CollapsiblePane]
-    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::CollapsiblePaneNameStr)
+    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COLLAPSIBLE_PANE_NAME_STR)
     #   Initializes the object and calls {Wx::CollapsiblePane#create} with all the parameters.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -91,11 +91,11 @@ module Wx
     # @param style [Integer]  The window style, see {Wx::CP_}* flags.
     # @param validator [Wx::Validator]  Validator which can be used for additional data checks.
     # @param name [String]  Control name.
-    # @return [true,false]
-    def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::CollapsiblePaneNameStr) end
+    # @return [Boolean]
+    def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COLLAPSIBLE_PANE_NAME_STR) end
     
     # Collapses or expands the pane window.
-    # @param collapse [true,false] 
+    # @param collapse [Boolean] 
     # @return [void]
     def collapse(collapse=true) end
     
@@ -110,12 +110,12 @@ module Wx
     alias_method :pane, :get_pane
     
     # Returns true if the pane window is currently hidden.
-    # @return [true,false]
+    # @return [Boolean]
     def is_collapsed; end
     alias_method :collapsed?, :is_collapsed
     
     # Returns true if the pane window is currently shown.
-    # @return [true,false]
+    # @return [Boolean]
     def is_expanded; end
     alias_method :expanded?, :is_expanded
     

data/lib/wx/doc/gen/collapsible_pane_event.rb

@@ -25,17 +25,17 @@ module Wx
     # The constructor is not normally used by the user code.
     # @param generator [Wx::Object] 
     # @param id [Integer] 
-    # @param collapsed [true,false] 
+    # @param collapsed [Boolean] 
     # @return [Wx::CollapsiblePaneEvent]
     def initialize(generator, id, collapsed) end
     
     # Returns true if the pane has been collapsed.
-    # @return [true,false]
+    # @return [Boolean]
     def get_collapsed; end
     alias_method :collapsed, :get_collapsed
     
     # Sets this as a collapsed pane event (if collapsed is true) or as an expanded pane event (if collapsed is false).
-    # @param collapsed [true,false] 
+    # @param collapsed [Boolean] 
     # @return [void]
     def set_collapsed(collapsed) end
     alias_method :collapsed=, :set_collapsed

data/lib/wx/doc/gen/colour.rb

@@ -35,7 +35,7 @@ module Wx
   # @see wxToString(const wxColour&)
   # @param string [String] 
   # @param colour [Wx::Colour] 
-  # @return [true,false]
+  # @return [Boolean]
   def self.from_string(string, colour) end
   
   # Converts the given {Wx::Colour} into a string.
@@ -134,7 +134,7 @@ module Wx
     #   When using third form, {Wx::Colour#set} accepts: colour names (those listed in {Wx::ColourDatabase}), the CSS-like <code>"rgb(r,g,b)"</code> or <code>"rgba(r,g,b,a)"</code> syntax (case insensitive) and the HTML-like syntax: <code>"#"</code> followed by 6 hexadecimal digits for red, green, blue components.
     #   Returns true if the conversion was successful, false otherwise.
     #   @param str [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def set(*args) end
     
     # @overload initialize()
@@ -212,7 +212,7 @@ module Wx
     def green; end
     
     # Returns true if the colour object is valid (the colour has been initialised with RGB values).
-    # @return [true,false]
+    # @return [Boolean]
     def is_ok; end
     alias_method :ok?, :is_ok
     
@@ -224,13 +224,13 @@ module Wx
     
     # Returns true if the color can be described using RGB values, i.e.
     # is solid, false if it is a pattern (currently only possible on macOS)
-    # @return [true,false]
+    # @return [Boolean]
     def is_solid; end
     alias_method :solid?, :is_solid
     
     # Tests the equality of two colours by comparing individual red, green, blue intensities and alpha values.
     # @param colour [Wx::Colour,String,Symbol] 
-    # @return [true,false]
+    # @return [Boolean]
     def ==(colour) end
     
     # Make a disabled version of this colour.
@@ -240,11 +240,11 @@ module Wx
     def make_disabled(brightness=255) end
     
     # Create a disabled (dimmed) colour from (in/out) rgb parameters.
-    # @param r [unsigned char] 
-    # @param g [unsigned char] 
-    # @param b [unsigned char] 
+    # @param r [Integer] 
+    # @param g [Integer] 
+    # @param b [Integer] 
     # @param brightness [Integer] 
-    # @return [void]
+    # @return [Array(Integer,Integer,Integer)]
     def self.make_disabled(r, g, b, brightness=255) end
     
     # {Wx::Colour} wrapper for ChangeLightness(r,g,b,ialpha).
@@ -254,37 +254,37 @@ module Wx
     
     # Utility function that simply darkens or lightens a color, based on the specified percentage ialpha.
     # ialpha of 0 would be make the color completely black, 200 completely white and 100 would not change the color.
-    # @param r [unsigned char] 
-    # @param g [unsigned char] 
-    # @param b [unsigned char] 
+    # @param r [Integer] 
+    # @param g [Integer] 
+    # @param b [Integer] 
     # @param ialpha [Integer] 
-    # @return [void]
+    # @return [Array(Integer,Integer,Integer)]
     def self.change_lightness(r, g, b, ialpha) end
     
     # Assigns the same value to r, g, b: 0 if on is false, 255 otherwise.
-    # @param r [unsigned char] 
-    # @param g [unsigned char] 
-    # @param b [unsigned char] 
-    # @param on [true,false] 
-    # @return [void]
+    # @param r [Integer] 
+    # @param g [Integer] 
+    # @param b [Integer] 
+    # @param on [Boolean] 
+    # @return [Array(Integer,Integer,Integer)]
     def self.create_mono(r, g, b, on) end
     
     # @overload self.create_grey(r, g, b)
     #   Create a grey colour from (in/out) rgb parameters using integer arithmetic.
-    #   @param r [unsigned char] 
-    #   @param g [unsigned char] 
-    #   @param b [unsigned char] 
-    #   @return [void]
+    #   @param r [Integer] 
+    #   @param g [Integer] 
+    #   @param b [Integer] 
+    #   @return [Array(Integer,Integer,Integer)]
     # @overload self.create_grey(r, g, b, weight_r, weight_g, weight_b)
     #   Create a grey colour from (in/out) rgb parameters using floating point arithmetic.
     #   Defaults to using the standard ITU-T BT.601 when converting to YUV, where every pixel equals (R * weight_r) + (G * weight_g) + (B * weight_b).
-    #   @param r [unsigned char] 
-    #   @param g [unsigned char] 
-    #   @param b [unsigned char] 
+    #   @param r [Integer] 
+    #   @param g [Integer] 
+    #   @param b [Integer] 
     #   @param weight_r [Float] 
     #   @param weight_g [Float] 
     #   @param weight_b [Float] 
-    #   @return [void]
+    #   @return [Array(Integer,Integer,Integer)]
     def self.create_grey(*args) end
     
     # Blend colour, taking alpha into account.

data/lib/wx/doc/gen/colour_dialog.rb

@@ -70,7 +70,7 @@ module Wx
     # Same as {colour_dialog}.
     # @param parent [Wx::Window] 
     # @param data [Wx::ColourData] 
-    # @return [true,false]
+    # @return [Boolean]
     def create(parent, data=nil) end
     
     # Shows the dialog, returning {Wx::StandardID::ID_OK} if the user pressed OK, and {Wx::StandardID::ID_CANCEL} otherwise.
@@ -104,14 +104,14 @@ module Wx
     # Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls.
     # Has no meaning under other platforms.
     # The default value is true.
-    # @return [true,false]
+    # @return [Boolean]
     def get_choose_full; end
     alias_method :choose_full, :get_choose_full
     
     # Indicates whether the colour dialog will display alpha values and an opacity selector.
     # It is meaningful under wxGTK, wxOSX and with regards to generic colour dialog.
     # The default value is false, except wxOSX where it is true (for the sake of backward compatibility).
-    # @return [true,false]
+    # @return [Boolean]
     def get_choose_alpha; end
     alias_method :choose_alpha, :get_choose_alpha
     
@@ -130,7 +130,7 @@ module Wx
     # Under Windows, tells the Windows colour dialog to display the full dialog with custom colour selection controls.
     # Under other platforms, has no effect.
     # The default value is true.
-    # @param flag [true,false] 
+    # @param flag [Boolean] 
     # @return [void]
     def set_choose_full(flag) end
     alias_method :choose_full=, :set_choose_full
@@ -138,7 +138,7 @@ module Wx
     # Tells the colour dialog to show alpha values and an opacity selector (slider).
     # Currently it has effect under wxGTK, wxOSX and for generic colour dialog.
     # The default value is false, except wxOSX where it is true for backward compatibility.
-    # @param flag [true,false] 
+    # @param flag [Boolean] 
     # @return [void]
     def set_choose_alpha(flag) end
     alias_method :choose_alpha=, :set_choose_alpha
@@ -162,7 +162,7 @@ module Wx
     
     # Decodes the given string, which should be in the same format returned by {Wx::ColourData#to_string}, and sets the internal colours.
     # @param str [String] 
-    # @return [true,false]
+    # @return [Boolean]
     def from_string(str) end
     
   end # ColourData

data/lib/wx/doc/gen/colour_picker_ctrl.rb

@@ -58,7 +58,7 @@ module Wx
     
     # @overload initialize()
     #   @return [Wx::ColourPickerCtrl]
-    # @overload initialize(parent, id, colour=Wx::BLACK, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CLRP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ColourPickerCtrlNameStr)
+    # @overload initialize(parent, id, colour=Wx::BLACK, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CLRP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COLOUR_PICKER_CTRL_NAME_STR)
     #   Initializes the object and calls {Wx::ColourPickerCtrl#create} with all the parameters.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -81,8 +81,8 @@ module Wx
     # @param style [Integer]  The window style, see {Wx::CRLP_}* flags.
     # @param validator [Wx::Validator]  Validator which can be used for additional data checks.
     # @param name [String]  Control name.
-    # @return [true,false]
-    def create(parent, id, colour=Wx::BLACK, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CLRP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ColourPickerCtrlNameStr) end
+    # @return [Boolean]
+    def create(parent, id, colour=Wx::BLACK, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CLRP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COLOUR_PICKER_CTRL_NAME_STR) end
     
     # Returns the currently selected colour.
     # @return [Wx::Colour]

data/lib/wx/doc/gen/combo_box.rb

@@ -56,9 +56,9 @@ module Wx
   
     include Wx::TextEntry
   
-    # @overload create(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=((const Wx::String *) nil), style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ComboBoxNameStr)
+    # @overload create(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=((CONST Wx::STRING *) nil), style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR)
     #   Creates the combobox for two-step construction.
-    #   Derived classes should call or replace this function. See {Wx::ComboBox#combo_box} for further details.
+    #   Derived classes should call or replace this function. See {Wx::ComboBox#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
     #   @param value [String] 
@@ -68,10 +68,10 @@ module Wx
     #   @param style [Integer] 
     #   @param validator [Wx::Validator] 
     #   @param name [String] 
-    #   @return [true,false]
-    # @overload create(parent, id, value, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ComboBoxNameStr)
+    #   @return [Boolean]
+    # @overload create(parent, id, value, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR)
     #   Creates the combobox for two-step construction.
-    #   Derived classes should call or replace this function. See {Wx::ComboBox#combo_box} for further details.
+    #   Derived classes should call or replace this function. See {Wx::ComboBox#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
     #   @param value [String] 
@@ -81,13 +81,13 @@ module Wx
     #   @param style [Integer] 
     #   @param validator [Wx::Validator] 
     #   @param name [String] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def create(*args) end
     
     # @overload initialize()
     #   Default constructor.
     #   @return [Wx::ComboBox]
-    # @overload initialize(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ComboBoxNameStr)
+    # @overload initialize(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR)
     #   Constructor, creating and showing a combobox.
     #   
     #   @see Wx::ComboBox#create
@@ -102,7 +102,7 @@ module Wx
     #   @param validator [Wx::Validator]  Window validator.
     #   @param name [String]  Window name.
     #   @return [Wx::ComboBox]
-    # @overload initialize(parent, id, value, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ComboBoxNameStr)
+    # @overload initialize(parent, id, value, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR)
     #   Constructor, creating and showing a combobox.
     #   
     #   @see Wx::ComboBox#create
@@ -133,13 +133,13 @@ module Wx
     
     # Returns true if the list of combobox choices is empty.
     # Use this method instead of (not available in this class) {Wx::ComboBox#is_empty} to test if the list of items is empty.
-    # @return [true,false]
+    # @return [Boolean]
     def is_list_empty; end
     alias_method :list_empty?, :is_list_empty
     
     # Returns true if the text of the combobox is empty.
     # Use this method instead of (not available in this class) {Wx::ComboBox#is_empty} to test if the text currently entered into the combobox is empty.
-    # @return [true,false]
+    # @return [Boolean]
     def is_text_empty; end
     alias_method :text_empty?, :is_text_empty
     
@@ -196,7 +196,7 @@ module Wx
     # 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 [true,false]  Whether search is case sensitive (default is not).
+    # @param caseSensitive [Boolean]  Whether search is case sensitive (default is not).
     # @return [Integer]
     def find_string(string, caseSensitive=false) end