]> git.saurik.com Git - wxWidgets.git/blob - include/wx/msw/region.h
added wxUpdateUI generation
[wxWidgets.git] / include / wx / msw / region.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: region.h
3 // Purpose: wxRegion class
4 // Author: Markus Holzem, Julian Smart
5 // Modified by:
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef __REGIONH__
13 #define __REGIONH__
14
15 #ifdef __GNUG__
16 #pragma interface "region.h"
17 #endif
18
19 #include "wx/list.h"
20 #include "wx/gdiobj.h"
21
22 class WXDLLEXPORT wxRect;
23 class WXDLLEXPORT wxPoint;
24
25 enum wxRegionContain {
26 wxOutRegion = 0, wxPartRegion = 1, wxInRegion = 2
27 };
28
29 // So far, for internal use only
30 enum wxRegionOp {
31 wxRGN_AND, // Creates the intersection of the two combined regions.
32 wxRGN_COPY, // Creates a copy of the region identified by hrgnSrc1.
33 wxRGN_DIFF, // Combines the parts of hrgnSrc1 that are not part of hrgnSrc2.
34 wxRGN_OR, // Creates the union of two combined regions.
35 wxRGN_XOR // Creates the union of two combined regions except for any overlapping areas.
36 };
37
38 class WXDLLEXPORT wxRegion : public wxGDIObject {
39 DECLARE_DYNAMIC_CLASS(wxRegion);
40 friend class WXDLLEXPORT wxRegionIterator;
41 public:
42 wxRegion(long x, long y, long w, long h);
43 wxRegion(const wxPoint& topLeft, const wxPoint& bottomRight);
44 wxRegion(const wxRect& rect);
45
46 wxRegion(void);
47 ~wxRegion(void);
48
49 //# Copying
50 inline wxRegion(const wxRegion& r)
51 { Ref(r); }
52 inline wxRegion& operator = (const wxRegion& r)
53 { Ref(r); return (*this); }
54
55 //# Modify region
56 // Clear current region
57 void Clear(void);
58
59 // Union rectangle or region with this.
60 inline bool Union(long x, long y, long width, long height) { return Combine(x, y, width, height, wxRGN_OR); }
61 inline bool Union(const wxRect& rect) { return Combine(rect, wxRGN_OR); }
62 inline bool Union(const wxRegion& region) { return Combine(region, wxRGN_OR); }
63
64 // Intersect rectangle or region with this.
65 inline bool Intersect(long x, long y, long width, long height) { return Combine(x, y, width, height, wxRGN_AND); }
66 inline bool Intersect(const wxRect& rect) { return Combine(rect, wxRGN_AND); }
67 inline bool Intersect(const wxRegion& region) { return Combine(region, wxRGN_AND); }
68
69 // Subtract rectangle or region from this:
70 // Combines the parts of 'this' that are not part of the second region.
71 inline bool Subtract(long x, long y, long width, long height) { return Combine(x, y, width, height, wxRGN_DIFF); }
72 inline bool Subtract(const wxRect& rect) { return Combine(rect, wxRGN_DIFF); }
73 inline bool Subtract(const wxRegion& region) { return Combine(region, wxRGN_DIFF); }
74
75 // XOR: the union of two combined regions except for any overlapping areas.
76 inline bool Xor(long x, long y, long width, long height) { return Combine(x, y, width, height, wxRGN_XOR); }
77 inline bool Xor(const wxRect& rect) { return Combine(rect, wxRGN_XOR); }
78 inline bool Xor(const wxRegion& region) { return Combine(region, wxRGN_XOR); }
79
80 //# Information on region
81 // Outer bounds of region
82 void GetBox(long& x, long& y, long&w, long &h) const;
83 wxRect GetBox(void) const ;
84
85 // Is region empty?
86 bool Empty(void) const;
87 inline bool IsEmpty(void) const { return Empty(); }
88
89 //# Tests
90 // Does the region contain the point (x,y)?
91 wxRegionContain Contains(long x, long y) const;
92 // Does the region contain the point pt?
93 wxRegionContain Contains(const wxPoint& pt) const;
94 // Does the region contain the rectangle (x, y, w, h)?
95 wxRegionContain Contains(long x, long y, long w, long h) const;
96 // Does the region contain the rectangle rect?
97 wxRegionContain Contains(const wxRect& rect) const;
98
99 // Internal
100 bool Combine(long x, long y, long width, long height, wxRegionOp op);
101 bool Combine(const wxRegion& region, wxRegionOp op);
102 bool Combine(const wxRect& rect, wxRegionOp op);
103 };
104
105 class WXDLLEXPORT wxRegionIterator : public wxObject {
106 DECLARE_DYNAMIC_CLASS(wxRegionIterator);
107 public:
108 wxRegionIterator(void);
109 wxRegionIterator(const wxRegion& region);
110 ~wxRegionIterator(void);
111
112 void Reset(void) { m_current = 0; }
113 void Reset(const wxRegion& region);
114
115 operator bool (void) const { return m_current < m_numRects; }
116 bool HaveRects(void) const { return m_current < m_numRects; }
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
128 private:
129 long m_current;
130 long m_numRects;
131 wxRegion m_region;
132 wxRect* m_rects;
133 };
134
135 #endif
136 // __REGIONH__