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