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