wxruby3 0.9.2-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -31,6 +31,7 @@ module Wx
   NULL_COLOUR = nil
   
   # Converts string to a {Wx::Colour} best represented by the given string.
+  # 
   # Returns true on success.
   # @see wxToString(const wxColour&)
   # @param string [String] 
@@ -40,6 +41,7 @@ module Wx
   
   # Converts the given {Wx::Colour} into a string.
   # 
+  # 
   # @see wxFromString(const wxString&
   # @see  wxColour*)
   # @param colour [Wx::Colour,String,Symbol] 
@@ -47,6 +49,7 @@ module Wx
   def self.to_string(colour) end
   
   # A colour is an object representing a combination of Red, Green, and Blue (RGB) intensity values and an Alpha value, and is used to determine drawing colours.
+  # 
   # See the entry for {Wx::ColourDatabase} for how a pointer to a predefined, named colour may be returned instead of creating a new colour.
   # Valid RGB values are in the range 0 to 255.
   # You can retrieve the current system colour settings with {Wx::SystemSettings}.
@@ -80,6 +83,7 @@ module Wx
   class Colour < Object
   
     # Sets the RGB or RGBA colour values from a single 32 bit value.
+    # 
     # The arguments colRGB and colRGBA should be of the form 0x00BBGGRR and 0xAABBGGRR respectively where 0xRR, 0xGG, 0xBB and 0xAA are the values of the red, green, blue and alpha components.
     # Notice the right-to-left order of components!
     # @see Wx::Colour#get_rgb
@@ -90,6 +94,7 @@ module Wx
     alias_method :rgb=, :set_rgb
     
     # Sets the RGB or RGBA colour values from a single 32 bit value.
+    # 
     # The arguments colRGB and colRGBA should be of the form 0x00BBGGRR and 0xAABBGGRR respectively where 0xRR, 0xGG, 0xBB and 0xAA are the values of the red, green, blue and alpha components.
     # Notice the right-to-left order of components!
     # @see Wx::Colour#get_rgb
@@ -100,6 +105,7 @@ module Wx
     alias_method :rgba=, :set_rgba
     
     # Gets the RGB or RGBA colour values as a single 32 bit value.
+    # 
     # The returned value is of the same form as expected by {Wx::Colour#set_rgb} and {Wx::Colour#set_rgba}.
     # Notice that {Wx::Colour#get_rgb} returns the value with 0 as its highest byte independently of the value actually returned by {Wx::Colour#alpha}. So for a fully opaque colour, the return value of {Wx::Colour#get_rgba} is 0xFFBBGGRR while that of {Wx::Colour#get_rgb} is 0x00BBGGRR.
     # @return [Integer]
@@ -107,6 +113,7 @@ module Wx
     alias_method :rgb, :get_rgb
     
     # Gets the RGB or RGBA colour values as a single 32 bit value.
+    # 
     # The returned value is of the same form as expected by {Wx::Colour#set_rgb} and {Wx::Colour#set_rgba}.
     # Notice that {Wx::Colour#get_rgb} returns the value with 0 as its highest byte independently of the value actually returned by {Wx::Colour#alpha}. So for a fully opaque colour, the return value of {Wx::Colour#get_rgba} is 0xFFBBGGRR while that of {Wx::Colour#get_rgb} is 0x00BBGGRR.
     # @return [Integer]
@@ -115,6 +122,7 @@ module Wx
     
     # @overload set(red, green, blue, alpha=Wx::ALPHA_OPAQUE)
     #   Sets the RGB intensity values using the given values (first overload), extracting them from the packed long (second overload), using the given string (third overload).
+    #   
     #   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 red [Integer] 
@@ -124,12 +132,14 @@ module Wx
     #   @return [void]
     # @overload set(rGB)
     #   Sets the RGB intensity values using the given values (first overload), extracting them from the packed long (second overload), using the given string (third overload).
+    #   
     #   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 rGB [Integer] 
     #   @return [void]
     # @overload set(str)
     #   Sets the RGB intensity values using the given values (first overload), extracting them from the packed long (second overload), using the given string (third overload).
