wxruby3 0.9.0.pre.rc.2-x64-mingw-ucrt → 0.9.0-x64-mingw-ucrt

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

@@ -29,6 +29,7 @@ module Wx
   # 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}
   # 
   # === 
@@ -41,19 +42,10 @@ module Wx
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
   class Region < GDIObject
   
-    # @overload get_box(x, y, width, height)
-    #   Returns the outer bounds of the region.
-    #   This method returns 0-sized bounding box for invalid regions.
-    #   @param x [Integer] 
-    #   @param y [Integer] 
-    #   @param width [Integer] 
-    #   @param height [Integer] 
-    #   @return [void]
-    # @overload get_box()
-    #   Returns the outer bounds of the region.
-    #   This method returns 0-sized bounding box for invalid regions.
-    #   @return [Wx::Rect]
-    def get_box(*args) end
+    # Returns the outer bounds of the region.
+    # This method returns 0-sized bounding box for invalid regions.
+    # @return [Wx::Rect]
+    def get_box; end
     alias_method :box, :get_box
     
     # @overload offset(x, y)
@@ -62,57 +54,57 @@ module Wx
     #   true if successful, false otherwise (the region is unchanged then).
     #   @param x [Integer] 
     #   @param y [Integer] 
-    #   @return [true,false]
+    #   @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] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def offset(*args) end
     
     # @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 [Region]
+    #   @return [Wx::Region]
     # @overload initialize(x, y, width, height)
     #   Constructs a rectangular region with the given position and size.
     #   @param x [Integer] 
     #   @param y [Integer] 
     #   @param width [Integer] 
     #   @param height [Integer] 
-    #   @return [Region]
+    #   @return [Wx::Region]
     # @overload initialize(topLeft, bottomRight)
     #   Constructs a rectangular region from the top left point and the bottom right point.
     #   @param topLeft [Array(Integer, Integer), Wx::Point] 
     #   @param bottomRight [Array(Integer, Integer), Wx::Point] 
-    #   @return [Region]
+    #   @return [Wx::Region]
     # @overload initialize(rect)
     #   Constructs a rectangular region a {Wx::Rect} object.
     #   @param rect [Wx::Rect] 
-    #   @return [Region]
+    #   @return [Wx::Region]
     # @overload initialize(region)
     #   Copy constructor, uses Reference Counting.
     #   @param region [Wx::Region] 
-    #   @return [Region]
+    #   @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 [PolygonFillMode] 
-    #   @return [Region]
+    #   @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 [Region]
+    #   @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] 
     #   @param tolerance [Integer] 
-    #   @return [Region]
+    #   @return [Wx::Region]
     def initialize(*args) end
     
     # Clears the current region.
@@ -126,13 +118,13 @@ module Wx
     #   The return value is one of {Wx::RegionContain::OutRegion} and {Wx::RegionContain::InRegion}.
     #   @param x [Integer] 
     #   @param y [Integer] 
-    #   @return [RegionContain]
+    #   @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 [RegionContain]
+    #   @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.
@@ -143,7 +135,7 @@ module Wx
     #   @param y [Integer] 
     #   @param width [Integer] 
     #   @param height [Integer] 
-    #   @return [RegionContain]
+    #   @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.
@@ -151,7 +143,7 @@ module Wx
     #   
     #   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.
     #   @param rect [Wx::Rect] 
-    #   @return [RegionContain]
+    #   @return [Wx::RegionContain]
     def contains(*args) end
     
     # Convert the region to a black and white bitmap with the white pixels being inside the region.
@@ -169,7 +161,7 @@ module Wx
     #   @param y [Integer] 
     #   @param width [Integer] 
     #   @param height [Integer] 
-    #   @return [true,false]
+    #   @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.
@@ -177,7 +169,7 @@ module Wx
     #   
     #   Creates the intersection of the two regions, that is, the parts which are in both regions. The result is stored in this region.
     #   @param rect [Wx::Rect] 
-    #   @return [true,false]
+    #   @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.
@@ -185,19 +177,19 @@ module Wx
     #   
     #   Creates the intersection of the two regions, that is, the parts which are in both regions. The result is stored in this region.
     #   @param region [Wx::Region] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def intersect(*args) end
     
     # Returns true if the region is empty, false otherwise.
     # Always returns true if the region is invalid.
-    # @return [true,false]
+    # @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 [true,false]
+    # @return [Boolean]
     def is_equal(region) end
     alias_method :equal?, :is_equal
     
@@ -208,7 +200,7 @@ module Wx
     #   
     #   This operation combines the parts of 'this' region that are not part of the second region. The result is stored in this region.
     #   @param rect [Wx::Rect] 
-    #   @return [true,false]
+    #   @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.
@@ -216,7 +208,7 @@ module Wx
     #   
     #   This operation combines the parts of 'this' region that are not part of the second region. The result is stored in this region.
     #   @param region [Wx::Region] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def subtract(*args) end
     
     # @overload union(x, y, width, height)
@@ -229,7 +221,7 @@ module Wx
     #   @param y [Integer] 
     #   @param width [Integer] 
     #   @param height [Integer] 
-    #   @return [true,false]
+    #   @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.
@@ -237,7 +229,7 @@ module Wx
     #   
     #   This operation creates a region that combines all of this region and the second region. The result is stored in this region.
     #   @param rect [Wx::Rect] 
-    #   @return [true,false]
+    #   @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.
@@ -245,7 +237,7 @@ module Wx
     #   
     #   This operation creates a region that combines all of this region and the second region. The result is stored in this region.
     #   @param region [Wx::Region] 
-    #   @return [true,false]
+    #   @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.
@@ -253,7 +245,7 @@ module Wx
     #   
     #   This operation creates a region that combines all of this region and the second region. The result is stored in this region.
     #   @param bmp [Wx::Bitmap] 
-    #   @return [true,false]
+    #   @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.
@@ -263,7 +255,7 @@ module Wx
     #   @param bmp [Wx::Bitmap] 
     #   @param transColour [Wx::Colour,String,Symbol] 
     #   @param tolerance [Integer] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def union(*args) end
     
     # @overload xor(x, y, width, height)
@@ -276,7 +268,7 @@ module Wx
     #   @param y [Integer] 
     #   @param width [Integer] 
     #   @param height [Integer] 
-    #   @return [true,false]
+    #   @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.
@@ -284,7 +276,7 @@ module Wx
     #   
     #   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.
     #   @param rect [Wx::Rect] 
-    #   @return [true,false]
+    #   @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.
@@ -292,7 +284,7 @@ module Wx
     #   
     #   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.
     #   @param region [Wx::Region] 
-    #   @return [true,false]
+    #   @return [Boolean]
     def xor(*args) end
     
   end # Region

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

@@ -20,11 +20,11 @@ module Wx
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [RegionIterator]
+    #   @return [Wx::RegionIterator]
     # @overload initialize(region)
     #   Creates an iterator object given a region.
     #   @param region [Wx::Region] 
-    #   @return [RegionIterator]
+    #   @return [Wx::RegionIterator]
     def initialize(*args) end
     
     # An alias for {Wx::RegionIterator#get_height}.
@@ -63,7 +63,7 @@ module Wx
     alias_method :y, :get_y
     
     # Returns true if there are still some rectangles; otherwise returns false.
-    # @return [true,false]
+    # @return [Boolean]
     def have_rects; end
     
     # Resets the iterator to the beginning of the rectangles.