]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/region.h
don't compile in wx hash code unless we really use it (#9532:12)
[wxWidgets.git] / interface / region.h
index 72400cab98eabf06c328331bb6032d17780802d7..eeae07060d18687f0ac58aa8334d5d99d0063c2d 100644 (file)
     See wxPaintEvent for an example of use.
 
     @library{wxcore}
-    @category{FIXME}
+    @category{gdi}
+
+    @stdobjects
+    ::wxNullRegion
 
     @see wxPaintEvent
 */
@@ -99,7 +102,6 @@ public:
 
 /**
     @class wxRegion
-    @ingroup group_class_gdi
     @wxheader{region.h}
 
     A wxRegion represents a simple or complex region on a device context or window.
@@ -112,7 +114,7 @@ public:
     data using the reference counting, are not affected.
 
     @library{wxcore}
-    @category{data}
+    @category{data,gdi}
 
     @see wxRegionIterator
 */
@@ -152,8 +154,8 @@ 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,9 +184,9 @@ 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
                  region.
@@ -211,8 +213,8 @@ 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,9 +224,9 @@ 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
                  region.
@@ -239,9 +241,9 @@ public:
         bitmap. Colour to be treated as transparent is specified in the
         @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
                  region.
@@ -257,9 +259,9 @@ 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
                  areas. The result is stored in this region.