wxruby3 0.9.1-x64-mingw-ucrt → 0.9.2-x64-mingw-ucrt

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

@@ -8,7 +8,6 @@ module Wx
 
   # The {Wx::SizerItem} class is used to track the position, size and other attributes of each item managed by a {Wx::Sizer}.
   # It is not usually necessary to use this class because the sizer elements can also be identified by their positions or window or sizer pointers but sometimes it may be more convenient to use it directly.
-  # === 
   # 
   # Category:  Window Layout
   # 
@@ -44,7 +43,11 @@ module Wx
     alias_method :ratio=, :set_ratio
     
     # Set the window to be tracked by this item.
-    # This is a low-level method which is dangerous if used incorrectly, avoid using it if possible, i.e. if higher level methods such as {Wx::Sizer#replace} can be used instead.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This is a low-level method which is dangerous if used incorrectly, avoid using it if possible, i.e. if higher level methods such as {Wx::Sizer#replace} can be used instead.
+    # </p>
+    # </div>
     # 
     # If the sizer item previously contained a window, it is dissociated from the sizer containing this sizer item (if any), but this object doesn't have the pointer to the containing sizer and so it's the caller's responsibility to call {Wx::Window#set_containing_sizer} on window. Failure to do this can result in memory corruption when the window is destroyed later, so it is crucial to not forget to do it.
     # Also note that the previously contained window is not deleted, so it's also the callers responsibility to do it, if necessary.

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

@@ -52,7 +52,7 @@ module Wx
   # On Windows, the track bar control is used.
   # On GTK+, tick marks are only available for version 2.16 and later.
   # Slider generates the same events as {Wx::ScrollBar} but in practice the most convenient way to process {Wx::Slider} updates is by handling the slider-specific {Wx::EVT_SLIDER} event which carries {Wx::CommandEvent} containing just the latest slider position.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -83,7 +83,7 @@ module Wx
   # - {Wx::SL_INVERSE}: Inverses the minimum and maximum endpoints on the slider. Not compatible with {Wx::SL_SELRANGE}. 
   # 
   # Notice that {Wx::SL_LEFT}, {Wx::SL_TOP}, {Wx::SL_RIGHT} and {Wx::SL_BOTTOM} specify the position of the slider ticks and that the slider labels, if any, are positioned on the opposite side. So, to have a label on the left side of a vertical slider, <b>{Wx::SL_RIGHT}</b> must be used (or none of these styles at all should be specified as left and top are default positions for the vertical and horizontal sliders respectively).
-  # === 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::ScrollEvent} events.
   # Event handler methods for events emitted by this class: except for this, the macros behave exactly the same. 
@@ -130,20 +130,20 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_slider}(id, meth = nil, &block): Process {Wx::EVT_SLIDER} which is generated after any change of {Wx::Slider} position in addition to one of the events above. Notice that the handler of this event receives a {Wx::CommandEvent} as argument and not {Wx::ScrollEvent}, as all the other handlers. 
   # 
-  # == The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
+  # ## The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
   # 
   # The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed by an EVT_SCROLL_CHANGED event).
   # The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE event does not happen). In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/ moving has finished independently of the way it had started. Please see the Widgets Sample ("Slider" page) to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
-  # === 
   # 
-  # 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::ScrollBar 
   # 
   # 
+  # @wxrb_require USE_SLIDER
   class Slider < Control
   
     # @overload initialize()
@@ -168,13 +168,15 @@ module Wx
     def initialize(*args) end
     
     # Clears the selection, for a slider with the <b>{Wx::SL_SELRANGE}</b> style.
-    # Availability:  only available for the wxMSW port.  {Wx::msw}
+    # Availability:  only available for the WXMSW port.
     # @return [void]
+    # @wxrb_require WXMSW
     def clear_sel; end
     
     # Clears the ticks.
-    # Availability:  only available for the wxMSW, wxGTK ports.  {Wx::msw},{Wx::gtk}
+    # Availability:  only available for the WXMSW, WXGTK ports.
     # @return [void]
