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 #ifdef __GNUG__
  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     virtual ~wxRegion();
  75
  76     wxRegion( const wxRegion& r ) { Ref(r); }
  77     wxRegion& operator = ( const wxRegion& r ) { Ref(r); return *this; }
  78
  79     bool operator == ( const wxRegion& region );
  80     bool operator != ( const wxRegion& region );
  81
  82     void Clear();
  83
  84     bool Offset( wxCoord x, wxCoord y );
  85
  86     bool Union( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
  87     bool Union( const wxRect& rect );
  88     bool Union( const wxRegion& region );
  89
  90     bool Intersect( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
  91     bool Intersect( const wxRect& rect );
  92     bool Intersect( const wxRegion& region );
  93
  94     bool Subtract( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
  95     bool Subtract( const wxRect& rect );
  96     bool Subtract( const wxRegion& region );
  97
  98     bool Xor( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
  99     bool Xor( const wxRect& rect );
 100     bool Xor( const wxRegion& region );
 101
 102     void GetBox( wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h ) const;
 103     wxRect GetBox() const ;
 104
 105     bool Empty() const;
 106     bool IsEmpty() const { return Empty(); }
 107
 108     wxRegionContain Contains( wxCoord x, wxCoord y ) const;
 109     wxRegionContain Contains( wxCoord x, wxCoord y, wxCoord w, wxCoord h ) const;
 110     wxRegionContain Contains(const wxPoint& pt) const;
 111     wxRegionContain Contains(const wxRect& rect) const;
 112
 113 public:
 114     wxList    *GetRectList() const;
 115     GdkRegion *GetRegion() const;
 116
 117 protected:
 118     // common part of ctors for a rectangle region
 119     void InitRect(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
 120
 121     // helper of Intersect()
 122     bool IntersectRegionOnly(const wxRegion& reg);
 123
 124 private:
 125     DECLARE_DYNAMIC_CLASS(wxRegion);
 126 };
 127
 128 // ----------------------------------------------------------------------------
 129 // wxRegionIterator: decomposes a region into rectangles
 130 // ----------------------------------------------------------------------------
 131
 132 class wxRegionIterator: public wxObject
 133 {
 134 public:
 135     wxRegionIterator();
 136     wxRegionIterator(const wxRegion& region);
 137
 138     void Reset() { m_current = 0u; }
 139     void Reset(const wxRegion& region);
 140
 141     operator bool () const;
 142     bool HaveRects() const;
 143
 144     void operator ++ ();
 145     void operator ++ (int);
 146
 147     wxCoord GetX() const;
 148     wxCoord GetY() const;
 149     wxCoord GetW() const;
 150     wxCoord GetWidth() const { return GetW(); }
 151     wxCoord GetH() const;
 152     wxCoord GetHeight() const { return GetH(); }
 153     wxRect GetRect() const;
 154
 155 private:
 156     size_t   m_current;
 157     wxRegion m_region;
 158
 159 private:
 160     DECLARE_DYNAMIC_CLASS(wxRegionIterator);
 161 };
 162
 163
 164 #endif
 165         // _WX_GTK_REGION_H_