X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3c4f71cc3d63fb7bdfbd6cec3e39c8a8679f3e60..e53d24bab105c6a510523a5f1f10b721968b8cbe:/interface/region.h diff --git a/interface/region.h b/interface/region.h index f27e9db586..eeae07060d 100644 --- a/interface/region.h +++ b/interface/region.h @@ -20,7 +20,10 @@ See wxPaintEvent for an example of use. @library{wxcore} - @category{FIXME} + @category{gdi} + + @stdobjects + ::wxNullRegion @see wxPaintEvent */ @@ -152,7 +155,7 @@ public: Returns a value indicating whether the given rectangle is contained within the region. - @returns The return value is one of wxOutRegion, wxPartRegion and + @return The return value is one of wxOutRegion, wxPartRegion and wxInRegion. */ wxRegionContain Contains(long& x, long& y) const; @@ -182,7 +185,7 @@ public: /** Finds the intersection of this region and another region. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @remarks Creates the intersection of the two regions, that is, the parts which are in both regions. The result is stored in this @@ -211,7 +214,7 @@ public: Moves the region by the specified offsets in horizontal and vertical directions. - @returns @true if successful, @false otherwise (the region is unchanged + @return @true if successful, @false otherwise (the region is unchanged then). */ bool Offset(wxCoord x, wxCoord y); @@ -222,7 +225,7 @@ public: /** Subtracts a region from this region. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @remarks This operation combines the parts of 'this' region that are not part of the second region. The result is stored in this @@ -239,7 +242,7 @@ public: @a transColour argument, along with an optional colour tolerance value. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @remarks This operation creates a region that combines all of this region and the second region. The result is stored in this @@ -257,7 +260,7 @@ public: /** Finds the Xor of this region and another region. - @returns @true if successful, @false otherwise. + @return @true if successful, @false otherwise. @remarks This operation creates a region that combines all of this region and the second region, except for any overlapping