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