Add GetDrawable convenience function that returns m_bitmap

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

diff --git a/include/wx/mac/region.h b/include/wx/mac/region.h
index aa7d718d739948e04bda7ef56644d087a212e4a5..33c31e7d0df32e5521078011d2c291fe54dbd93c 100644 (file)
--- a/include/wx/mac/region.h
+++ b/include/wx/mac/region.h
@@ -1,18 +1,18 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        region.h
 // Purpose:     wxRegion class
 /////////////////////////////////////////////////////////////////////////////
 // Name:        region.h
 // Purpose:     wxRegion class

-// Author:      AUTHOR
+// Author:      Stefan Csomor

 // Modified by:
 // Modified by:

-// Created:     ??/??/98
+// Created:     1998-01-01

 // RCS-ID:      $Id$
 // RCS-ID:      $Id$

-// Copyright:   (c) AUTHOR
-// Licence:    wxWindows licence
+// Copyright:   (c) Stefan Csomor
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_REGION_H_
 #define _WX_REGION_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_REGION_H_
 #define _WX_REGION_H_
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)

 #pragma interface "region.h"
 #endif
 
 #pragma interface "region.h"
 #endif
 


@@ -24,7 +24,7 @@ class WXDLLEXPORT wxRect;
 class WXDLLEXPORT wxPoint;
 
 enum wxRegionContain {
 class WXDLLEXPORT wxPoint;
 
 enum wxRegionContain {

-       wxOutRegion = 0, wxPartRegion = 1, wxInRegion = 2
+    wxOutRegion = 0, wxPartRegion = 1, wxInRegion = 2

 };
 
 // So far, for internal use only
 };
 
 // So far, for internal use only


@@ -38,101 +38,140 @@ wxRGN_XOR           // Creates the union of two combined regions except for any
 
 class WXDLLEXPORT wxRegion : public wxGDIObject {
 DECLARE_DYNAMIC_CLASS(wxRegion);
 
 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);
 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();
-
-       //# Copying
-       inline wxRegion(const wxRegion& r)
-               { Ref(r); }
-       inline wxRegion& operator = (const wxRegion& r)
-               { Ref(r); return (*this); }
-
-       //# Modify region
-       // Clear current region
-       void Clear();
-
-       // Union rectangle or region with this.
-       inline bool Union(long x, long y, long width, long height) { return Combine(x, y, width, height, wxRGN_OR); }
-       inline bool Union(const wxRect& rect) { return Combine(rect, wxRGN_OR); }
-       inline bool Union(const wxRegion& region) { return Combine(region, wxRGN_OR); }
-
-       // Intersect rectangle or region with this.
-       inline bool Intersect(long x, long y, long width, long height) { return Combine(x, y, width, height, wxRGN_AND); }
-       inline bool Intersect(const wxRect& rect)  { return Combine(rect, wxRGN_AND); }
-       inline bool Intersect(const wxRegion& region)  { return Combine(region, wxRGN_AND); }
-
-       // Subtract rectangle or region from this:
+    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); }
+    bool Union(const wxRect& rect)
+        { 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); }
+    bool Intersect(const wxRect& rect)
+        { 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.
     // Combines the parts of 'this' that are not part of the second region.

-       inline bool Subtract(long x, long y, long width, long height) { return Combine(x, y, width, height, wxRGN_DIFF); }
-       inline bool Subtract(const wxRect& rect)  { return Combine(rect, wxRGN_DIFF); }
-       inline bool Subtract(const wxRegion& region)  { return Combine(region, wxRGN_DIFF); }
-
-       // XOR: the union of two combined regions except for any overlapping areas.
-       inline bool Xor(long x, long y, long width, long height) { return Combine(x, y, width, height, wxRGN_XOR); }
-       inline bool Xor(const wxRect& rect)  { return Combine(rect, wxRGN_XOR); }
-       inline 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;
+    bool Subtract(long x, long y, long width, long height)
+        { return Combine(x, y, width, height, wxRGN_DIFF); }
+    bool Subtract(const wxRect& rect)
+        { 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); }
+    bool Xor(const wxRect& rect)
+        { 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(); }
 
     inline bool IsEmpty() const { return Empty(); }
 

-       //# Tests
-       // Does the region contain the point (x,y)?
-       wxRegionContain Contains(long x, long y) const;
-       // Does the region contain the point pt?
-       wxRegionContain Contains(const wxPoint& pt) const;
-       // Does the region contain the rectangle (x, y, w, h)?
-       wxRegionContain Contains(long x, long y, long w, long h) const;
-       // Does the region contain the rectangle rect?
-       wxRegionContain Contains(const wxRect& rect) const;
-
-// Internal
-       bool Combine(long x, long y, long width, long height, wxRegionOp op);
-       bool Combine(const wxRegion& region, wxRegionOp op);
-       bool Combine(const wxRect& rect, wxRegionOp op);
-       const WXHRGN GetWXHRGN() const ;
+    //# Tests
+    // Does the region contain the point (x,y)?
+    wxRegionContain Contains(long x, long y) const;
+    // Does the region contain the point pt?
+    wxRegionContain Contains(const wxPoint& pt) const;
+    // Does the region contain the rectangle (x, y, w, h)?
+    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 black 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);
+    bool Combine(const wxRect& rect, wxRegionOp op);
+    const WXHRGN GetWXHRGN() const ;

 };
 
 };
 

-class WXDLLEXPORT wxRegionIterator : public wxObject {
-DECLARE_DYNAMIC_CLASS(wxRegionIterator);
+class WXDLLEXPORT wxRegionIterator : public wxObject
+{
+    DECLARE_DYNAMIC_CLASS(wxRegionIterator)
+

 public:
 public:

-       wxRegionIterator();
-       wxRegionIterator(const wxRegion& region);
-       ~wxRegionIterator();
+    wxRegionIterator();
+    wxRegionIterator(const wxRegion& region);
+    wxRegionIterator(const wxRegionIterator& iterator);
+    ~wxRegionIterator();
+
+    wxRegionIterator& operator=(const wxRegionIterator& iterator);

 
 

-       void Reset() { m_current = 0; }
-       void Reset(const wxRegion& region);
+    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; }
+    operator bool () const { return m_current < m_numRects; }
+    bool HaveRects() const { return m_current < m_numRects; }

 
 

-       void operator ++ ();
-       void operator ++ (int);
+    wxRegionIterator& operator++();
+    wxRegionIterator operator++(int);

 
 

-       long GetX() const;
-       long GetY() const;
-       long GetW() const;
-       long GetWidth() const { return GetW(); }
-       long GetH() const;
-       long GetHeight() const { return GetH(); }
+    long GetX() const;
+    long GetY() const;
+    long GetW() const;
+    long GetWidth() const { return GetW(); }
+    long GetH() const;
+    long GetHeight() const { return GetH(); }

     wxRect GetRect() const { return wxRect(GetX(), GetY(), GetWidth(), GetHeight()); }
 private:
     wxRect GetRect() const { return wxRect(GetX(), GetY(), GetWidth(), GetHeight()); }
 private:

-       long     m_current;
-       long     m_numRects;
-       wxRegion m_region;
+    void SetRects(long numRects, wxRect *rects);
+
+    long     m_current;
+    long     m_numRects;
+    wxRegion m_region;

     wxRect*  m_rects;
 };
 
 #endif
     wxRect*  m_rects;
 };
 
 #endif

-       // _WX_REGION_H_
+    // _WX_REGION_H_