include/wx/motif/region.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        region.h
   3 // Purpose:     wxRegion class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     17/09/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   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 // ----------------------------------------------------------------------------
  24 // A list of rectangles type used by wxRegion and wxWindow
  25 // ----------------------------------------------------------------------------
  26
  27 WX_DECLARE_LIST(wxRect, wxRectList);
  28
  29
  30 enum wxRegionContain {
  31     wxOutRegion = 0, wxPartRegion = 1, wxInRegion = 2
  32 };
  33
  34 // So far, for internal use only
  35 enum wxRegionOp {
  36     wxRGN_AND,          // Creates the intersection of the two combined regions.
  37         wxRGN_COPY,         // Creates a copy of the region identified by hrgnSrc1.
  38         wxRGN_DIFF,         // Combines the parts of hrgnSrc1 that are not part of hrgnSrc2.
  39         wxRGN_OR,           // Creates the union of two combined regions.
  40         wxRGN_XOR           // Creates the union of two combined regions except for any overlapping areas.
  41 };
  42
  43 class WXDLLEXPORT wxRegion : public wxGDIObject {
  44     DECLARE_DYNAMIC_CLASS(wxRegion)
  45         friend class WXDLLEXPORT wxRegionIterator;
  46 public:
  47     wxRegion(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
  48     wxRegion(const wxPoint& topLeft, const wxPoint& bottomRight);
  49     wxRegion(const wxRect& rect);
  50     wxRegion();
  51     wxRegion( const wxBitmap& bmp,
  52               const wxColour& transColour = wxNullColour,
  53               int   tolerance = 0)
  54     {
  55         Union(bmp, transColour, tolerance);
  56     }
  57     ~wxRegion();
  58
  59     //# Copying
  60     inline wxRegion(const wxRegion& r)
  61     { Ref(r); }
  62     inline wxRegion& operator = (const wxRegion& r)
  63     { Ref(r); return (*this); }
  64
  65     //# Modify region
  66     // Clear current region
  67     void Clear();
  68
  69     // Union rectangle or region with this.
  70     inline bool Union(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_OR); }
  71     inline bool Union(const wxRect& rect) { return Combine(rect, wxRGN_OR); }
  72     inline bool Union(const wxRegion& region) { return Combine(region, wxRGN_OR); }
  73
  74     // Intersect rectangle or region with this.
  75     inline bool Intersect(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_AND); }
  76     inline bool Intersect(const wxRect& rect)  { return Combine(rect, wxRGN_AND); }
  77     inline bool Intersect(const wxRegion& region)  { return Combine(region, wxRGN_AND); }
  78
  79     // Subtract rectangle or region from this:
  80     // Combines the parts of 'this' that are not part of the second region.
  81     inline bool Subtract(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_DIFF); }
  82     inline bool Subtract(const wxRect& rect)  { return Combine(rect, wxRGN_DIFF); }
  83     inline bool Subtract(const wxRegion& region)  { return Combine(region, wxRGN_DIFF); }
  84
  85     // XOR: the union of two combined regions except for any overlapping areas.
  86     inline bool Xor(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_XOR); }
  87     inline bool Xor(const wxRect& rect)  { return Combine(rect, wxRGN_XOR); }
  88     inline bool Xor(const wxRegion& region)  { return Combine(region, wxRGN_XOR); }
  89
  90     //# Information on region
  91     // Outer bounds of region
  92     void GetBox(wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h) const;
  93     wxRect GetBox() const ;
  94
  95     // Is region empty?
  96     bool Empty() const;
  97     inline bool IsEmpty() const { return Empty(); }
  98     bool Ok() const { return (m_refData != NULL) ; }
  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.  If the bitmap has a mask then it will be used,
 116     // otherwise the colour to be treated as transparent may be specified,
 117     // along with an optional tolerance value.
 118     bool Union(const wxBitmap& bmp,
 119                const wxColour& transColour = wxNullColour,
 120                int   tolerance = 0);
 121
 122     // Internal
 123     bool Combine(wxCoord x, wxCoord y, wxCoord width, wxCoord height, wxRegionOp op);
 124     bool Combine(const wxRegion& region, wxRegionOp op);
 125     bool Combine(const wxRect& rect, wxRegionOp op);
 126
 127     // Get the internal Region handle
 128     WXRegion GetXRegion() const;
 129
 130     // 'Naughty' functions that allow wxWindows to use a list of rects
 131     // instead of the region, in certain circumstances (e.g. when
 132     // making a region out of the update rectangles).
 133     // These are used by wxPaintDC::wxPaintDC and wxRegionIterator::Reset.
 134     bool UsingRects() const;
 135     wxRect* GetRects();
 136     int GetRectCount() const;
 137     void SetRects(const wxRectList& rectList);
 138     void SetRects(int count, const wxRect* rects);
 139 };
 140
 141 class WXDLLEXPORT wxRegionIterator : public wxObject {
 142     DECLARE_DYNAMIC_CLASS(wxRegionIterator)
 143 public:
 144     wxRegionIterator();
 145     wxRegionIterator(const wxRegion& region);
 146     ~wxRegionIterator();
 147
 148     void Reset() { m_current = 0; }
 149     void Reset(const wxRegion& region);
 150
 151     operator bool () const { return m_current < m_numRects; }
 152     bool HaveRects() const { return m_current < m_numRects; }
 153
 154     void operator ++ ();
 155     void operator ++ (int);
 156
 157     wxCoord GetX() const;
 158     wxCoord GetY() const;
 159     wxCoord GetW() const;
 160     wxCoord GetWidth() const { return GetW(); }
 161     wxCoord GetH() const;
 162     wxCoord GetHeight() const { return GetH(); }
 163     wxRect GetRect() const { return wxRect(GetX(), GetY(), GetWidth(), GetHeight()); }
 164
 165 private:
 166     size_t       m_current;
 167     size_t       m_numRects;
 168     wxRegion m_region;
 169     wxRect*  m_rects;
 170 };
 171
 172 #endif
 173 // _WX_REGION_H_