]> git.saurik.com Git - wxWidgets.git/blob - include/wx/gtk1/region.h
Clarify documentation for wxPropertyGridEvent::GetProperty()
[wxWidgets.git] / include / wx / gtk1 / region.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/gtk1/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 #include "wx/list.h"
14
15 // ----------------------------------------------------------------------------
16 // wxRegion
17 // ----------------------------------------------------------------------------
18
19 class WXDLLIMPEXP_CORE wxRegion : public wxRegionBase
20 {
21 public:
22 wxRegion() { }
23
24 wxRegion( wxCoord x, wxCoord y, wxCoord w, wxCoord h )
25 {
26 InitRect(x, y, w, h);
27 }
28
29 wxRegion( const wxPoint& topLeft, const wxPoint& bottomRight )
30 {
31 InitRect(topLeft.x, topLeft.y,
32 bottomRight.x - topLeft.x, bottomRight.y - topLeft.y);
33 }
34
35 wxRegion( const wxRect& rect )
36 {
37 InitRect(rect.x, rect.y, rect.width, rect.height);
38 }
39
40 wxRegion( size_t n, const wxPoint *points, wxPolygonFillMode fillStyle = wxODDEVEN_RULE );
41
42 wxRegion( const wxBitmap& bmp)
43 {
44 Union(bmp);
45 }
46 wxRegion( const wxBitmap& bmp,
47 const wxColour& transColour, int tolerance = 0)
48 {
49 Union(bmp, transColour, tolerance);
50 }
51
52 virtual ~wxRegion();
53
54 // wxRegionBase methods
55 virtual void Clear();
56 virtual bool IsEmpty() const;
57
58 public:
59 // Init with GdkRegion, set ref count to 2 so that
60 // the C++ class will not destroy the region!
61 wxRegion( GdkRegion *region );
62
63 GdkRegion *GetRegion() const;
64
65 protected:
66 virtual wxGDIRefData *CreateGDIRefData() const;
67 virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
68
69 // wxRegionBase pure virtuals
70 virtual bool DoIsEqual(const wxRegion& region) const;
71 virtual bool DoGetBox(wxCoord& x, wxCoord& y, wxCoord& w, wxCoord& h) const;
72 virtual wxRegionContain DoContainsPoint(wxCoord x, wxCoord y) const;
73 virtual wxRegionContain DoContainsRect(const wxRect& rect) const;
74
75 virtual bool DoOffset(wxCoord x, wxCoord y);
76 virtual bool DoUnionWithRect(const wxRect& rect);
77 virtual bool DoUnionWithRegion(const wxRegion& region);
78 virtual bool DoIntersect(const wxRegion& region);
79 virtual bool DoSubtract(const wxRegion& region);
80 virtual bool DoXor(const wxRegion& region);
81
82 // common part of ctors for a rectangle region
83 void InitRect(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
84
85 private:
86 DECLARE_DYNAMIC_CLASS(wxRegion)
87 };
88
89 // ----------------------------------------------------------------------------
90 // wxRegionIterator: decomposes a region into rectangles
91 // ----------------------------------------------------------------------------
92
93 class WXDLLIMPEXP_CORE wxRegionIterator: public wxObject
94 {
95 public:
96 wxRegionIterator();
97 wxRegionIterator(const wxRegion& region);
98
99 void Reset() { m_current = 0u; }
100 void Reset(const wxRegion& region);
101
102 bool HaveRects() const;
103 operator bool () const { return HaveRects(); }
104
105 wxRegionIterator& operator ++ ();
106 wxRegionIterator operator ++ (int);
107
108 wxCoord GetX() const;
109 wxCoord GetY() const;
110 wxCoord GetW() const;
111 wxCoord GetWidth() const { return GetW(); }
112 wxCoord GetH() const;
113 wxCoord GetHeight() const { return GetH(); }
114 wxRect GetRect() const;
115
116 private:
117 size_t m_current;
118 wxRegion m_region;
119
120 private:
121 DECLARE_DYNAMIC_CLASS(wxRegionIterator)
122 };
123
124
125 #endif
126 // _WX_GTK_REGION_H_