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

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

@@ -7,11 +7,12 @@
 module Wx
 
   # A listbox-like control allowing the user to rearrange the items and to enable or disable them.
+  # 
   # This class allows changing the order of the items shown in it as well as checking or unchecking them individually. The data structure used to allow this is the order array which contains the items indices indexed by their position with an added twist that the unchecked items are represented by the bitwise complement of the corresponding index (for any architecture using two's complement for negative numbers representation (i.e. just about any at all) this means that a checked item N is represented by -N-1 in unchecked state). In practice this means that you must apply the C bitwise complement operator when constructing the order array, e.g. 
   # ```
   #   wxArrayInt order;
-  #   order.push_back(0); // checked item #0
-  #   order.push_back(~1); // unchecked item #1
+  #   order.push_back(0); // checked item \#0
+  #   order.push_back(~1); // unchecked item \#1
   # ```
   # 
   # So, for example, the array order [1 -3 0] used in conjunction with the items array ["first", "second", "third"] means that the items order is "second", "third", "first" and the "third" item is unchecked while the other two are checked.
@@ -19,19 +20,20 @@ module Wx
   # Usually this control will be used together with other controls allowing to move the items around in it interactively. The simplest possible solution is to use {Wx::RearrangeCtrl} which combines it with two standard buttons to move the current item up or down.
   # Note that while most of the methods for items manipulation such as {Wx::RearrangeList#append}, {Wx::RearrangeList#insert} or {Wx::RearrangeList#delete}, inherited from {Wx::ItemContainer} work as expected for this class, {Wx::RearrangeList#set} somewhat unexpectedly resets the order of the items as it clears the control first, also clearing the order as a side effect, before adding the new items.
   # 
-  # === 
-  # 
   # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table class='appearance'><tr><td> Generic Appearance
   #   </td></tr></table></div>
   # 
+  # @wxrb_require USE_CHECKLISTBOX
   class RearrangeList < CheckListBox
   
     # @overload initialize()
     #   Default constructor.
+    #   
     #   {Wx::RearrangeList#create} must be called later to effectively create the control.
     #   @return [Wx::RearrangeList]
     # @overload initialize(parent, id, pos, size, order, items, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::REARRANGE_LIST_NAME_STR)
     #   Constructor really creating the control.
+    #   
     #   Please see {Wx::RearrangeList#create} for the parameters description.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
@@ -46,6 +48,7 @@ module Wx
     def initialize(*args) end
     
     # Effectively creates the window for an object created using the default constructor.
+    # 
     # This function is very similar to {Wx::CheckListBox#create} except that it has an additional parameter specifying the initial order of the items. Please see the class documentation for the explanation of the conventions used by the order argument.
     # @param parent [Wx::Window]  The parent window, must be non-NULL.
     # @param id [Integer]  The window identifier.
@@ -60,12 +63,14 @@ module Wx
     def create(parent, id, pos, size, order, items, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::REARRANGE_LIST_NAME_STR) end
     
     # Return the current order of the items.
+    # 
     # The order may be different from the one passed to the constructor if {Wx::RearrangeList#move_current_up} or {Wx::RearrangeList#move_current_down} were called.
     # @return [Wx::ArrayInt]
     def get_current_order; end
     alias_method :current_order, :get_current_order
     
     # Return true if the currently selected item can be moved up.
+    # 
     # This function is useful for EVT_UPDATE_UI handler for the standard "Up" button often used together with this control and {Wx::RearrangeCtrl} uses it in this way.
     # true if the currently selected item can be moved up in the listbox, false if there is no selection or the current item is the first one.
     # @see Wx::RearrangeList#can_move_current_down 
@@ -75,12 +80,14 @@ module Wx
     
     # Return true if the currently selected item can be moved down.
     # 
+    # 
     # @see Wx::RearrangeList#can_move_current_up 
     # @return [Boolean]
     def can_move_current_down; end
     alias_method :can_move_current_down?, :can_move_current_down
     
     # Move the currently selected item one position above.
