include/wx/gtk1/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               const wxColour& transColour = wxNullColour,
  77               int   tolerance = 0)
  78     {
  79         Union(bmp, transColour, tolerance);
  80     }
  81
  82     ~wxRegion();
  83
  84     wxRegion( const wxRegion& region )
  85         : wxGDIObject()
  86         { 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     // Init with GdkRegion, set ref count to 2 so that
 140     // the C++ class will not destroy the region!
 141     wxRegion( GdkRegion *region );
 142
 143     GdkRegion *GetRegion() const;
 144
 145 protected:
 146     // ref counting code
 147     virtual wxObjectRefData *CreateRefData() const;
 148     virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
 149
 150     // common part of ctors for a rectangle region
 151     void InitRect(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
 152
 153 private:
 154     DECLARE_DYNAMIC_CLASS(wxRegion);
 155 };
 156
 157 // ----------------------------------------------------------------------------
 158 // wxRegionIterator: decomposes a region into rectangles
 159 // ----------------------------------------------------------------------------
 160
 161 class wxRegionIterator: public wxObject
 162 {
 163 public:
 164     wxRegionIterator();
 165     wxRegionIterator(const wxRegion& region);
 166
 167     void Reset() { m_current = 0u; }
 168     void Reset(const wxRegion& region);
 169
 170     bool HaveRects() const;
 171     operator bool () const { return HaveRects(); }
 172
 173     wxRegionIterator& operator ++ ();
 174     wxRegionIterator operator ++ (int);
 175
 176     wxCoord GetX() const;
 177     wxCoord GetY() const;
 178     wxCoord GetW() const;
 179     wxCoord GetWidth() const { return GetW(); }
 180     wxCoord GetH() const;
 181     wxCoord GetHeight() const { return GetH(); }
 182     wxRect GetRect() const;
 183
 184 private:
 185     size_t   m_current;
 186     wxRegion m_region;
 187
 188 private:
 189     DECLARE_DYNAMIC_CLASS(wxRegionIterator);
 190 };
 191
 192
 193 #endif
 194         // _WX_GTK_REGION_H_