+    #   
     #   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] 
@@ -159,12 +169,14 @@ module Wx
     
     # Returns the alpha value, on platforms where alpha is not yet supported, this always returns {Wx::ALPHA_OPAQUE}.
     # 
+    # 
     # @see Wx::Colour#get_alpha 
     # @return [Integer]
     def alpha; end
     
     # Returns the blue intensity.
     # 
+    # 
     # @see Wx::Colour#get_blue 
     # @return [Integer]
     def blue; end
@@ -186,6 +198,7 @@ module Wx
     def get_red; end
     
     # Converts this colour to a {Wx::String} using the given flags.
+    # 
     # The supported flags are {Wx::C2S_NAME}, to obtain the colour name (e.g. {colour(255,0,0)} == "red"), {Wx::C2S_CSS_SYNTAX}, to obtain the colour in the "rgb(r,g,b)" or "rgba(r,g,b,a)" syntax (e.g. {colour(255,0,0,85)} == "rgba(255,0,0,0.333)"), and {Wx::C2S_HTML_SYNTAX}, to obtain the colour as "#" followed by 6 hexadecimal digits (e.g. {colour(255,0,0)} == "\#FF0000").
     # This function returns empty string if the colour is not initialized (see {Wx::Colour#is_ok}). Otherwise, the returned string is always non-empty, but the function asserts if the colour has alpha channel (i.e. is non opaque) but {Wx::C2S_CSS_SYNTAX} (which is the only one supporting alpha) is not specified in flags.
     # 
@@ -200,6 +213,7 @@ module Wx
     alias_method :as_string, :get_as_string
     
     # Return the perceived brightness of the colour.
+    # 
     # This value is computed using the simple 
     # ```
     #   0.299*R + 0.587*G + 0.114*B 
@@ -211,6 +225,7 @@ module Wx
     
     # Returns the green intensity.
     # 
+    # 
     # @see Wx::Colour#get_green 
     # @return [Integer]
     def green; end
@@ -222,11 +237,13 @@ module Wx
     
     # Returns the red intensity.
     # 
+    # 
     # @see Wx::Colour#get_red 
     # @return [Integer]
     def red; end
     
     # 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 [Boolean]
     def is_solid; end
@@ -238,6 +255,7 @@ module Wx
     def ==(colour) end
     
     # Make a disabled version of this colour.
+    # 
     # This method modifies the object in place and returns the object itself.
     # @param brightness [Integer] 
     # @return [Wx::Colour]
@@ -257,6 +275,7 @@ module Wx
     def change_lightness(ialpha) end
     
     # 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 [Integer] 
     # @param g [Integer] 
@@ -281,6 +300,7 @@ module Wx
     #   @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 [Integer] 
     #   @param g [Integer] 

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

@@ -19,6 +19,7 @@ module Wx
   def self.get_colour_from_user(parent, colInit, caption=(''), data=nil) end
   
   # This class represents the colour chooser dialog.
+  # 
   # Starting from wxWidgets 3.1.3 and currently in the MSW port only, this dialog generates {Wx::EVT_COLOUR_CHANGED} events while it is being shown, i.e. from inside its {Wx::ColourDialog#show_modal} method, that notify the program about the change of the currently selected colour and allow it to e.g. preview the effect of selecting this colour. Note that if you react to this event, you should also correctly revert to the previously selected colour if the dialog is cancelled by the user.
   # Example of using this class with dynamic feedback for the selected colour: 
   # ```ruby
@@ -58,6 +59,7 @@ module Wx
   class ColourDialog < Dialog
   
     # Constructor.
+    # 
     # Pass a parent window, and optionally a pointer to a block of colour data, which will be copied to the colour dialog's colour data.
     # Custom colours from colour data object will be used in the dialog's colour palette. Invalid entries in custom colours list will be ignored on some platforms(GTK) or replaced with white colour on platforms where custom colours palette has fixed size (MSW).
     # @see Wx::ColourData 
@@ -79,6 +81,7 @@ module Wx
   end # ColourDialog
   
   # This class holds a variety of information related to colour dialogs.
