include/wx/gtk/region.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 __REGIONH__
  11 #define __REGIONH__
  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( long x, long y, long w, long h );
  56     wxRegion( const wxPoint& topLeft, const wxPoint& bottomRight );
  57     wxRegion( const wxRect& rect );
  58     wxRegion(void);
  59     ~wxRegion(void);
  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(void);
  70
  71     bool Union( long x, long y, long width, long height );
  72     bool Union( const wxRect& rect );
  73     bool Union( const wxRegion& region );
  74
  75     bool Intersect( long x, long y, long width, long height );
  76     bool Intersect( const wxRect& rect );
  77     bool Intersect( const wxRegion& region );
  78
  79     bool Subtract( long x, long y, long width, long height );
  80     bool Subtract( const wxRect& rect );
  81     bool Subtract( const wxRegion& region );
  82
  83     bool Xor( long x, long y, long width, long height );
  84     bool Xor( const wxRect& rect );
  85     bool Xor( const wxRegion& region );
  86
  87     void GetBox( long& x, long& y, long&w, long &h ) const;
  88     wxRect GetBox(void) const ;
  89
  90     bool Empty(void) const;
  91
  92     wxRegionContain Contains( long x, long y ) const;
  93     wxRegionContain Contains( long x, long y, long w, long h ) const;
  94     wxRegionContain Contains(const wxPoint& pt) const;
  95     wxRegionContain Contains(const wxRect& rect) const;
  96
  97   public:
  98
  99     wxList    *GetRectList() const;
 100     GdkRegion *GetRegion(void) const;
 101 };
 102
 103 class wxRegionIterator: public wxObject
 104 {
 105   DECLARE_DYNAMIC_CLASS(wxRegionIterator);
 106
 107   public:
 108
 109     wxRegionIterator(void);
 110     wxRegionIterator(const wxRegion& region);
 111
 112     void Reset(void) { m_current = 0; }
 113     void Reset(const wxRegion& region);
 114
 115     operator bool (void) const;
 116     bool HaveRects(void) const;
 117
 118     void operator ++ (void);
 119     void operator ++ (int);
 120
 121     long GetX(void) const;
 122     long GetY(void) const;
 123     long GetW(void) const;
 124     long GetWidth(void) const { return GetW(); }
 125     long GetH(void) const;
 126     long GetHeight(void) const { return GetH(); }
 127     wxRect GetRect() const { return wxRect(GetX(), GetY(), GetWidth(), GetHeight()); }
 128
 129   private:
 130
 131    long       m_current;
 132    wxRegion   m_region;
 133 };
 134
 135
 136 #endif
 137         // __REGIONH__