+    # @wxrb_require WXMSW|WXGTK
     def clear_ticks; end
     
     # Used for two-step slider construction.
@@ -223,32 +225,36 @@ module Wx
     alias_method :page_size, :get_page_size
     
     # Returns the selection end point.
-    # Availability:  only available for the wxMSW port.  {Wx::msw}
+    # Availability:  only available for the WXMSW port.
     # @see Wx::Slider#get_sel_start
     # @see  Wx::Slider#set_selection 
     # @return [Integer]
+    # @wxrb_require WXMSW
     def get_sel_end; end
     alias_method :sel_end, :get_sel_end
     
     # Returns the selection start point.
-    # Availability:  only available for the wxMSW port.  {Wx::msw}
+    # Availability:  only available for the WXMSW port.
     # @see Wx::Slider#get_sel_end
     # @see  Wx::Slider#set_selection 
     # @return [Integer]
+    # @wxrb_require WXMSW
     def get_sel_start; end
     alias_method :sel_start, :get_sel_start
     
     # Returns the thumb length.
-    # Availability:  only available for the wxMSW port.  {Wx::msw}
+    # Availability:  only available for the WXMSW port.
     # @see Wx::Slider#set_thumb_length 
     # @return [Integer]
+    # @wxrb_require WXMSW
     def get_thumb_length; end
     alias_method :thumb_length, :get_thumb_length
     
     # Returns the tick frequency.
-    # Availability:  only available for the wxMSW, wxGTK ports.  {Wx::msw},{Wx::gtk}
+    # Availability:  only available for the WXMSW, WXGTK ports.
     # @see Wx::Slider#set_tick_freq 
     # @return [Integer]
+    # @wxrb_require WXMSW|WXGTK
     def get_tick_freq; end
     alias_method :tick_freq, :get_tick_freq
     
@@ -305,35 +311,39 @@ module Wx
     def set_range(minValue, maxValue) end
     
     # Sets the selection.
-    # Availability:  only available for the wxMSW port.  {Wx::msw}
+    # Availability:  only available for the WXMSW port.
     # @see Wx::Slider#get_sel_start
     # @see  Wx::Slider#get_sel_end 
     # @param startPos [Integer]  The selection start position.
     # @param endPos [Integer]  The selection end position.
     # @return [void]
+    # @wxrb_require WXMSW
     def set_selection(startPos, endPos) end
     
     # Sets the slider thumb length.
-    # Availability:  only available for the wxMSW port.  {Wx::msw}
+    # Availability:  only available for the WXMSW port.
     # @see Wx::Slider#get_thumb_length 
     # @param len [Integer]  The thumb length.
     # @return [void]
+    # @wxrb_require WXMSW
     def set_thumb_length(len) end
     alias_method :thumb_length=, :set_thumb_length
     
     # Sets a tick position.
-    # Availability:  only available for the wxMSW, wxGTK ports.  {Wx::msw},{Wx::gtk}
+    # Availability:  only available for the WXMSW, WXGTK ports.
     # @see Wx::Slider#set_tick_freq 
     # @param tickPos [Integer]  The tick position.
     # @return [void]
+    # @wxrb_require WXMSW|WXGTK
     def set_tick(tickPos) end
     alias_method :tick=, :set_tick
     
     # Sets the tick mark frequency and position.
-    # Availability:  only available for the wxMSW, wxGTK ports.  {Wx::msw},{Wx::gtk}
+    # Availability:  only available for the WXMSW, WXGTK ports.
     # @see Wx::Slider#get_tick_freq 
     # @param freq [Integer]  Frequency. For example, if the frequency is set to two, a tick mark is displayed for every other increment in the slider's range.
     # @return [void]
+    # @wxrb_require WXMSW|WXGTK
     def set_tick_freq(freq) end
     alias_method :tick_freq=, :set_tick_freq
     

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

