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

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

@@ -7,16 +7,15 @@
 module Wx
 
   # This event is sent when {Wx::LayoutAlgorithm} wishes to get the size, orientation and alignment of a window.
+  # 
   # More precisely, the event is sent by the OnCalculateLayout handler which is itself invoked by {Wx::LayoutAlgorithm}.
-  # === Events using this class
+  # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::QueryLayoutInfoEvent} events.
   # Event handler methods:
   # 
   # - {Wx::EvtHandler#evt_query_layout_info}(meth = nil, &block): Process a {Wx::EVT_QUERY_LAYOUT_INFO} event, to get size, orientation and alignment from a window. 
   # 
-  # === 
-  # 
   # Category:  {Wx::Events}
   # @see Wx::CalculateLayoutEvent
   # @see  Wx::SashLayoutWindow
@@ -31,24 +30,28 @@ module Wx
     def initialize(id=0) end
     
     # Specifies the alignment of the window (which side of the remaining parent client area the window sticks to).
+    # 
     # One of {Wx::LayoutAlignment::LAYOUT_TOP}, {Wx::LayoutAlignment::LAYOUT_LEFT}, {Wx::LayoutAlignment::LAYOUT_RIGHT}, {Wx::LayoutAlignment::LAYOUT_BOTTOM}.
     # @return [Wx::LayoutAlignment]
     def get_alignment; end
     alias_method :alignment, :get_alignment
     
     # Returns the flags associated with this event.
+    # 
     # Not currently used.
     # @return [Integer]
     def get_flags; end
     alias_method :flags, :get_flags
     
     # Returns the orientation that the event handler specified to the event object.
+    # 
     # May be one of {Wx::LayoutOrientation::LAYOUT_HORIZONTAL}, {Wx::LayoutOrientation::LAYOUT_VERTICAL}.
     # @return [Wx::LayoutOrientation]
     def get_orientation; end
     alias_method :orientation, :get_orientation
     
     # Returns the requested length of the window in the direction of the window orientation.
+    # 
     # This information is not yet used.
     # @return [Integer]
     def get_requested_length; end
@@ -60,6 +63,7 @@ module Wx
     alias_method :size, :get_size
     
     # Call this to specify the alignment of the window (which side of the remaining parent client area the window sticks to).
+    # 
     # May be one of {Wx::LayoutAlignment::LAYOUT_TOP}, {Wx::LayoutAlignment::LAYOUT_LEFT}, {Wx::LayoutAlignment::LAYOUT_RIGHT}, {Wx::LayoutAlignment::LAYOUT_BOTTOM}.
     # @param alignment [Wx::LayoutAlignment] 
     # @return [void]
@@ -67,6 +71,7 @@ module Wx
     alias_method :alignment=, :set_alignment
     
     # Sets the flags associated with this event.
+    # 
     # Not currently used.
     # @param flags [Integer] 
     # @return [void]
@@ -74,6 +79,7 @@ module Wx
     alias_method :flags=, :set_flags
     
     # Call this to specify the orientation of the window.
+    # 
     # May be one of {Wx::LayoutOrientation::LAYOUT_HORIZONTAL}, {Wx::LayoutOrientation::LAYOUT_VERTICAL}.
     # @param orientation [Wx::LayoutOrientation] 
     # @return [void]
@@ -81,6 +87,7 @@ module Wx
     alias_method :orientation=, :set_orientation
     
     # Sets the requested length of the window in the direction of the window orientation.
+    # 
     # This information is not yet used.
     # @param length [Integer] 
     # @return [void]

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

@@ -7,8 +7,9 @@
 module Wx
 
   # A radio box item is used to select one of number of mutually exclusive choices.
+  # 
   # It is displayed as a vertical column or horizontal row of labelled buttons.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -16,35 +17,36 @@ module Wx
   # 
   # - {Wx::RA_SPECIFY_COLS}: The major dimension parameter refers to the maximum number of columns. 
   # 
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
   # Event handler methods for events emitted by this class:
   # 
   # - {Wx::EvtHandler#evt_radiobox}(id, meth = nil, &block): Process a {Wx::EVT_RADIOBOX} event, when a radiobutton is clicked. 
   # 
