Always use XPMs in this sample

[wxWidgets.git] / include / wx / mac / region.h

diff --git a/include/wx/mac/region.h b/include/wx/mac/region.h
index 019c9a4365a828d3a163d39be10aecae3102f64f..ab04dd8975c2aa841e78e420ac2be5660909b282 100644 (file)
--- a/include/wx/mac/region.h
+++ b/include/wx/mac/region.h
@@ -1,18 +1,18 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        region.h
 // Purpose:     wxRegion class
-// Author:      AUTHOR
+// Author:      Stefan Csomor
 // Modified by:
-// Created:     ??/??/98
+// Created:     1998-01-01
 // RCS-ID:      $Id$
-// Copyright:   (c) AUTHOR
-// Licence:    wxWindows licence
+// Copyright:   (c) Stefan Csomor
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_REGION_H_
 #define _WX_REGION_H_
 
-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "region.h"
 #endif
 
@@ -24,7 +24,7 @@ class WXDLLEXPORT wxRect;
 class WXDLLEXPORT wxPoint;
 
 enum wxRegionContain {
-       wxOutRegion = 0, wxPartRegion = 1, wxInRegion = 2
+    wxOutRegion = 0, wxPartRegion = 1, wxInRegion = 2
 };
 
 // So far, for internal use only
@@ -38,26 +38,33 @@ wxRGN_XOR           // Creates the union of two combined regions except for any
 
 class WXDLLEXPORT wxRegion : public wxGDIObject {
 DECLARE_DYNAMIC_CLASS(wxRegion);
-       friend class WXDLLEXPORT wxRegionIterator;
+    friend class WXDLLEXPORT wxRegionIterator;
 public:
     wxRegion(long x, long y, long w, long h);
     wxRegion(const wxPoint& topLeft, const wxPoint& bottomRight);
     wxRegion(const wxRect& rect);
     wxRegion( WXHRGN hRegion );
     wxRegion();
+    wxRegion( const wxBitmap& bmp,
+              const wxColour& transColour = wxNullColour,
+              int   tolerance = 0)
+    {
+        Union(bmp, transColour, tolerance);
+    }
+
     ~wxRegion();
-    
+
     //# Copying
     wxRegion(const wxRegion& r)
         : wxGDIObject()
     { Ref(r); }
     wxRegion& operator = (const wxRegion& r)
     { Ref(r); return (*this); }
-    
+
     //# Modify region
     // Clear current region
     void Clear();
-    
+
     // Union rectangle or region with this.
     bool Union(long x, long y, long width, long height)
         { return Combine(x, y, width, height, wxRGN_OR); }
@@ -65,7 +72,7 @@ public:
         { return Combine(rect, wxRGN_OR); }
     bool Union(const wxRegion& region)
         { return Combine(region, wxRGN_OR); }
-    
+
     // Intersect rectangle or region with this.
     bool Intersect(long x, long y, long width, long height)
         { return Combine(x, y, width, height, wxRGN_AND); }
@@ -73,7 +80,7 @@ public:
         { return Combine(rect, wxRGN_AND); }
     bool Intersect(const wxRegion& region)
         { return Combine(region, wxRGN_AND); }
-    
+
     // Subtract rectangle or region from this:
     // Combines the parts of 'this' that are not part of the second region.
     bool Subtract(long x, long y, long width, long height)
@@ -82,7 +89,7 @@ public:
         { return Combine(rect, wxRGN_DIFF); }
     bool Subtract(const wxRegion& region)
         { return Combine(region, wxRGN_DIFF); }
-    
+
     // XOR: the union of two combined regions except for any overlapping areas.
     bool Xor(long x, long y, long width, long height)
         { return Combine(x, y, width, height, wxRGN_XOR); }
@@ -90,16 +97,16 @@ public:
         { return Combine(rect, wxRGN_XOR); }
     bool Xor(const wxRegion& region)
         { return Combine(region, wxRGN_XOR); }
-    
+
     //# Information on region
     // Outer bounds of region
     void GetBox(wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h) const;
     wxRect GetBox() const ;
-    
+
     // Is region empty?
     bool Empty() const;
     inline bool IsEmpty() const { return Empty(); }
-    
+
     //# Tests
     // Does the region contain the point (x,y)?
     wxRegionContain Contains(long x, long y) const;
@@ -109,7 +116,19 @@ public:
     wxRegionContain Contains(long x, long y, long w, long h) const;
     // Does the region contain the rectangle rect?
     wxRegionContain Contains(const wxRect& rect) const;
-    
+
+    // Convert the region to a B&W bitmap with the white pixels being inside
+    // the region.
+    wxBitmap ConvertToBitmap() const;
+
+    // Use the non-transparent pixels of a wxBitmap for the region to combine
+    // with this region.  If the bitmap has a mask then it will be used,
+    // otherwise the colour to be treated as transparent may be specified,
+    // along with an optional tolerance value.
+    bool Union(const wxBitmap& bmp,
+               const wxColour& transColour = wxNullColour,
+               int   tolerance = 0);
+
     // Internal
     bool Combine(long x, long y, long width, long height, wxRegionOp op);
     bool Combine(const wxRegion& region, wxRegionOp op);
@@ -120,7 +139,7 @@ public:
 class WXDLLEXPORT wxRegionIterator : public wxObject
 {
     DECLARE_DYNAMIC_CLASS(wxRegionIterator)
-        
+
 public:
     wxRegionIterator();
     wxRegionIterator(const wxRegion& region);
@@ -131,13 +150,13 @@ public:
 
     void Reset() { m_current = 0; }
     void Reset(const wxRegion& region);
-    
+
     operator bool () const { return m_current < m_numRects; }
     bool HaveRects() const { return m_current < m_numRects; }
 
     wxRegionIterator& operator++();
     wxRegionIterator operator++(int);
-    
+
     long GetX() const;
     long GetY() const;
     long GetW() const;
@@ -155,4 +174,4 @@ private:
 };
 
 #endif
-       // _WX_REGION_H_
+    // _WX_REGION_H_