+  # 
   # Category:  Common Dialogs, Data Structures
   # @see Wx::Colour
   # @see  Wx::ColourDialog
@@ -95,11 +98,13 @@ module Wx
     NUM_CUSTOM = 16
     
     # Constructor.
+    # 
     # Initializes the custom colours to {Wx::NULL_COLOUR}, the data colour setting to black, and the choose full setting to true.
     # @return [Wx::ColourData]
     def initialize; end
     
     # 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 [Boolean]
@@ -107,6 +112,7 @@ module Wx
     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 [Boolean]
@@ -114,6 +120,7 @@ module Wx
     alias_method :choose_alpha, :get_choose_alpha
     
     # Gets the current colour associated with the colour dialog.
+    # 
     # The default colour is black.
     # @return [Wx::Colour]
     def get_colour; end
@@ -126,6 +133,7 @@ module Wx
     alias_method :custom_colour, :get_custom_colour
     
     # 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 [Boolean] 
@@ -134,6 +142,7 @@ module Wx
     alias_method :choose_full=, :set_choose_full
     
     # 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 [Boolean] 
@@ -142,6 +151,7 @@ module Wx
     alias_method :choose_alpha=, :set_choose_alpha
     
     # Sets the default colour for the colour dialog.
+    # 
     # The default colour is black.
     # @param colour [Wx::Colour,String,Symbol] 
     # @return [void]

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

@@ -7,6 +7,7 @@
 module Wx
 
   # This control allows the user to select a colour.
+  # 
   # The generic implementation is a button which brings up a {Wx::ColourDialog} when clicked. Native implementation may differ but this is usually a (small) widget which give access to the colour-chooser dialog. It is only available if {Wx::Setup::USE_COLOURPICKERCTRL} is set to 1 (the default).
   # ### Styles
   # 
@@ -44,11 +45,13 @@ module Wx
   
     # @overload set_colour(col)
     #   Sets the currently selected colour.
+    #   
     #   See {Wx::Colour#set}.
     #   @param col [Wx::Colour,String,Symbol] 
     #   @return [void]
     # @overload set_colour(colname)
     #   Sets the currently selected colour.
+    #   
     #   See {Wx::Colour#set}.
     #   @param colname [String] 
     #   @return [void]
@@ -71,6 +74,7 @@ module Wx
     def initialize(*args) end
     
     # Creates a colour picker with the given arguments.
+    # 
     # true if the control was successfully created or false if creation failed.
     # @param parent [Wx::Window]  Parent window, must not be non-NULL.
     # @param id [Integer]  The identifier for the control.

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

@@ -31,6 +31,7 @@ module Wx
   EVT_COLOURPICKER_DIALOG_CANCELLED = 10186
   
   # This event class is used for the events generated by {Wx::ColourPickerCtrl}.
+  # 
   # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ColourPickerEvent} events.

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

@@ -7,6 +7,7 @@
 module Wx
 
   # A combobox is like a combination of an edit control and a listbox.
+  # 
   # It can be displayed as static list with editable or read-only text field; or a drop-down list with text field; or a drop-down list without a text field depending on the platform and presence of {Wx::CB_READONLY} style.
   # A combobox permits a single selection only. Combobox items are numbered from zero.
   # If you need a customized combobox, have a look at {Wx::ComboCtrl}, {Wx::OwnerDrawnComboBox}, {Wx::ComboPopup} and the ready-to-use {Wx::BitmapComboBox}.
@@ -57,6 +58,7 @@ module Wx
   
     # @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#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -70,6 +72,7 @@ module Wx
     #   @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#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -89,6 +92,7 @@ module Wx
     # @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
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
@@ -104,6 +108,7 @@ module Wx
     # @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
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
@@ -119,12 +124,14 @@ module Wx
     def initialize(*args) end
     
     # Returns the item being selected right now.
+    # 
     # This function does the same things as {Wx::Choice#get_current_selection} and returns the item currently selected in the dropdown list if it's open or the same thing as {Wx::ControlWithItems#get_selection} otherwise.
     # @return [Integer]
     def get_current_selection; end
     alias_method :current_selection, :get_current_selection
     
     # Same as {Wx::TextEntry#get_insertion_point}.