@@ -8,13 +8,18 @@ module Wx
 
   # A {Wx::SpinButton} has two small up and down (or left and right) arrow buttons.
   # It is often used next to a text control for incrementing and decrementing a value. Portable programs should try to use {Wx::SpinCtrl} instead as {Wx::SpinButton} is not implemented for all platforms but {Wx::SpinCtrl} is as it degenerates to a simple {Wx::TextCtrl} on such platforms.
-  # the range supported by this control (and {Wx::SpinCtrl}) depends on the platform but is at least <code>-0x8000</code> to 0x7fff. Under GTK and Win32 with sufficiently new version of comctrl32.dll (at least 4.71 is required, 5.80 is recommended) the full 32 bit range is supported.
   # 
-  # === Styles
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>the range supported by this control (and {Wx::SpinCtrl}) depends on the platform but is at least <code>-0x8000</code> to 0x7fff. Under GTK and Win32 with sufficiently new version of comctrl32.dll (at least 4.71 is required, 5.80 is recommended) the full 32 bit range is supported.
+  # </p>
+  # </div>
+  # 
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
-  # - {Wx::SP_HORIZONTAL}: Specifies a horizontal spin button (note that this style is not supported in wxGTK). 
+  # - {Wx::SP_HORIZONTAL}: Specifies a horizontal spin button (note that this style is not supported in WXGTK). 
   # 
   # - {Wx::SP_VERTICAL}: Specifies a vertical spin button. 
   # 
@@ -22,7 +27,7 @@ module Wx
   # 
   # - {Wx::SP_WRAP}: The value wraps at the minimum and maximum. 
   # 
-  # === 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::SpinEvent} events.
   # Event handler methods for events emitted by this class:
@@ -34,15 +39,15 @@ module Wx
   # - {Wx::EvtHandler#evt_spin_down}(id, meth = nil, &block): Generated whenever pressing right/down arrow changed the spin button value. 
   # 
   # Note that if you handle both SPIN and UP or DOWN events, you will be notified about each of them twice: first the UP/DOWN event will be received and then, if it wasn't vetoed, the SPIN event will be sent.
-  # === 
   # 
-  # 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 Wx::SpinCtrl 
   # 
   # 
+  # @wxrb_require USE_SPINBTN
   class SpinButton < Control
   
     # @overload initialize()
@@ -102,7 +107,7 @@ module Wx
     # Sets the increment for the control.
     # The increment is the number by which the value changes when the up or down arrow is used.
     # The default is 1.
-    # This function is currently implemented only in wxMSW and does nothing under the other platforms.
+    # This function is currently implemented only in WXMSW and does nothing under the other platforms.
     # @see Wx::SpinCtrl#set_increment 
     # @param value [Integer] 
     # @return [void]
@@ -110,7 +115,7 @@ module Wx
     alias_method :increment=, :set_increment
     
     # Sets the range of the spin button.
-    # In portable code, min should be less than or equal to max. In wxMSW it is possible to specify minimum greater than maximum and the native control supports the same range as if they were reversed, but swaps the meaning of up and down arrows, however this dubious feature is not supported on other platforms.
+    # In portable code, min should be less than or equal to max. In WXMSW it is possible to specify minimum greater than maximum and the native control supports the same range as if they were reversed, but swaps the meaning of up and down arrows, however this dubious feature is not supported on other platforms.
     # @see Wx::SpinButton#get_min
     # @see  Wx::SpinButton#get_max 
     # @param min [Integer]  The minimum value for the spin button.

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

@@ -15,7 +15,7 @@ module Wx
   EVT_SPINCTRLDOUBLE = 10132
   
   # {Wx::SpinCtrl} combines {Wx::TextCtrl} and {Wx::SpinButton} in one control.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -31,7 +31,7 @@ module Wx
   # 
   # - {Wx::Alignment::ALIGN_RIGHT}: Same as {Wx::TE_RIGHT} for {Wx::TextCtrl}: the text is right aligned. 
   # 
-  # === 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::SpinEvent} events.
   # Event handler methods for events emitted by this class:
