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, wxPartRegion = 1, wxInRegion = 2
  34 };
  35
  36 // So far, for internal use only
  37 enum wxRegionOp {
  38 wxRGN_AND,          // Creates the intersection of the two combined regions.
  39 wxRGN_COPY,         // Creates a copy of the region identified by hrgnSrc1.
  40 wxRGN_DIFF,         // Combines the parts of hrgnSrc1 that are not part of hrgnSrc2.
  41 wxRGN_OR,           // Creates the union of two combined regions.
  42 wxRGN_XOR           // Creates the union of two combined regions except for any overlapping areas.
  43 };
  44
  45 //-----------------------------------------------------------------------------
  46 // wxRegion
  47 //-----------------------------------------------------------------------------
  48
  49 class wxRegion : public wxGDIObject
  50 {
  51   DECLARE_DYNAMIC_CLASS(wxRegion);
  52
  53   public:
  54
  55     wxRegion( wxCoord x, wxCoord y, wxCoord w, wxCoord h );
  56     wxRegion( const wxPoint& topLeft, const wxPoint& bottomRight );
  57     wxRegion( const wxRect& rect );
  58     wxRegion();
  59     ~wxRegion();
  60
  61     inline wxRegion( const wxRegion& r ): wxGDIObject()
  62       { Ref(r); }
  63     inline wxRegion& operator = ( const wxRegion& r )
  64       { Ref(r); return (*this); }
  65
  66     bool operator == ( const wxRegion& region );
  67     bool operator != ( const wxRegion& region );
  68
  69     void Clear();
  70
  71     bool Union( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
  72     bool Union( const wxRect& rect );
  73     bool Union( const wxRegion& region );
  74
  75     bool Intersect( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
  76     bool Intersect( const wxRect& rect );
  77     bool Intersect( const wxRegion& region );
  78
  79     bool Subtract( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
  80     bool Subtract( const wxRect& rect );
  81     bool Subtract( const wxRegion& region );
  82
  83     bool Xor( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
  84     bool Xor( const wxRect& rect );
  85     bool Xor( const wxRegion& region );
  86
  87     void GetBox( wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h ) const;
  88     wxRect GetBox() const ;
  89
  90     bool Empty() const;
  91     bool IsEmpty() const { return Empty(); }
  92
  93     wxRegionContain Contains( wxCoord x, wxCoord y ) const;
  94     wxRegionContain Contains( wxCoord x, wxCoord y, wxCoord w, wxCoord h ) const;
  95     wxRegionContain Contains(const wxPoint& pt) const;
  96     wxRegionContain Contains(const wxRect& rect) const;
  97
  98   public:
  99
 100     wxList    *GetRectList() const;
 101     GdkRegion *GetRegion() const;
 102 };
 103
 104 class wxRegionIterator: public wxObject
 105 {
 106 public:
 107     wxRegionIterator();
 108     wxRegionIterator(const wxRegion& region);
 109
 110     void Reset() { m_current = 0u; }
 111     void Reset(const wxRegion& region);
 112
 113     operator bool () const;
 114     bool HaveRects() const;
 115
 116     void operator ++ ();
 117     void operator ++ (int);
 118
 119     wxCoord GetX() const;
 120     wxCoord GetY() const;
 121     wxCoord GetW() const;
 122     wxCoord GetWidth() const { return GetW(); }
 123     wxCoord GetH() const;
 124     wxCoord GetHeight() const { return GetH(); }
 125     wxRect GetRect() const { return wxRect(GetX(), GetY(), GetWidth(), GetHeight()); }
 126
 127 private:
 128     size_t   m_current;
 129     wxRegion m_region;
 130
 131 private:
 132     DECLARE_DYNAMIC_CLASS(wxRegionIterator);
 133 };
 134
 135
 136 #endif
 137         // _WX_GTK_REGION_H_