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     wxRegion( wxCoord x, wxCoord y, wxCoord w, wxCoord h );
  57     wxRegion( const wxPoint& topLeft, const wxPoint& bottomRight );
  58     wxRegion( const wxRect& rect );
  59     wxRegion(size_t n, const wxPoint *points, int fillStyle = wxODDEVEN_RULE );
  60     virtual ~wxRegion();
  61
  62     wxRegion( const wxRegion& r ) { Ref(r); }
  63     wxRegion& operator = ( const wxRegion& r ) { Ref(r); return *this; }
  64
  65     bool operator == ( const wxRegion& region );
  66     bool operator != ( const wxRegion& region );
  67
  68     void Clear();
  69
  70     bool Union( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
  71     bool Union( const wxRect& rect );
  72     bool Union( const wxRegion& region );
  73
  74     bool Intersect( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
  75     bool Intersect( const wxRect& rect );
  76     bool Intersect( const wxRegion& region );
  77
  78     bool Subtract( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
  79     bool Subtract( const wxRect& rect );
  80     bool Subtract( const wxRegion& region );
  81
  82     bool Xor( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
  83     bool Xor( const wxRect& rect );
  84     bool Xor( const wxRegion& region );
  85
  86     void GetBox( wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h ) const;
  87     wxRect GetBox() const ;
  88
  89     bool Empty() const;
  90     bool IsEmpty() const { return Empty(); }
  91
  92     wxRegionContain Contains( wxCoord x, wxCoord y ) const;
  93     wxRegionContain Contains( wxCoord x, wxCoord y, wxCoord w, wxCoord h ) const;
  94     wxRegionContain Contains(const wxPoint& pt) const;
  95     wxRegionContain Contains(const wxRect& rect) const;
  96
  97 public:
  98     wxList    *GetRectList() const;
  99     GdkRegion *GetRegion() const;
 100
 101 protected:
 102     // helper of Intersect()
 103     bool IntersectRegionOnly(const wxRegion& reg);
 104
 105     // call this before modifying the region
 106     void Unshare();
 107
 108 private:
 109     DECLARE_DYNAMIC_CLASS(wxRegion);
 110 };
 111
 112 // ----------------------------------------------------------------------------
 113 // wxRegionIterator: decomposes a region into rectangles
 114 // ----------------------------------------------------------------------------
 115
 116 class wxRegionIterator: public wxObject
 117 {
 118 public:
 119     wxRegionIterator();
 120     wxRegionIterator(const wxRegion& region);
 121
 122     void Reset() { m_current = 0u; }
 123     void Reset(const wxRegion& region);
 124
 125     operator bool () const;
 126     bool HaveRects() const;
 127
 128     void operator ++ ();
 129     void operator ++ (int);
 130
 131     wxCoord GetX() const;
 132     wxCoord GetY() const;
 133     wxCoord GetW() const;
 134     wxCoord GetWidth() const { return GetW(); }
 135     wxCoord GetH() const;
 136     wxCoord GetHeight() const { return GetH(); }
 137     wxRect GetRect() const;
 138
 139 private:
 140     size_t   m_current;
 141     wxRegion m_region;
 142
 143 private:
 144     DECLARE_DYNAMIC_CLASS(wxRegionIterator);
 145 };
 146
 147
 148 #endif
 149         // _WX_GTK_REGION_H_