-  # === 
-  # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
   #   </td></tr></table></div>
   # @see Events and Event Handling
   # @see  Wx::RadioButton
   # @see  Wx::CheckBox 
   # 
   # 
+  # @wxrb_require USE_RADIOBOX
   class RadioBox < Control
   
     # @overload initialize()
     #   Default constructor.
     #   
+    #   
     #   @see Wx::RadioBox#create
     #   @see  Wx::Validator 
     #   @return [Wx::RadioBox]
     # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, majorDimension=0, style=Wx::RA_SPECIFY_COLS, validator=Wx::DEFAULT_VALIDATOR, name=Wx::RADIO_BOX_NAME_STR)
     #   Constructor, creating and showing a radiobox.
     #   
+    #   
     #   @see Wx::RadioBox#create
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
@@ -61,6 +63,7 @@ module Wx
     # @overload initialize(parent, id, label, pos, size, choices, majorDimension=0, style=Wx::RA_SPECIFY_COLS, validator=Wx::DEFAULT_VALIDATOR, name=Wx::RADIO_BOX_NAME_STR)
     #   Constructor, creating and showing a radiobox.
     #   
+    #   
     #   @see Wx::RadioBox#create
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
@@ -78,6 +81,7 @@ module Wx
     
     # @overload create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, majorDimension=0, style=Wx::RA_SPECIFY_COLS, validator=Wx::DEFAULT_VALIDATOR, name=Wx::RADIO_BOX_NAME_STR)
     #   Creates the radiobox for two-step construction.
+    #   
     #   See {Wx::RadioBox#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -92,6 +96,7 @@ module Wx
     #   @return [Boolean]
     # @overload create(parent, id, label, pos, size, choices, majorDimension=0, style=Wx::RA_SPECIFY_COLS, validator=Wx::DEFAULT_VALIDATOR, name=Wx::RADIO_BOX_NAME_STR)
     #   Creates the radiobox for two-step construction.
+    #   
     #   See {Wx::RadioBox#initialize} for further details.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -125,6 +130,7 @@ module Wx
     
     # Returns the helptext associated with the specified item if any or {Wx::EmptyString}.
     # 
+    # 
     # @see Wx::RadioBox#set_item_help_text 
     # @param item [Integer]  The zero-based item index.
     # @return [String]
@@ -133,6 +139,7 @@ module Wx
     
     # Returns the tooltip associated with the specified item if any or NULL.
     # 
+    # 
     # @see Wx::RadioBox#set_item_tool_tip
     # @see  Wx::Window#get_tool_tip 
     # @param item [Integer] 
@@ -146,21 +153,24 @@ module Wx
     alias_method :row_count, :get_row_count
     
     # Returns true if the item is enabled or false if it was disabled using Enable(n, false).
-    # This function is currently only implemented in wxMSW, wxGTK, {Wx::QT} and {Wx::Universal} and always returns true in the other ports.
+    # 
+    # This function is currently only implemented in WXMSW, WXGTK, {Wx::QT} and {Wx::Universal} and always returns true in the other ports.
     # @param n [Integer]  The zero-based button position.
     # @return [Boolean]
     def is_item_enabled(n) end
     alias_method :item_enabled?, :is_item_enabled
     
     # Returns true if the item is currently shown or false if it was hidden using Show(n, false).
+    # 
     # Note that this function returns true for an item which hadn't been hidden even if the entire radiobox is not currently shown.
-    # This function is currently only implemented in wxMSW, wxGTK, {Wx::QT} and {Wx::Universal} and always returns true in the other ports.
+    # This function is currently only implemented in WXMSW, WXGTK, {Wx::QT} and {Wx::Universal} and always returns true in the other ports.
     # @param n [Integer]  The zero-based button position.
     # @return [Boolean]
     def is_item_shown(n) end
     alias_method :item_shown?, :is_item_shown
     
     # Sets the helptext for an item.