+    # 
     # This method is useful to implement the standard "Up" button behaviour and {Wx::RearrangeCtrl} uses it for this.
     # true if the item was moved or false if this couldn't be done.
     # @see Wx::RearrangeList#move_current_down 
@@ -89,6 +96,7 @@ module Wx
     
     # Move the currently selected item one position below.
     # 
+    # 
     # @see Wx::RearrangeList#move_current_up 
     # @return [Boolean]
     def move_current_down; end

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

@@ -27,13 +27,12 @@ module Wx
   end # RegionContain
   
   # A {Wx::Region} represents a simple or complex region on a device context or window.
+  # 
   # This class uses reference counting and copy-on-write internally so that assignments between two instances of this class are very cheap. You can therefore use actual objects instead of pointers without efficiency problems. If an instance of this class is changed it will create its own data internally so that other instances, which previously shared the data using the reference counting, are not affected.
   # Predefined objects/pointers:
   # 
   # - {Wx::NullRegion}
   # 
-  # === 
-  # 
   # Category:  Data Structures, Graphics Device Interface (GDI)
   # @see Wx::RegionIterator 
   # 
@@ -43,6 +42,7 @@ module Wx
   class Region < GDIObject
   
     # Returns the outer bounds of the region.
+    # 
     # This method returns 0-sized bounding box for invalid regions.
     # @return [Wx::Rect]
     def get_box; end
@@ -50,6 +50,7 @@ module Wx
     
     # @overload offset(x, y)
     #   Moves the region by the specified offsets in horizontal and vertical directions.
+    #   
     #   This method can't be called if the region is invalid as it doesn't make sense to offset it then. Attempts to do it will result in assert failure.
     #   true if successful, false otherwise (the region is unchanged then).
     #   @param x [Integer] 
@@ -57,6 +58,7 @@ module Wx
     #   @return [Boolean]
     # @overload offset(pt)
     #   Moves the region by the specified offsets in horizontal and vertical directions.
+    #   
     #   This method can't be called if the region is invalid as it doesn't make sense to offset it then. Attempts to do it will result in assert failure.
     #   true if successful, false otherwise (the region is unchanged then).
     #   @param pt [Array(Integer, Integer), Wx::Point] 
@@ -65,6 +67,7 @@ module Wx
     
     # @overload initialize()
     #   Default constructor.
+    #   
     #   This constructor creates an invalid, or null, object, i.e. calling IsOk() on it returns false and {Wx::Region#is_empty} returns true.
     #   @return [Wx::Region]
     # @overload initialize(x, y, width, height)
@@ -89,17 +92,20 @@ module Wx
     #   @return [Wx::Region]
     # @overload initialize(points, fillStyle=Wx::PolygonFillMode::ODDEVEN_RULE)
     #   Constructs a region corresponding to the polygon made of n points in the provided array.
+    #   
     #   fillStyle parameter may have values {Wx::PolygonFillMode::WINDING_RULE} or {Wx::PolygonFillMode::ODDEVEN_RULE}.
     #   @param points [Array<Wx::Point>,Array<Array<Integer>>] 
     #   @param fillStyle [Wx::PolygonFillMode] 
     #   @return [Wx::Region]
     # @overload initialize(bmp)
     #   Constructs a region using a bitmap.
+    #   
     #   See {Wx::Region#union} for more details.
     #   @param bmp [Wx::Bitmap] 
     #   @return [Wx::Region]
     # @overload initialize(bmp, transColour, tolerance=0)
     #   Constructs a region using the non-transparent pixels of a bitmap.
+    #   
     #   See {Wx::Region#union} for more details.
     #   @param bmp [Wx::Bitmap] 
     #   @param transColour [Wx::Colour,String,Symbol] 
@@ -108,12 +114,14 @@ module Wx
     def initialize(*args) end
     
     # Clears the current region.
+    # 
     # The object becomes invalid, or null, after being cleared.
     # @return [void]
     def clear; end
     
     # @overload contains(x, y)
     #   Returns a value indicating whether the given point is contained within the region.