@@ -39,17 +39,17 @@ module Wx
   # - {Wx::EvtHandler#evt_spinctrl}(id, meth = nil, &block): Process a {Wx::EVT_SPINCTRL} event, which is generated whenever the numeric value of the spin control is updated. 
   # 
   # You may also use the {Wx::SpinButton} event macros, however the corresponding events will not be generated under all platforms. Finally, if the user modifies the text in the edit part of the spin control directly, the EVT_TEXT is generated, like for the {Wx::TextCtrl}. When the use enters text into the text area, the text is not validated until the control loses focus (e.g. by using the TAB key). The value is then adjusted to the range and a {Wx::SpinEvent} sent then if the value is different from the last value sent.
-  # === 
   # 
-  # 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 Wx::SpinButton
   # @see  Wx::SpinCtrlDouble
   # @see  Wx::Control 
   # 
   # 
+  # @wxrb_require USE_SPINCTRL
   class SpinCtrl < Control
   
     # @overload initialize()
@@ -123,7 +123,12 @@ module Wx
     # Sets the base to use for the numbers in this control.
     # Currently the only supported values are 10 (which is the default) and 16.
     # Changing the base allows the user to enter the numbers in the specified base, e.g. with "0x" prefix for hexadecimal numbers, and also displays the numbers in the specified base when they are changed using the spin control arrows.
-    # Setting a base to 16 is allowed only if current range does not include negative values.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Setting a base to 16 is allowed only if current range does not include negative values.
+    # </p>
+    # </div>
     # 
     # true if the base was successfully changed or false if it failed, usually meaning that either the base is not 10 or 16 or that the base is not supported for values in the current range.
     # @param base [Integer]  Numeric base, currently only 10 and 16 are supported.
@@ -133,7 +138,12 @@ module Wx
     
     # Sets range of allowable values.
     # Notice that calling this method may change the value of the control if it's not inside the new valid range, e.g. it will become minVal if it is less than it now. However no {Wx::EVT_SPINCTRL} event is generated, even if it the value does change.
-    # Setting a range including negative values is silently ignored if current base is set to 16.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Setting a range including negative values is silently ignored if current base is set to 16. 
+    # </p>
+    # </div>
     # @param minVal [Integer] 
     # @param maxVal [Integer] 
     # @return [void]
@@ -141,7 +151,12 @@ module Wx
     
     # Select the text in the text part of the control between positions from (inclusive) and to (exclusive).
     # This is similar to {Wx::TextCtrl#set_selection}.
-    # this is currently only implemented for Windows and generic versions of the control.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>this is currently only implemented for Windows and generic versions of the control. 
+    # </p>
+    # </div>
     # @param from [Integer] 
     # @param to [Integer] 
     # @return [void]

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

@@ -8,7 +8,7 @@ module Wx
 
   # {Wx::SpinCtrlDouble} combines {Wx::TextCtrl} and {Wx::SpinButton} in one control and displays a real number.
   # ({Wx::SpinCtrl} displays an integer.)
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -16,24 +16,23 @@ module Wx
   # 
   # - {Wx::SP_WRAP}: The value wraps at the minimum and maximum. 
   # 
-  # === 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::SpinDoubleEvent} events.
   # Event handler methods for events emitted by this class:
   # 
   # - {Wx::EvtHandler#evt_spinctrldouble}(id, meth = nil, &block): Generated whenever the numeric value of the spin control is changed, that is, when the up/down spin button is clicked, when ENTER is pressed, or the control loses focus and the new value is different from the last. See {Wx::SpinDoubleEvent}. 
   # 
-  # === 
-  # 
-  # 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 Wx::SpinButton
   # @see  Wx::SpinCtrl
   # @see  Wx::Control 
   # 
   # 
+  # @wxrb_require USE_SPINBTN
   class SpinCtrlDouble < Control
   
     # @overload initialize()

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

@@ -7,25 +7,24 @@
 module Wx
 
   # This event class is used for the events generated by {Wx::SpinCtrlDouble}.
