]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msw/region.h
renamed to WX_DECLARE_LIST_WITH_DECL for consistency
[wxWidgets.git] / include / wx / msw / region.h
index 58c4d94baa1054b58e745faf5047962155cb7d11..ec3529a3433cfe79f45fadbc76b58889f27563b2 100644 (file)
@@ -1,11 +1,11 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/msw/region.h
 // Purpose:     wxRegion class
-// Author:      Markus Holzem, Julian Smart
+// Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart
+// Copyright:   (c) 1997-2002 wxWindows team
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #define _WX_REGION_H_
 
 #ifdef __GNUG__
-#pragma interface "region.h"
+    #pragma interface "region.h"
 #endif
 
-#include "wx/list.h"
 #include "wx/gdiobj.h"
 #include "wx/gdicmn.h"
 
@@ -49,6 +48,12 @@ public:
     wxRegion(const wxRect& rect);
     wxRegion(WXHRGN hRegion); // Hangs on to this region
     wxRegion(size_t n, const wxPoint *points, int fillStyle = wxODDEVEN_RULE );
+    wxRegion( const wxBitmap& bmp,
+              const wxColour& transColour = wxNullColour,
+              int   tolerance = 0)
+    {
+        Union(bmp, transColour, tolerance);
+    }
 
     virtual ~wxRegion();
 
@@ -59,38 +64,45 @@ public:
         { Ref(r); return (*this); }
 
     // Modify region
+    // -------------
+
     // Clear current region
-    void Clear(void);
+    void Clear();
+
+    // Move the region
+    bool Offset(wxCoord x, wxCoord y);
 
     // Union rectangle or region with this.
-    inline bool Union(wxCoord x, wxCoord y, wxCoord width, wxCoord 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); }
+    bool Union(wxCoord x, wxCoord y, wxCoord width, wxCoord 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.
-    inline bool Intersect(wxCoord x, wxCoord y, wxCoord width, wxCoord 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); }
+    bool Intersect(wxCoord x, wxCoord y, wxCoord width, wxCoord 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.
-    inline bool Subtract(wxCoord x, wxCoord y, wxCoord width, wxCoord 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); }
+    bool Subtract(wxCoord x, wxCoord y, wxCoord width, wxCoord 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.
-    inline bool Xor(wxCoord x, wxCoord y, wxCoord width, wxCoord 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); }
+    bool Xor(wxCoord x, wxCoord y, wxCoord width, wxCoord 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(void) const ;
+    wxRect GetBox() const ;
 
     // Is region empty?
-    bool Empty(void) const;
-    inline bool IsEmpty(void) const { return Empty(); }
+    bool Empty() const;
+    inline bool IsEmpty() const { return Empty(); }
 
     // Tests
     // Does the region contain the point (x,y)?
@@ -102,6 +114,18 @@ public:
     // 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(wxCoord x, wxCoord y, wxCoord width, wxCoord height, wxRegionOp op);
     bool Combine(const wxRegion& region, wxRegionOp op);
@@ -110,38 +134,51 @@ public:
     // Get internal region handle
     WXHRGN GetHRGN() const;
 
-    DECLARE_DYNAMIC_CLASS(wxRegion);
+protected:
+    virtual wxObjectRefData *CreateRefData() const;
+    virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
+
     friend class WXDLLEXPORT wxRegionIterator;
+
+    DECLARE_DYNAMIC_CLASS(wxRegion)
 };
 
 class WXDLLEXPORT wxRegionIterator : public wxObject
 {
 public:
-    wxRegionIterator(void);
+    wxRegionIterator() { Init(); }
     wxRegionIterator(const wxRegion& region);
-    ~wxRegionIterator(void);
+    wxRegionIterator(const wxRegionIterator& ri) { Init(); *this = ri; }
+
+    wxRegionIterator& operator=(const wxRegionIterator& ri);
+
+    virtual ~wxRegionIterator();
 
-    void Reset(void) { m_current = 0; }
+    void Reset() { m_current = 0; }
     void Reset(const wxRegion& region);
 
+    bool HaveRects() const { return (m_current < m_numRects); }
+
 #ifndef __SALFORDC__
-    operator bool (void) const { return (m_current < m_numRects); }
+    operator bool () const { return HaveRects(); }
 #endif
 
-    bool HaveRects(void) const { return (m_current < m_numRects); }
+    wxRegionIterator& operator++();
+    wxRegionIterator operator++(int);
 
-    void operator ++ (void);
-    void operator ++ (int);
+    wxCoord GetX() const;
+    wxCoord GetY() const;
+    wxCoord GetW() const;
+    wxCoord GetWidth() const { return GetW(); }
+    wxCoord GetH() const;
+    wxCoord GetHeight() const { return GetH(); }
 
-    wxCoord GetX(void) const;
-    wxCoord GetY(void) const;
-    wxCoord GetW(void) const;
-    wxCoord GetWidth(void) const { return GetW(); }
-    wxCoord GetH(void) const;
-    wxCoord GetHeight(void) const { return GetH(); }
-    wxRect GetRect() const { return wxRect(GetX(), GetY(), GetWidth(), GetHeight()); }
+    wxRect GetRect() const { return wxRect(GetX(), GetY(), GetW(), GetH()); }
 
 private:
+    // common part of all ctors
+    void Init();
+
     long     m_current;
     long     m_numRects;
     wxRegion m_region;