+    # 
     # Empty string erases any existing helptext.
     # @see Wx::RadioBox#get_item_help_text 
     # @param item [Integer]  The zero-based item index.
@@ -169,7 +179,8 @@ module Wx
     def set_item_help_text(item, helptext) end
     
     # Sets the tooltip text for the specified item in the radio group.
-    # This function is currently only implemented in wxMSW and wxGTK2 and does nothing in the other ports.
+    # 
+    # This function is currently only implemented in WXMSW and WXGTK2 and does nothing in the other ports.
     # @see Wx::RadioBox#get_item_tool_tip
     # @see  Wx::Window#set_tool_tip 
     # @param item [Integer]  Index of the item the tooltip will be shown for.
@@ -178,6 +189,7 @@ module Wx
     def set_item_tool_tip(item, text) end
     
     # Sets the selection to the given item.
+    # 
     # Notice that a radio box always has selection, so n must be valid here and passing {Wx::NOT_FOUND} is not allowed.
     # @param n [Integer] 
     # @return [void]
@@ -186,12 +198,14 @@ module Wx
     
     # Returns the number of items in the control.
     # 
+    # 
     # @see Wx::RadioBox#is_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::RadioBox#get_count}, otherwise an assert is triggered. Notably, this function can't be called if the control is empty.
     # 
     # The label of the item.
@@ -207,6 +221,7 @@ module Wx
     def set_string(n, string) end
     
     # Returns the index of the selected item.
+    # 
     # As radio boxes always have a selected item, the return value is never {Wx::NOT_FOUND} for this class.
     # @return [Integer]
     def get_selection; end
@@ -214,6 +229,7 @@ module Wx
     
     # Returns true if the control is empty or false if it has some items.
     # 
+    # 
     # @see get_count 
     # @return [Boolean]
     def is_empty; end
@@ -225,6 +241,7 @@ module Wx
     alias_method :strings, :get_strings
     
     # 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.
     # 
@@ -236,6 +253,7 @@ module Wx
     
     # Returns the label of the selected item or an empty string if no item is selected.
     # 
+    # 
     # @see get_selection 
     # @return [String]
     def get_string_selection; end

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

@@ -7,46 +7,48 @@
 module Wx
 
   # A radio button item is a button which usually denotes one of several mutually exclusive options.
+  # 
   # It has a text label next to a (usually) round button.
   # Radio buttons are typically used in groups of mutually-exclusive buttons, i.e. exactly one of the buttons in the group is checked, and the other ones are unchecked automatically. Such groups are created implicitly, but can also be started explicitly by using {Wx::RB_GROUP} style: a button with this style starts a new group and will become the initial selection in this group. Alternatively, a radio button may be excluded from the group that it would otherwise belong to by using {Wx::RB_SINGLE} style.
   # To find the other elements of the same radio button group, you can use {Wx::RadioButton#get_first_in_group}, {Wx::RadioButton#get_previous_in_group}, {Wx::RadioButton#get_next_in_group} and {Wx::RadioButton#get_last_in_group} functions.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
   # - {Wx::RB_GROUP}: Marks the beginning of a new group of radio buttons. 
   # 
-  # - {Wx::RB_SINGLE}: Creates a radio button which is not part of any radio button group. When this style is used, no other radio buttons will be turned off automatically when this button is turned on and such behaviour will need to be implemented manually, in the event handler for this button. This style is currently only supported in wxMSW and wxGTK (since version 3.2.x). In the other ports it can be specified, but single radio buttons can't be turned off, making them not very useful. 
+  # - {Wx::RB_SINGLE}: Creates a radio button which is not part of any radio button group. When this style is used, no other radio buttons will be turned off automatically when this button is turned on and such behaviour will need to be implemented manually, in the event handler for this button. This style is currently only supported in WXMSW and WXGTK (since version 3.2.x). In the other ports it can be specified, but single radio buttons can't be turned off, making them not very useful. 
   # 
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
   # Event handler methods for events emitted by this class:
   # 
   # - {Wx::EvtHandler#evt_radiobutton}(id, meth = nil, &block): Process a {Wx::EVT_RADIOBUTTON} event, when the radiobutton is clicked. 
   # 
