include/wx/msw/region.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/region.h
   3 // Purpose:     wxRegion class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1997-2002 wxWindows team
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_REGION_H_
  13 #define _WX_REGION_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "region.h"
  17 #endif
  18
  19 #include "wx/gdiobj.h"
  20 #include "wx/gdicmn.h"
  21
  22 class WXDLLEXPORT wxRect;
  23 class WXDLLEXPORT wxPoint;
  24
  25 enum wxRegionContain
  26 {
  27     wxOutRegion = 0,
  28     wxPartRegion = 1,
  29     wxInRegion = 2
  30 };
  31
  32 // So far, for internal use only
  33 enum wxRegionOp
  34 {
  35     wxRGN_AND,          // Creates the intersection of the two combined regions.
  36     wxRGN_COPY,         // Creates a copy of the region identified by hrgnSrc1.
  37     wxRGN_DIFF,         // Combines the parts of hrgnSrc1 that are not part of hrgnSrc2.
  38     wxRGN_OR,           // Creates the union of two combined regions.
  39     wxRGN_XOR           // Creates the union of two combined regions except for any overlapping areas.
  40 };
  41
  42 class WXDLLEXPORT wxRegion : public wxGDIObject
  43 {
  44 public:
  45     wxRegion();
  46     wxRegion(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
  47     wxRegion(const wxPoint& topLeft, const wxPoint& bottomRight);
  48     wxRegion(const wxRect& rect);
  49     wxRegion(WXHRGN hRegion); // Hangs on to this region
  50     wxRegion(size_t n, const wxPoint *points, int fillStyle = wxODDEVEN_RULE );
  51     wxRegion( const wxBitmap& bmp,
  52               const wxColour& transColour = wxNullColour,
  53               int   tolerance = 0)
  54     {
  55         Union(bmp, transColour, tolerance);
  56     }
  57
  58     virtual ~wxRegion();
  59
  60     // Copying
  61     wxRegion(const wxRegion& r)
  62         { Ref(r); }
  63     wxRegion& operator = (const wxRegion& r)
  64         { Ref(r); return (*this); }
  65
  66     // Modify region
  67     // -------------
  68
  69     // Clear current region
  70     void Clear();
  71
  72     // Move the region
  73     bool Offset(wxCoord x, wxCoord y);
  74
  75     // Union rectangle or region with this.
  76     bool Union(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_OR); }
  77     bool Union(const wxRect& rect) { return Combine(rect, wxRGN_OR); }
  78     bool Union(const wxRegion& region) { return Combine(region, wxRGN_OR); }
  79
  80     // Intersect rectangle or region with this.
  81     bool Intersect(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_AND); }
  82     bool Intersect(const wxRect& rect)  { return Combine(rect, wxRGN_AND); }
  83     bool Intersect(const wxRegion& region)  { return Combine(region, wxRGN_AND); }
  84
  85     // Subtract rectangle or region from this:
  86     // Combines the parts of 'this' that are not part of the second region.
  87     bool Subtract(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_DIFF); }
  88     bool Subtract(const wxRect& rect)  { return Combine(rect, wxRGN_DIFF); }
  89     bool Subtract(const wxRegion& region)  { return Combine(region, wxRGN_DIFF); }
  90
  91     // XOR: the union of two combined regions except for any overlapping areas.
  92     bool Xor(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_XOR); }
  93     bool Xor(const wxRect& rect)  { return Combine(rect, wxRGN_XOR); }
  94     bool Xor(const wxRegion& region)  { return Combine(region, wxRGN_XOR); }
  95
  96     // Information on region
  97     // ---------------------
  98
  99     // Outer bounds of region
 100     void GetBox(wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h) const;
 101     wxRect GetBox() const ;
 102
 103     // Is region empty?
 104     bool Empty() const;
 105     inline bool IsEmpty() const { return Empty(); }
 106
 107     // Tests
 108     // Does the region contain the point (x,y)?
 109     wxRegionContain Contains(wxCoord x, wxCoord y) const;
 110     // Does the region contain the point pt?
 111     wxRegionContain Contains(const wxPoint& pt) const;
 112     // Does the region contain the rectangle (x, y, w, h)?
 113     wxRegionContain Contains(wxCoord x, wxCoord y, wxCoord w, wxCoord h) const;
 114     // Does the region contain the rectangle rect?
 115     wxRegionContain Contains(const wxRect& rect) const;
 116
 117     // Convert the region to a B&W bitmap with the white pixels being inside
 118     // the region.
 119     wxBitmap ConvertToBitmap() const;
 120
 121     // Use the non-transparent pixels of a wxBitmap for the region to combine
 122     // with this region.  If the bitmap has a mask then it will be used,
 123     // otherwise the colour to be treated as transparent may be specified,
 124     // along with an optional tolerance value.
 125     bool Union(const wxBitmap& bmp,
 126                const wxColour& transColour = wxNullColour,
 127                int   tolerance = 0);
 128
 129 // Internal
 130     bool Combine(wxCoord x, wxCoord y, wxCoord width, wxCoord height, wxRegionOp op);
 131     bool Combine(const wxRegion& region, wxRegionOp op);
 132     bool Combine(const wxRect& rect, wxRegionOp op);
 133
 134     // Get internal region handle
 135     WXHRGN GetHRGN() const;
 136
 137 protected:
 138     virtual wxObjectRefData *CreateRefData() const;
 139     virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
 140
 141     friend class WXDLLEXPORT wxRegionIterator;
 142
 143     DECLARE_DYNAMIC_CLASS(wxRegion)
 144 };
 145
 146 class WXDLLEXPORT wxRegionIterator : public wxObject
 147 {
 148 public:
 149     wxRegionIterator() { Init(); }
 150     wxRegionIterator(const wxRegion& region);
 151     wxRegionIterator(const wxRegionIterator& ri) { Init(); *this = ri; }
 152
 153     wxRegionIterator& operator=(const wxRegionIterator& ri);
 154
 155     virtual ~wxRegionIterator();
 156
 157     void Reset() { m_current = 0; }
 158     void Reset(const wxRegion& region);
 159
 160     bool HaveRects() const { return (m_current < m_numRects); }
 161
 162 #ifndef __SALFORDC__
 163     operator bool () const { return HaveRects(); }
 164 #endif
 165
 166     wxRegionIterator& operator++();
 167     wxRegionIterator operator++(int);
 168
 169     wxCoord GetX() const;
 170     wxCoord GetY() const;
 171     wxCoord GetW() const;
 172     wxCoord GetWidth() const { return GetW(); }
 173     wxCoord GetH() const;
 174     wxCoord GetHeight() const { return GetH(); }
 175
 176     wxRect GetRect() const { return wxRect(GetX(), GetY(), GetW(), GetH()); }
 177
 178 private:
 179     // common part of all ctors
 180     void Init();
 181
 182     long     m_current;
 183     long     m_numRects;
 184     wxRegion m_region;
 185     wxRect*  m_rects;
 186
 187     DECLARE_DYNAMIC_CLASS(wxRegionIterator)
 188 };
 189
 190 #endif
 191     // _WX_REGION_H_