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 #include "wx/list.h"
  14 #include "wx/gdiobj.h"
  15 #include "wx/gdicmn.h"
  16
  17 //-----------------------------------------------------------------------------
  18 // classes
  19 //-----------------------------------------------------------------------------
  20
  21 class WXDLLIMPEXP_CORE wxRegion;
  22
  23 //-----------------------------------------------------------------------------
  24 // constants
  25 //-----------------------------------------------------------------------------
  26
  27 enum wxRegionContain
  28 {
  29     wxOutRegion = 0,
  30     wxPartRegion = 1,
  31     wxInRegion = 2
  32 };
  33
  34 // So far, for internal use only
  35 enum wxRegionOp
  36 {
  37    wxRGN_AND,          // Creates the intersection of the two combined regions.
  38    wxRGN_COPY,         // Creates a copy of the region identified by hrgnSrc1.
  39    wxRGN_DIFF,         // Combines the parts of hrgnSrc1 that are not part of hrgnSrc2.
  40    wxRGN_OR,           // Creates the union of two combined regions.
  41    wxRGN_XOR           // Creates the union of two combined regions except for any overlapping areas.
  42 };
  43
  44 // ----------------------------------------------------------------------------
  45 // wxRegion
  46 // ----------------------------------------------------------------------------
  47
  48 class WXDLLIMPEXP_CORE wxRegion : public wxGDIObject
  49 {
  50 public:
  51     wxRegion() { }
  52
  53     wxRegion( wxCoord x, wxCoord y, wxCoord w, wxCoord h )
  54     {
  55         InitRect(x, y, w, h);
  56     }
  57
  58     wxRegion( const wxPoint& topLeft, const wxPoint& bottomRight )
  59     {
  60         InitRect(topLeft.x, topLeft.y,
  61                  bottomRight.x - topLeft.x, bottomRight.y - topLeft.y);
  62     }
  63
  64     wxRegion( const wxRect& rect )
  65     {
  66         InitRect(rect.x, rect.y, rect.width, rect.height);
  67     }
  68
  69     wxRegion( size_t n, const wxPoint *points, int fillStyle = wxODDEVEN_RULE );
  70
  71     wxRegion( const wxBitmap& bmp)
  72     {
  73         Union(bmp);
  74     }
  75     wxRegion( const wxBitmap& bmp,
  76               const wxColour& transColour, int tolerance = 0)
  77     {
  78         Union(bmp, transColour, tolerance);
  79     }
  80
  81     ~wxRegion();
  82
  83     wxRegion( const wxRegion& region )
  84         : wxGDIObject()
  85         { Ref(region); }
  86     wxRegion& operator = ( const wxRegion& region ) { Ref(region); return *this; }
  87
  88     bool Ok() const { return m_refData != NULL; }
  89
  90     bool operator == ( const wxRegion& region ) const;
  91     bool operator != ( const wxRegion& region ) const { return !(*this == region); }
  92
  93     void Clear();
  94
  95     bool Offset( wxCoord x, wxCoord y );
  96
  97     bool Union( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
  98     bool Union( const wxRect& rect );
  99     bool Union( const wxRegion& region );
 100
 101     bool Intersect( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
 102     bool Intersect( const wxRect& rect );
 103     bool Intersect( const wxRegion& region );
 104
 105     bool Subtract( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
 106     bool Subtract( const wxRect& rect );
 107     bool Subtract( const wxRegion& region );
 108
 109     bool Xor( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
 110     bool Xor( const wxRect& rect );
 111     bool Xor( const wxRegion& region );
 112
 113     void GetBox( wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h ) const;
 114     wxRect GetBox() const ;
 115
 116     bool Empty() const;
 117     bool IsEmpty() const { return Empty(); }
 118
 119     wxRegionContain Contains( wxCoord x, wxCoord y ) const;
 120     wxRegionContain Contains( wxCoord x, wxCoord y, wxCoord w, wxCoord h ) const;
 121     wxRegionContain Contains(const wxPoint& pt) const;
 122     wxRegionContain Contains(const wxRect& rect) const;
 123
 124     // Convert the region to a B&W bitmap with the white pixels being inside
 125     // the region.
 126     wxBitmap ConvertToBitmap() const;
 127
 128     // Use the non-transparent pixels of a wxBitmap for the region to combine
 129     // with this region.  First version takes transparency from bitmap's mask,
 130     // second lets the user specify the colour to be treated as transparent
 131     // along with an optional tolerance value.
 132     // NOTE: implemented in common/rgncmn.cpp
 133     bool Union(const wxBitmap& bmp);
 134     bool Union(const wxBitmap& bmp,
 135                const wxColour& transColour, 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 WXDLLIMPEXP_CORE 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_