-  # === Events using this class
+  # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SpinDoubleEvent} events.
   # Event handler methods:
   # 
   # - {Wx::EvtHandler#evt_spinctrldouble}(id, meth = nil, &block): Generated whenever the numeric value of the spin control is changed, that is, when the up/down spin button is clicked or when the control loses focus and the new value is different from the last one. See {Wx::SpinDoubleEvent}. 
   # 
-  # === 
-  # 
   # Category:  {Wx::Events}
   # @see Wx::SpinCtrlDouble 
   # 
   # 
+  # @wxrb_require USE_SPINBTN
   class SpinDoubleEvent < NotifyEvent
   
     # @overload initialize(commandType=Wx::EVT_NULL, winid=0, value=0)
     #   The constructor.
     #   Not normally used by the user code.
-    #   @param commandType [Wx::CommandLinkButton::EventType] 
+    #   @param commandType [Wx::Slider::EventType] 
     #   @param winid [Integer] 
     #   @param value [Float] 
     #   @return [Wx::SpinDoubleEvent]

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

@@ -7,7 +7,7 @@
 module Wx
 
   # This event class is used for the events generated by {Wx::SpinButton} and {Wx::SpinCtrl}.
-  # === Events using this class
+  # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SpinEvent} events.
   # Event handler methods:
@@ -19,16 +19,16 @@ module Wx
   # - {Wx::EvtHandler#evt_spin_down}(id, meth = nil, &block): Generated when right/down arrow is pressed. 
   # 
   # Note that if you handle both SPIN and UP or DOWN events, you will be notified about each of them twice: first the UP/DOWN event will be received and then, if it wasn't vetoed, the SPIN event will be sent.
-  # === 
   # 
   # Category:  {Wx::Events}
   # @see Wx::SpinButton and Wx::SpinCtrl 
   # 
   # 
+  # @wxrb_require USE_SPINBTN|USE_SPINCTRL
   class SpinEvent < NotifyEvent
   
     # The constructor is not normally used by the user code.
-    # @param commandType [Wx::CommandLinkButton::EventType] 
+    # @param commandType [Wx::Slider::EventType] 
     # @param id [Integer] 
     # @return [Wx::SpinEvent]
     def initialize(commandType=Wx::EVT_NULL, id=0) end

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

@@ -36,10 +36,9 @@ module Wx
   #   Wx.get_app.yield
   # ```
   # 
-  # === 
-  # 
   # Category:  Managed Windows
   # 
+  # @wxrb_require USE_SPLASH
   class SplashScreen < Frame
   
     # Construct the splash screen passing a bitmap, a style, a timeout, a window id, optional position and size, and a window style.

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

@@ -8,7 +8,7 @@ module Wx
 
   # This class represents the events generated by a splitter control.
   # Also there is only one event class, the data associated to the different events is not the same and so not all accessor functions may be called for each event. The documentation mentions the kind of event(s) for which the given accessor function makes sense: calling it for other types of events will result in assert failure (in debug mode) and will return meaningless results.
-  # === Events using this class
+  # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SplitterEvent} events.
   # Event handler methods:
@@ -21,18 +21,17 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_splitter_dclick}(id, meth = nil, &block): The sash was double clicked. The default behaviour is to unsplit the window when this happens (unless the minimum pane size has been set to a value greater than zero). Processes a {Wx::EVT_SPLITTER_DOUBLECLICKED} event. 
   # 
-  # === 
-  # 
   # Category:  {Wx::Events}
   # @see Wx::SplitterWindow
   # @see  Events and Event Handling 
   # 
   # 
+  # @wxrb_require USE_SPLITTER
   class SplitterEvent < NotifyEvent
   
     # Constructor.
     # Used internally by wxWidgets only.
-    # @param eventType [Wx::CommandLinkButton::EventType] 
+    # @param eventType [Wx::Slider::EventType] 
     # @param splitter [Wx::SplitterWindow] 
     # @return [Wx::SplitterEvent]
     def initialize(eventType=Wx::EVT_NULL, splitter=nil) end