include/wx/mac/classic/region.h

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