+    #   
     #   This method always returns {Wx::RegionContain::OutRegion} for an invalid region but may, nevertheless, be safely called in this case.
     #   The return value is one of {Wx::RegionContain::OutRegion} and {Wx::RegionContain::InRegion}.
     #   @param x [Integer] 
@@ -121,16 +129,22 @@ module Wx
     #   @return [Wx::RegionContain]
     # @overload contains(pt)
     #   Returns a value indicating whether the given point is contained within the region.
+    #   
     #   This method always returns {Wx::RegionContain::OutRegion} for an invalid region but may, nevertheless, be safely called in this case.
     #   The return value is one of {Wx::RegionContain::OutRegion} and {Wx::RegionContain::InRegion}.
     #   @param pt [Array(Integer, Integer), Wx::Point] 
     #   @return [Wx::RegionContain]
     # @overload contains(x, y, width, height)
     #   Returns a value indicating whether the given rectangle is contained within the region.
+    #   
     #   This method always returns {Wx::RegionContain::OutRegion} for an invalid region but may, nevertheless, be safely called in this case.
     #   One of {Wx::RegionContain::OutRegion}, {Wx::RegionContain::PartRegion} or {Wx::RegionContain::InRegion}.
     #   
-    #   On Windows, only {Wx::RegionContain::OutRegion} and {Wx::RegionContain::InRegion} are returned; a value {Wx::RegionContain::InRegion} then indicates that all or some part of the region is contained in this region.
+    #   <div class="wxrb-note">
+    #   <b>Note:</b>
+    #   <p>On Windows, only {Wx::RegionContain::OutRegion} and {Wx::RegionContain::InRegion} are returned; a value {Wx::RegionContain::InRegion} then indicates that all or some part of the region is contained in this region. 
+    #   </p>
+    #   </div>
     #   @param x [Integer] 
     #   @param y [Integer] 
     #   @param width [Integer] 
@@ -138,25 +152,36 @@ module Wx
     #   @return [Wx::RegionContain]
     # @overload contains(rect)
     #   Returns a value indicating whether the given rectangle is contained within the region.
+    #   
     #   This method always returns {Wx::RegionContain::OutRegion} for an invalid region but may, nevertheless, be safely called in this case.
     #   One of {Wx::RegionContain::OutRegion}, {Wx::RegionContain::PartRegion} or {Wx::RegionContain::InRegion}.
     #   
-    #   On Windows, only {Wx::RegionContain::OutRegion} and {Wx::RegionContain::InRegion} are returned; a value {Wx::RegionContain::InRegion} then indicates that all or some part of the region is contained in this region.
+    #   <div class="wxrb-note">
+    #   <b>Note:</b>
+    #   <p>On Windows, only {Wx::RegionContain::OutRegion} and {Wx::RegionContain::InRegion} are returned; a value {Wx::RegionContain::InRegion} then indicates that all or some part of the region is contained in this region. 
+    #   </p>
+    #   </div>
     #   @param rect [Wx::Rect] 
     #   @return [Wx::RegionContain]
     def contains(*args) end
     
     # Convert the region to a black and white bitmap with the white pixels being inside the region.
+    # 
     # This method can't be used for invalid region.
     # @return [Wx::Bitmap]
     def convert_to_bitmap; end
     
     # @overload intersect(x, y, width, height)
     #   Finds the intersection of this region and another, rectangular region, specified using position and size.
+    #   
     #   This method always fails, i.e. returns false, if this region is invalid but may nevertheless be safely used even in this case.
     #   true if successful, false otherwise.
     #   
-    #   Creates the intersection of the two regions, that is, the parts which are in both regions. The result is stored in this region.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Creates the intersection of the two regions, that is, the parts which are in both regions. The result is stored in this region. 
+    #   </p>
+    #   </div>
     #   @param x [Integer] 
     #   @param y [Integer] 
     #   @param width [Integer] 
@@ -164,29 +189,41 @@ module Wx
     #   @return [Boolean]
     # @overload intersect(rect)
     #   Finds the intersection of this region and another, rectangular region.
