]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/region.h
implemented wxDC::DoGetSize() correctly for metafile DC classes
[wxWidgets.git] / include / wx / msw / region.h
CommitLineData
2bda0e17 1/////////////////////////////////////////////////////////////////////////////
5549e9f7 2// Name: wx/msw/region.h
2bda0e17 3// Purpose: wxRegion class
371a5b4e 4// Author: Julian Smart
2bda0e17
KB
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
77ffb593 8// Copyright: (c) 1997-2002 wxWidgets team
65571936 9// Licence: wxWindows licence
2bda0e17
KB
10/////////////////////////////////////////////////////////////////////////////
11
bbcdf8bc
JS
12#ifndef _WX_REGION_H_
13#define _WX_REGION_H_
2bda0e17 14
2bda0e17 15#include "wx/gdiobj.h"
2432b92d 16#include "wx/gdicmn.h"
2bda0e17
KB
17
18class WXDLLEXPORT wxRect;
19class WXDLLEXPORT wxPoint;
20
5549e9f7
VZ
21enum wxRegionContain
22{
23 wxOutRegion = 0,
24 wxPartRegion = 1,
25 wxInRegion = 2
2bda0e17
KB
26};
27
28// So far, for internal use only
5549e9f7
VZ
29enum wxRegionOp
30{
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.
2bda0e17
KB
36};
37
5549e9f7
VZ
38class WXDLLEXPORT wxRegion : public wxGDIObject
39{
2bda0e17 40public:
5549e9f7 41 wxRegion();
9b1801c1 42 wxRegion(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
2bda0e17
KB
43 wxRegion(const wxPoint& topLeft, const wxPoint& bottomRight);
44 wxRegion(const wxRect& rect);
81d66cf3 45 wxRegion(WXHRGN hRegion); // Hangs on to this region
5549e9f7 46 wxRegion(size_t n, const wxPoint *points, int fillStyle = wxODDEVEN_RULE );
85f6b408
VS
47 wxRegion( const wxBitmap& bmp)
48 {
49 Union(bmp);
50 }
1542ea39 51 wxRegion( const wxBitmap& bmp,
85f6b408 52 const wxColour& transColour, int tolerance = 0)
1542ea39
RD
53 {
54 Union(bmp, transColour, tolerance);
55 }
2bda0e17 56
5549e9f7 57 virtual ~wxRegion();
2bda0e17 58
5549e9f7 59 // Copying
4dddb8a2 60 wxRegion(const wxRegion& r) : wxGDIObject(r)
5549e9f7
VZ
61 { Ref(r); }
62 wxRegion& operator = (const wxRegion& r)
63 { Ref(r); return (*this); }
2bda0e17 64
5549e9f7 65 // Modify region
0fb067bb
VZ
66 // -------------
67
5549e9f7 68 // Clear current region
0fb067bb
VZ
69 void Clear();
70
71 // Move the region
72 bool Offset(wxCoord x, wxCoord y);
2bda0e17 73
5549e9f7 74 // Union rectangle or region with this.
0fb067bb
VZ
75 bool Union(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_OR); }
76 bool Union(const wxRect& rect) { return Combine(rect, wxRGN_OR); }
77 bool Union(const wxRegion& region) { return Combine(region, wxRGN_OR); }
2bda0e17 78
5549e9f7 79 // Intersect rectangle or region with this.
0fb067bb
VZ
80 bool Intersect(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_AND); }
81 bool Intersect(const wxRect& rect) { return Combine(rect, wxRGN_AND); }
82 bool Intersect(const wxRegion& region) { return Combine(region, wxRGN_AND); }
2bda0e17 83
5549e9f7 84 // Subtract rectangle or region from this:
2bda0e17 85 // Combines the parts of 'this' that are not part of the second region.
0fb067bb
VZ
86 bool Subtract(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_DIFF); }
87 bool Subtract(const wxRect& rect) { return Combine(rect, wxRGN_DIFF); }
88 bool Subtract(const wxRegion& region) { return Combine(region, wxRGN_DIFF); }
5549e9f7
VZ
89
90 // XOR: the union of two combined regions except for any overlapping areas.
0fb067bb
VZ
91 bool Xor(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_XOR); }
92 bool Xor(const wxRect& rect) { return Combine(rect, wxRGN_XOR); }
93 bool Xor(const wxRegion& region) { return Combine(region, wxRGN_XOR); }
5549e9f7
VZ
94
95 // Information on region
0fb067bb
VZ
96 // ---------------------
97
5549e9f7
VZ
98 // Outer bounds of region
99 void GetBox(wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h) const;
2b5f62a0 100 wxRect GetBox() const ;
5549e9f7
VZ
101
102 // Is region empty?
2b5f62a0
VZ
103 bool Empty() const;
104 inline bool IsEmpty() const { return Empty(); }
2bda0e17 105
5549e9f7
VZ
106 // Tests
107 // Does the region contain the point (x,y)?
108 wxRegionContain Contains(wxCoord x, wxCoord y) const;
109 // Does the region contain the point pt?
110 wxRegionContain Contains(const wxPoint& pt) const;
111 // Does the region contain the rectangle (x, y, w, h)?
112 wxRegionContain Contains(wxCoord x, wxCoord y, wxCoord w, wxCoord h) const;
113 // Does the region contain the rectangle rect?
114 wxRegionContain Contains(const wxRect& rect) const;
2bda0e17 115
819451b6 116 // Convert the region to a B&W bitmap with the white pixels being inside
1542ea39
RD
117 // the region.
118 wxBitmap ConvertToBitmap() const;
119
120 // Use the non-transparent pixels of a wxBitmap for the region to combine
85f6b408
VS
121 // with this region. First version takes transparency from bitmap's mask,
122 // second lets the user specify the colour to be treated as transparent
1542ea39 123 // along with an optional tolerance value.
85f6b408
VS
124 // NOTE: implemented in common/rgncmn.cpp
125 bool Union(const wxBitmap& bmp);
1542ea39 126 bool Union(const wxBitmap& bmp,
85f6b408 127 const wxColour& transColour, int tolerance = 0);
1542ea39 128
2bda0e17 129// Internal
5549e9f7
VZ
130 bool Combine(wxCoord x, wxCoord y, wxCoord width, wxCoord height, wxRegionOp op);
131 bool Combine(const wxRegion& region, wxRegionOp op);
132 bool Combine(const wxRect& rect, wxRegionOp op);
a724d789
JS
133
134 // Get internal region handle
135 WXHRGN GetHRGN() const;
5549e9f7 136
0fb067bb 137protected:
02576308 138 virtual wxObjectRefData *CreateRefData() const;
b8027888 139 virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
0fb067bb 140
5549e9f7 141 friend class WXDLLEXPORT wxRegionIterator;
0fb067bb
VZ
142
143 DECLARE_DYNAMIC_CLASS(wxRegion)
2bda0e17
KB
144};
145
5549e9f7
VZ
146class WXDLLEXPORT wxRegionIterator : public wxObject
147{
2bda0e17 148public:
2b5f62a0 149 wxRegionIterator() { Init(); }
5549e9f7 150 wxRegionIterator(const wxRegion& region);
4dddb8a2 151 wxRegionIterator(const wxRegionIterator& ri) : wxObject(ri) { Init(); *this = ri; }
2bda0e17 152
2b5f62a0
VZ
153 wxRegionIterator& operator=(const wxRegionIterator& ri);
154
155 virtual ~wxRegionIterator();
156
157 void Reset() { m_current = 0; }
5549e9f7 158 void Reset(const wxRegion& region);
2bda0e17 159
2b5f62a0
VZ
160 bool HaveRects() const { return (m_current < m_numRects); }
161
a3ef5bf5 162#ifndef __SALFORDC__
2b5f62a0 163 operator bool () const { return HaveRects(); }
a3ef5bf5
JS
164#endif
165
2b5f62a0
VZ
166 wxRegionIterator& operator++();
167 wxRegionIterator operator++(int);
2bda0e17 168
2b5f62a0
VZ
169 wxCoord GetX() const;
170 wxCoord GetY() const;
171 wxCoord GetW() const;
172 wxCoord GetWidth() const { return GetW(); }
173 wxCoord GetH() const;
174 wxCoord GetHeight() const { return GetH(); }
2bda0e17 175
2b5f62a0 176 wxRect GetRect() const { return wxRect(GetX(), GetY(), GetW(), GetH()); }
2bda0e17
KB
177
178private:
2b5f62a0
VZ
179 // common part of all ctors
180 void Init();
181
5549e9f7
VZ
182 long m_current;
183 long m_numRects;
184 wxRegion m_region;
2bda0e17 185 wxRect* m_rects;
5549e9f7 186
57de2373 187 DECLARE_DYNAMIC_CLASS(wxRegionIterator)
2bda0e17
KB
188};
189
190#endif
5549e9f7 191 // _WX_REGION_H_