-  # === 
-  # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
   #   </td></tr></table></div>
   # @see Events and Event Handling
   # @see  Wx::RadioBox
   # @see  Wx::CheckBox 
   # 
   # 
+  # @wxrb_require USE_RADIOBTN
   class RadioButton < Control
   
     # @overload initialize()
     #   Default constructor.
     #   
+    #   
     #   @see Wx::RadioButton#create
     #   @see  Wx::Validator 
     #   @return [Wx::RadioButton]
     # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::RADIO_BUTTON_NAME_STR)
     #   Constructor, creating and showing a radio button.
     #   
+    #   
     #   @see Wx::RadioButton#create
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
@@ -61,6 +63,7 @@ module Wx
     def initialize(*args) end
     
     # Creates the choice for two-step construction.
+    # 
     # See {Wx::RadioButton#initialize} for further details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -79,15 +82,22 @@ module Wx
     alias_method :value, :get_value
     
     # Sets the radio button to checked or unchecked status.
+    # 
     # This does not cause a {Wx::EVT_RADIOBUTTON} event to get emitted.
     # If the radio button belongs to a radio group exactly one button in the group may be checked and so this method can be only called with value set to true. To uncheck a radio button in a group you must check another button in the same group.
-    # Under MSW, the focused radio button is always selected, i.e. its value is true. And, conversely, calling <code>SetValue(true)</code> will also set focus to the radio button if the focus had previously been on another radio button in the same group  as otherwise setting it on wouldn't work.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Under MSW, the focused radio button is always selected, i.e. its value is true. And, conversely, calling <code>SetValue(true)</code> will also set focus to the radio button if the focus had previously been on another radio button in the same group  as otherwise setting it on wouldn't work.
+    # </p>
+    # </div>
     # @param value [Boolean]  true to check, false to uncheck.
     # @return [void]
     def set_value(value) end
     alias_method :value=, :set_value
     
     # Returns the first button of the radio button group this button belongs to.
+    # 
     # For a radio button with {Wx::RB_SINGLE} style, this function returns this button itself, as it is the only member of its group. Otherwise, the function returns the closest previous radio button with {Wx::RB_GROUP} style (which could still be this button itself) or the first radio button in the same window.
     # The returned value is never NULL.
     # @see Wx::RadioButton#get_previous_in_group
@@ -98,6 +108,7 @@ module Wx
     alias_method :first_in_group, :get_first_in_group
     
     # Returns the last button of the radio button group this button belongs to.
+    # 
     # Similarly to {Wx::RadioButton#get_first_in_group}, this function returns this button itself if it has {Wx::RB_SINGLE} style. Otherwise, the function returns the last button before the next button with {Wx::RB_GROUP} style or the last radio button in the same window.
     # The returned value is never NULL.
     # @see Wx::RadioButton#get_previous_in_group
@@ -107,6 +118,7 @@ module Wx
     alias_method :last_in_group, :get_last_in_group
     
     # Returns the previous radio button in the same group.
+    # 
     # The return value is NULL if there is no predecessor or if this button has {Wx::RB_SINGLE} style.
     # @see Wx::RadioButton#get_first_in_group
     # @see  Wx::RadioButton#get_next_in_group
@@ -116,6 +128,7 @@ module Wx
     alias_method :previous_in_group, :get_previous_in_group
     
     # Returns the next radio button in the same group.
+    # 
     # The return value is NULL if there is no successor or if this button has {Wx::RB_SINGLE} style.
     # @see Wx::RadioButton#get_first_in_group
     # @see  Wx::RadioButton#get_previous_in_group