+    #   
     #   This method always fails, i.e. returns false, if this region is invalid but may nevertheless be safely used even in this case.
     #   true if successful, false otherwise.
     #   
-    #   Creates the intersection of the two regions, that is, the parts which are in both regions. The result is stored in this region.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Creates the intersection of the two regions, that is, the parts which are in both regions. The result is stored in this region. 
+    #   </p>
+    #   </div>
     #   @param rect [Wx::Rect] 
     #   @return [Boolean]
     # @overload intersect(region)
     #   Finds the intersection of this region and another region.
+    #   
     #   This method always fails, i.e. returns false, if this region is invalid but may nevertheless be safely used even in this case.
     #   true if successful, false otherwise.
     #   
-    #   Creates the intersection of the two regions, that is, the parts which are in both regions. The result is stored in this region.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Creates the intersection of the two regions, that is, the parts which are in both regions. The result is stored in this region. 
+    #   </p>
+    #   </div>
     #   @param region [Wx::Region] 
     #   @return [Boolean]
     def intersect(*args) end
     
     # Returns true if the region is empty, false otherwise.
+    # 
     # Always returns true if the region is invalid.
     # @return [Boolean]
     def is_empty; end
     alias_method :empty?, :is_empty
     
     # Returns true if the region is equal to, i.e. covers the same area as, another one.
+    # 
     # If both this region and region are both invalid, they are considered to be equal.
     # @param region [Wx::Region] 
     # @return [Boolean]
@@ -195,28 +232,43 @@ module Wx
     
     # @overload subtract(rect)
     #   Subtracts a rectangular region from this region.
+    #   
     #   This method always fails, i.e. returns false, if this region is invalid but may nevertheless be safely used even in this case.
     #   true if successful, false otherwise.
     #   
-    #   This operation combines the parts of 'this' region that are not part of the second region. The result is stored in this region.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This operation combines the parts of 'this' region that are not part of the second region. The result is stored in this region. 
+    #   </p>
+    #   </div>
     #   @param rect [Wx::Rect] 
     #   @return [Boolean]
     # @overload subtract(region)
     #   Subtracts a region from this region.
+    #   
     #   This method always fails, i.e. returns false, if this region is invalid but may nevertheless be safely used even in this case.
     #   true if successful, false otherwise.
     #   
-    #   This operation combines the parts of 'this' region that are not part of the second region. The result is stored in this region.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This operation combines the parts of 'this' region that are not part of the second region. The result is stored in this region. 
+    #   </p>
+    #   </div>
     #   @param region [Wx::Region] 
     #   @return [Boolean]
     def subtract(*args) end
     
     # @overload union(x, y, width, height)
     #   Finds the union of this region and another, rectangular region, specified using position and size.
+    #   
     #   This method can be used even if this region is invalid and has the natural behaviour in this case, i.e. makes this region equal to the given rectangle.
     #   true if successful, false otherwise.
     #   
-    #   This operation creates a region that combines all of this region and the second region. The result is stored in this region.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This operation creates a region that combines all of this region and the second region. The result is stored in this region. 
+    #   </p>
+    #   </div>
     #   @param x [Integer] 
     #   @param y [Integer] 
     #   @param width [Integer] 
@@ -224,34 +276,54 @@ module Wx
     #   @return [Boolean]
     # @overload union(rect)
     #   Finds the union of this region and another, rectangular region.
+    #   
     #   This method can be used even if this region is invalid and has the natural behaviour in this case, i.e. makes this region equal to the given rectangle.
     #   true if successful, false otherwise.
     #   
-    #   This operation creates a region that combines all of this region and the second region. The result is stored in this region.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This operation creates a region that combines all of this region and the second region. The result is stored in this region. 
+    #   </p>
+    #   </div>
     #   @param rect [Wx::Rect] 
     #   @return [Boolean]
     # @overload union(region)
     #   Finds the union of this region and another region.
+    #   
     #   This method can be used even if this region is invalid and has the natural behaviour in this case, i.e. makes this region equal to the given region.
     #   true if successful, false otherwise.
     #   
