include/wx/region.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/region.h
   3 // Purpose:     Base header for wxRegion
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows Licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_REGION_H_BASE_
  13 #define _WX_REGION_H_BASE_
  14
  15 #include "wx/gdiobj.h"
  16 #include "wx/gdicmn.h"
  17
  18 class WXDLLIMPEXP_CORE wxBitmap;
  19 class WXDLLEXPORT wxColour;
  20 class WXDLLEXPORT wxRegion;
  21
  22 // ----------------------------------------------------------------------------
  23 // constants
  24 // ----------------------------------------------------------------------------
  25
  26 // result of wxRegion::Contains() call
  27 enum wxRegionContain
  28 {
  29     wxOutRegion = 0,
  30     wxPartRegion = 1,
  31     wxInRegion = 2
  32 };
  33
  34 // these constants are used with wxRegion::Combine() in the ports which have
  35 // this method
  36 enum wxRegionOp
  37 {
  38     // Creates the intersection of the two combined regions.
  39     wxRGN_AND,
  40
  41     // Creates a copy of the region
  42     wxRGN_COPY,
  43
  44     // Combines the parts of first region that are not in the second one
  45     wxRGN_DIFF,
  46
  47     // Creates the union of two combined regions.
  48     wxRGN_OR,
  49
  50     // Creates the union of two regions except for any overlapping areas.
  51     wxRGN_XOR
  52 };
  53
  54 // ----------------------------------------------------------------------------
  55 // wxRegionBase defines wxRegion API
  56 // ----------------------------------------------------------------------------
  57
  58 class WXDLLEXPORT wxRegionBase : public wxGDIObject
  59 {
  60 public:
  61     // ctors
  62     // -----
  63
  64     // none are defined here but the following should be available:
  65 #if 0
  66     wxRegion();
  67     wxRegion(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
  68     wxRegion(const wxPoint& topLeft, const wxPoint& bottomRight);
  69     wxRegion(const wxRect& rect);
  70     wxRegion(size_t n, const wxPoint *points, int fillStyle = wxODDEVEN_RULE);
  71     wxRegion(const wxBitmap& bmp);
  72     wxRegion(const wxBitmap& bmp, const wxColour& transp, int tolerance = 0);
  73 #endif // 0
  74
  75     // operators
  76     // ---------
  77
  78     bool operator==(const wxRegion& region) const { return IsEqual(region); }
  79     bool operator!=(const wxRegion& region) const { return !(*this == region); }
  80
  81
  82     // accessors
  83     // ---------
  84
  85     bool Ok() const { return IsOk(); }
  86     bool IsOk() const { return m_refData != NULL; }
  87
  88     // Is region empty?
  89     virtual bool IsEmpty() const = 0;
  90     bool Empty() const { return IsEmpty(); }
  91
  92     // Is region equal (i.e. covers the same area as another one)?
  93     bool IsEqual(const wxRegion& region) const;
  94
  95     // Get the bounding box
  96     bool GetBox(wxCoord& x, wxCoord& y, wxCoord& w, wxCoord& h) const
  97         { return DoGetBox(x, y, w, h); }
  98     wxRect GetBox() const
  99     {
 100         wxCoord x, y, w, h;
 101         return DoGetBox(x, y, w, h) ? wxRect(x, y, w, h) : wxRect();
 102     }
 103
 104     // Test if the given point or rectangle is inside this region
 105     wxRegionContain Contains(wxCoord x, wxCoord y) const
 106         { return DoContainsPoint(x, y); }
 107     wxRegionContain Contains(const wxPoint& pt) const
 108         { return DoContainsPoint(pt.x, pt.y); }
 109     wxRegionContain Contains(wxCoord x, wxCoord y, wxCoord w, wxCoord h) const
 110         { return DoContainsRect(wxRect(x, y, w, h)); }
 111     wxRegionContain Contains(const wxRect& rect) const
 112         { return DoContainsRect(rect); }
 113
 114
 115     // operations
 116     // ----------
 117
 118     virtual void Clear() = 0;
 119
 120     // Move the region
 121     bool Offset(wxCoord x, wxCoord y)
 122         { return DoOffset(x, y); }
 123     bool Offset(const wxPoint& pt)
 124         { return DoOffset(pt.x, pt.y); }
 125
 126     // Union rectangle or region with this region.
 127     bool Union(wxCoord x, wxCoord y, wxCoord w, wxCoord h)
 128         { return DoUnionWithRect(wxRect(x, y, w, h)); }
 129     bool Union(const wxRect& rect)
 130         { return DoUnionWithRect(rect); }
 131     bool Union(const wxRegion& region)
 132         { return DoUnionWithRegion(region); }
 133
 134 #if wxUSE_IMAGE
 135     // Use the non-transparent pixels of a wxBitmap for the region to combine
 136     // with this region.  First version takes transparency from bitmap's mask,
 137     // second lets the user specify the colour to be treated as transparent
 138     // along with an optional tolerance value.
 139     // NOTE: implemented in common/rgncmn.cpp
 140     bool Union(const wxBitmap& bmp);
 141     bool Union(const wxBitmap& bmp, const wxColour& transp, int tolerance = 0);
 142 #endif // wxUSE_IMAGE
 143
 144     // Intersect rectangle or region with this one.
 145     bool Intersect(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
 146     bool Intersect(const wxRect& rect);
 147     bool Intersect(const wxRegion& region)
 148         { return DoIntersect(region); }
 149
 150     // Subtract rectangle or region from this:
 151     // Combines the parts of 'this' that are not part of the second region.
 152     bool Subtract(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
 153     bool Subtract(const wxRect& rect);
 154     bool Subtract(const wxRegion& region)
 155         { return DoSubtract(region); }
 156
 157     // XOR: the union of two combined regions except for any overlapping areas.
 158     bool Xor(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
 159     bool Xor(const wxRect& rect);
 160     bool Xor(const wxRegion& region)
 161         { return DoXor(region); }
 162
 163
 164     // Convert the region to a B&W bitmap with the white pixels being inside
 165     // the region.
 166     wxBitmap ConvertToBitmap() const;
 167
 168 protected:
 169     virtual bool DoIsEqual(const wxRegion& region) const = 0;
 170     virtual bool DoGetBox(wxCoord& x, wxCoord& y, wxCoord& w, wxCoord& h) const = 0;
 171     virtual wxRegionContain DoContainsPoint(wxCoord x, wxCoord y) const = 0;
 172     virtual wxRegionContain DoContainsRect(const wxRect& rect) const = 0;
 173
 174     virtual bool DoOffset(wxCoord x, wxCoord y) = 0;
 175
 176     virtual bool DoUnionWithRect(const wxRect& rect) = 0;
 177     virtual bool DoUnionWithRegion(const wxRegion& region) = 0;
 178
 179     virtual bool DoIntersect(const wxRegion& region) = 0;
 180     virtual bool DoSubtract(const wxRegion& region) = 0;
 181     virtual bool DoXor(const wxRegion& region) = 0;
 182 };
 183
 184 // some ports implement a generic Combine() function while others only
 185 // implement individual wxRegion operations, factor out the common code for the
 186 // ports with Combine() in this class
 187 #if defined(__WXPALMOS__) || \
 188     defined(__WXMSW__) || \
 189     defined(__WXMAC__) || \
 190     defined(__WXPM__)
 191
 192 #define wxHAS_REGION_COMBINE
 193
 194 class WXDLLEXPORT wxRegionWithCombine : public wxRegionBase
 195 {
 196 public:
 197     // these methods are not part of public API as they're not implemented on
 198     // all ports
 199     bool Combine(wxCoord x, wxCoord y, wxCoord w, wxCoord h, wxRegionOp op);
 200     bool Combine(const wxRect& rect, wxRegionOp op);
 201     bool Combine(const wxRegion& region, wxRegionOp op)
 202         { return DoCombine(region, op); }
 203
 204
 205 protected:
 206     // the real Combine() method, to be defined in the derived class
 207     virtual bool DoCombine(const wxRegion& region, wxRegionOp op) = 0;
 208
 209     // implement some wxRegionBase pure virtuals in terms of Combine()
 210     virtual bool DoUnionWithRect(const wxRect& rect);
 211     virtual bool DoUnionWithRegion(const wxRegion& region);
 212     virtual bool DoIntersect(const wxRegion& region);
 213     virtual bool DoSubtract(const wxRegion& region);
 214     virtual bool DoXor(const wxRegion& region);
 215 };
 216
 217 #endif // ports with wxRegion::Combine()
 218
 219 #if defined(__WXPALMOS__)
 220     #include "wx/palmos/region.h"
 221 #elif defined(__WXMSW__)
 222     #include "wx/msw/region.h"
 223 #elif defined(__WXGTK20__)
 224     #include "wx/gtk/region.h"
 225 #elif defined(__WXGTK__)
 226     #include "wx/gtk1/region.h"
 227 #elif defined(__WXMOTIF__) || defined(__WXX11__)
 228     #include "wx/x11/region.h"
 229 #elif defined(__WXMGL__)
 230     #include "wx/mgl/region.h"
 231 #elif defined(__WXDFB__)
 232     #include "wx/dfb/region.h"
 233 #elif defined(__WXMAC__)
 234     #include "wx/mac/region.h"
 235 #elif defined(__WXCOCOA__)
 236     #include "wx/cocoa/region.h"
 237 #elif defined(__WXPM__)
 238     #include "wx/os2/region.h"
 239 #endif
 240
 241 // ----------------------------------------------------------------------------
 242 // inline functions implementation
 243 // ----------------------------------------------------------------------------
 244
 245 // NB: these functions couldn't be defined in the class declaration as they use
 246 //     wxRegion and so can be only defined after including the header declaring
 247 //     the real class
 248
 249 inline bool wxRegionBase::Intersect(const wxRect& rect)
 250 {
 251     return DoIntersect(wxRegion(rect));
 252 }
 253
 254 inline bool wxRegionBase::Subtract(const wxRect& rect)
 255 {
 256     return DoSubtract(wxRegion(rect));
 257 }
 258
 259 inline bool wxRegionBase::Xor(const wxRect& rect)
 260 {
 261     return DoXor(wxRegion(rect));
 262 }
 263
 264 // ...and these functions are here because they call the ones above, and its
 265 // not really proper to call an inline function before its defined inline.
 266
 267 inline bool wxRegionBase::Intersect(wxCoord x, wxCoord y, wxCoord w, wxCoord h)
 268 {
 269     return Intersect(wxRect(x, y, w, h));
 270 }
 271
 272 inline bool wxRegionBase::Subtract(wxCoord x, wxCoord y, wxCoord w, wxCoord h)
 273 {
 274     return Subtract(wxRect(x, y, w, h));
 275 }
 276
 277 inline bool wxRegionBase::Xor(wxCoord x, wxCoord y, wxCoord w, wxCoord h)
 278 {
 279     return Xor(wxRect(x, y, w, h));
 280 }
 281
 282 #ifdef wxHAS_REGION_COMBINE
 283
 284 inline bool wxRegionWithCombine::Combine(wxCoord x,
 285                                          wxCoord y,
 286                                          wxCoord w,
 287                                          wxCoord h,
 288                                          wxRegionOp op)
 289 {
 290     return DoCombine(wxRegion(x, y, w, h), op);
 291 }
 292
 293 inline bool wxRegionWithCombine::Combine(const wxRect& rect, wxRegionOp op)
 294 {
 295     return DoCombine(wxRegion(rect), op);
 296 }
 297
 298 #endif // wxHAS_REGION_COMBINE
 299
 300 #endif // _WX_REGION_H_BASE_