+    # 
     # <div class="wxrb-note">
     # <b>Note:</b>
     # <p>Under WXMSW, this function always returns 0 if the combobox doesn't have the focus. 
@@ -135,12 +142,14 @@ module Wx
     alias_method :insertion_point, :get_insertion_point
     
     # 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 [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 [Boolean]
     def is_text_empty; end
@@ -151,9 +160,9 @@ module Wx
     # @param to [Integer] 
     # @return [void]
     def set_text_selection_range(from, to) end
-    alias_method :text_selection_range=, :set_text_selection_range
     
     # 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::ComboBox#set_string
     # @see  Wx::ComboBox#set_string_selection 
@@ -163,6 +172,7 @@ module Wx
     alias_method :selection=, :set_selection
     
     # Sets the text for the combobox text field.
+    # 
     # For normal, editable comboboxes with a text entry field calling this method will generate a {Wx::EVT_TEXT} event, consistently with {Wx::TextEntry#set_value} behaviour, use {Wx::TextEntry#change_value} if this is undesirable.
     # For controls with {Wx::CB_READONLY} style the method behaves somewhat differently: the string must be in the combobox choices list (the check for this is case-insensitive) and {Wx::EVT_TEXT} is not generated in this case.
     # @param text [String]  The text to set.
@@ -171,18 +181,21 @@ module Wx
     alias_method :value=, :set_value
     
     # Shows the list box portion of the combo box.
+    # 
     # Currently this method is implemented in WXMSW, WXGTK and WXOSX/Cocoa.
     # Notice that calling this function will generate a {Wx::EVT_COMBOBOX_DROPDOWN} event except under WXOSX where generation of this event is not supported at all.
     # @return [void]
     def popup; end
     
     # Hides the list box portion of the combo box.
+    # 
     # Currently this method is implemented in WXMSW, WXGTK and WXOSX/Cocoa.
     # Notice that calling this function will generate a {Wx::EVT_COMBOBOX_CLOSEUP} event except under WXOSX where generation of this event is not supported at all.
     # @return [void]
     def dismiss; end
     
     # Returns the index of the selected item or {Wx::NOT_FOUND} if no item is selected.
+    # 
     # The position of the current selection.
     # @see Wx::ComboBox#set_selection
     # @see  Wx::ComboBox#get_string_selection 
@@ -191,12 +204,14 @@ module Wx
     alias_method :selection, :get_selection
     
     # Gets the current selection span.
+    # 
     # If the returned values are equal, there was no selection. Please note that the indices returned may be used with the other {Wx::TextCtrl} methods but don't necessarily represent the correct indices into the string returned by {Wx::ComboBox#get_value} for multiline controls under Windows (at least,) you should use {Wx::ComboBox#get_string_selection} to get the selected text.
     # @return [Array(Integer,Integer)]
     def get_text_selection_range; end
     alias_method :text_selection_range, :get_text_selection_range
     
     # 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).
@@ -204,6 +219,7 @@ module Wx
     def find_string(string, caseSensitive=false) end
     
     # Returns the label of the item with the given index.
+    # 
     # The index must be valid, i.e. less than the value returned by {Wx::ComboBox#get_count}, otherwise an assert is triggered. Notably, this function can't be called if the control is empty.
     # 
     # The label of the item.
@@ -213,12 +229,14 @@ module Wx
     alias_method :string, :get_string
     
     # Gets the text currently selected in the control.
+    # 
     # If there is no selection, the returned string is empty.
     # @return [String]
     def get_string_selection; end
     alias_method :string_selection, :get_string_selection
     
     # Changes the text of the specified combobox item.
+    # 
     # Notice that if the item is the currently selected one, i.e. if its text is displayed in the text part of the combobox, then the text is also replaced with the new text.
     # @param n [Integer] 
     # @param text [String] 
@@ -227,6 +245,7 @@ module Wx
     
     # Returns the number of items in the control.
     # 
+    # 
     # @see Wx::ComboBox#is_empty 
     # @return [Integer]
     def get_count; end