-    #   This operation creates a region that combines all of this region and the second region. The result is stored in this region.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This operation creates a region that combines all of this region and the second region. The result is stored in this region. 
+    #   </p>
+    #   </div>
     #   @param region [Wx::Region] 
     #   @return [Boolean]
     # @overload union(bmp)
     #   Finds the union of this region and the non-transparent pixels of a bitmap.
+    #   
     #   The bitmap's mask is used to determine transparency. If the bitmap doesn't have a mask, the bitmap's full dimensions are used.
     #   true if successful, false otherwise.
     #   
-    #   This operation creates a region that combines all of this region and the second region. The result is stored in this region.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This operation creates a region that combines all of this region and the second region. The result is stored in this region. 
+    #   </p>
+    #   </div>
     #   @param bmp [Wx::Bitmap] 
     #   @return [Boolean]
     # @overload union(bmp, transColour, tolerance=0)
     #   Finds the union of this region and the non-transparent pixels of a bitmap.
+    #   
     #   Colour to be treated as transparent is specified in the transColour argument, along with an optional colour tolerance value.
     #   true if successful, false otherwise.
     #   
-    #   This operation creates a region that combines all of this region and the second region. The result is stored in this region.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This operation creates a region that combines all of this region and the second region. The result is stored in this region. 
+    #   </p>
+    #   </div>
     #   @param bmp [Wx::Bitmap] 
     #   @param transColour [Wx::Colour,String,Symbol] 
     #   @param tolerance [Integer] 
@@ -260,10 +332,15 @@ module Wx
     
     # @overload xor(x, y, width, height)
     #   Finds the Xor of this region and another, rectangular region, specified using position and size.
+    #   
     #   This method can be used even if this region is invalid and has the natural behaviour in this case, i.e. makes this region equal to the given rectangle.
     #   true if successful, false otherwise.
     #   
-    #   This operation creates a region that combines all of this region and the second region, except for any overlapping areas. The result is stored in this region.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This operation creates a region that combines all of this region and the second region, except for any overlapping areas. The result is stored in this region. 
+    #   </p>
+    #   </div>
     #   @param x [Integer] 
     #   @param y [Integer] 
     #   @param width [Integer] 
@@ -271,18 +348,28 @@ module Wx
     #   @return [Boolean]
     # @overload xor(rect)
     #   Finds the Xor of this region and another, rectangular region.
+    #   
     #   This method can be used even if this region is invalid and has the natural behaviour in this case, i.e. makes this region equal to the given rectangle.
     #   true if successful, false otherwise.
     #   
-    #   This operation creates a region that combines all of this region and the second region, except for any overlapping areas. The result is stored in this region.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This operation creates a region that combines all of this region and the second region, except for any overlapping areas. The result is stored in this region. 
+    #   </p>
+    #   </div>
     #   @param rect [Wx::Rect] 
     #   @return [Boolean]
     # @overload xor(region)
     #   Finds the Xor of this region and another region.
+    #   
     #   This method can be used even if this region is invalid and has the natural behaviour in this case, i.e. makes this region equal to the given region.
     #   true if successful, false otherwise.
     #   
-    #   This operation creates a region that combines all of this region and the second region, except for any overlapping areas. The result is stored in this region.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>This operation creates a region that combines all of this region and the second region, except for any overlapping areas. The result is stored in this region. 
+    #   </p>
+    #   </div>
     #   @param region [Wx::Region] 
     #   @return [Boolean]
     def xor(*args) end

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

@@ -7,9 +7,9 @@
 module Wx
 
   # This class is used to iterate through the rectangles in a region, typically when examining the damaged regions of a window within an OnPaint call.
+  # 
   # To use it, construct an iterator object on the stack and loop through the regions, testing the object and incrementing the iterator at the end of the loop.
   # See {Wx::PaintEvent} for an example of use.
-  # === 
   # 
   # Category:  Graphics Device Interface (GDI)
   # Predefined objects/pointers: {Wx::NullRegion}