include/wx/gtk/region.h

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