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