include/wx/x11/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, Robert Roebling
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_REGION_H_
  13 #define _WX_REGION_H_
  14
  15 #if defined(__GNUG__) && !defined(__APPLE__)
  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 // classes
  25 //-----------------------------------------------------------------------------
  26
  27 class wxRegion;
  28
  29 //-----------------------------------------------------------------------------
  30 // constants
  31 //-----------------------------------------------------------------------------
  32
  33 enum wxRegionContain
  34 {
  35     wxOutRegion = 0,
  36     wxPartRegion = 1,
  37     wxInRegion = 2
  38 };
  39
  40 // So far, for internal use only
  41 enum wxRegionOp
  42 {
  43    wxRGN_AND,          // Creates the intersection of the two combined regions.
  44    wxRGN_COPY,         // Creates a copy of the region identified by hrgnSrc1.
  45    wxRGN_DIFF,         // Combines the parts of hrgnSrc1 that are not part of hrgnSrc2.
  46    wxRGN_OR,           // Creates the union of two combined regions.
  47    wxRGN_XOR           // Creates the union of two combined regions except for any overlapping areas.
  48 };
  49
  50 // ----------------------------------------------------------------------------
  51 // wxRegion
  52 // ----------------------------------------------------------------------------
  53
  54 class wxRegion : public wxGDIObject
  55 {
  56 public:
  57     wxRegion() { }
  58
  59     wxRegion( wxCoord x, wxCoord y, wxCoord w, wxCoord h )
  60     {
  61         InitRect(x, y, w, h);
  62     }
  63
  64     wxRegion( const wxPoint& topLeft, const wxPoint& bottomRight )
  65     {
  66         InitRect(topLeft.x, topLeft.y,
  67                  bottomRight.x - topLeft.x, bottomRight.y - topLeft.y);
  68     }
  69
  70     wxRegion( const wxRect& rect )
  71     {
  72         InitRect(rect.x, rect.y, rect.width, rect.height);
  73     }
  74
  75     wxRegion( size_t n, const wxPoint *points, int fillStyle = wxODDEVEN_RULE );
  76
  77     wxRegion( const wxBitmap& bmp,
  78               const wxColour& transColour = wxNullColour,
  79               int   tolerance = 0)
  80     {
  81         Union(bmp, transColour, tolerance);
  82     }
  83
  84     ~wxRegion();
  85
  86     wxRegion( const wxRegion& region ) { Ref(region); }
  87     wxRegion& operator = ( const wxRegion& region ) { Ref(region); return *this; }
  88
  89     bool Ok() const { return m_refData != NULL; }
  90
  91     bool operator == ( const wxRegion& region );
  92     bool operator != ( const wxRegion& region ) { return !(*this == region); }
  93
  94     void Clear();
  95
  96     bool Offset( wxCoord x, wxCoord y );
  97
  98     bool Union( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
  99     bool Union( const wxRect& rect );
 100     bool Union( const wxRegion& region );
 101
 102     bool Intersect( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
 103     bool Intersect( const wxRect& rect );
 104     bool Intersect( const wxRegion& region );
 105
 106     bool Subtract( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
 107     bool Subtract( const wxRect& rect );
 108     bool Subtract( const wxRegion& region );
 109
 110     bool Xor( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
 111     bool Xor( const wxRect& rect );
 112     bool Xor( const wxRegion& region );
 113
 114     void GetBox( wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h ) const;
 115     wxRect GetBox() const ;
 116
 117     bool Empty() const;
 118     bool IsEmpty() const { return Empty(); }
 119
 120     wxRegionContain Contains( wxCoord x, wxCoord y ) const;
 121     wxRegionContain Contains( wxCoord x, wxCoord y, wxCoord w, wxCoord h ) const;
 122     wxRegionContain Contains(const wxPoint& pt) const;
 123     wxRegionContain Contains(const wxRect& rect) const;
 124
 125     // Convert the region to a B&W bitmap with the white pixels being inside
 126     // the region.
 127     wxBitmap ConvertToBitmap() const;
 128
 129     // Use the non-transparent pixels of a wxBitmap for the region to combine
 130     // with this region.  If the bitmap has a mask then it will be used,
 131     // otherwise the colour to be treated as transparent may be specified,
 132     // along with an optional tolerance value.
 133     bool Union(const wxBitmap& bmp,
 134                const wxColour& transColour = wxNullColour,
 135                int   tolerance = 0);
 136
 137
 138 public:
 139     WXRegion *GetX11Region() const;
 140
 141 protected:
 142     // ref counting code
 143     virtual wxObjectRefData *CreateRefData() const;
 144     virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
 145
 146     // common part of ctors for a rectangle region
 147     void InitRect(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
 148
 149 private:
 150     DECLARE_DYNAMIC_CLASS(wxRegion);
 151 };
 152
 153 // ----------------------------------------------------------------------------
 154 // wxRegionIterator: decomposes a region into rectangles
 155 // ----------------------------------------------------------------------------
 156
 157 class wxRegionIterator: public wxObject
 158 {
 159 public:
 160     wxRegionIterator();
 161     wxRegionIterator(const wxRegion& region);
 162
 163     void Reset() { m_current = 0u; }
 164     void Reset(const wxRegion& region);
 165
 166     operator bool () const;
 167     bool HaveRects() const;
 168
 169     void operator ++ ();
 170     void operator ++ (int);
 171
 172     wxCoord GetX() const;
 173     wxCoord GetY() const;
 174     wxCoord GetW() const;
 175     wxCoord GetWidth() const { return GetW(); }
 176     wxCoord GetH() const;
 177     wxCoord GetHeight() const { return GetH(); }
 178     wxRect GetRect() const;
 179
 180 private:
 181     size_t   m_current;
 182     wxRegion m_region;
 183
 184 private:
 185     DECLARE_DYNAMIC_CLASS(wxRegionIterator);
 186 };
 187
 188 #endif
 189 // _WX_REGION_H_