]> git.saurik.com Git - wxWidgets.git/blob - include/wx/os2/region.h
Bring AddActionTrigger() doc string up to date with the interface
[wxWidgets.git] / include / wx / os2 / region.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/os2/region.h
3 // Purpose: wxRegion class
4 // Author: David Webster
5 // Modified by:
6 // Created: 10/15/99
7 // RCS-ID: $Id$
8 // Copyright: (c) David Webster
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_OS2_REGION_H_
13 #define _WX_OS2_REGION_H_
14
15 #include "wx/list.h"
16 #include "wx/os2/private.h"
17
18 class WXDLLIMPEXP_CORE wxRegion : public wxRegionWithCombine
19 {
20 public:
21 wxRegion( wxCoord x
22 ,wxCoord y
23 ,wxCoord vWidth
24 ,wxCoord vHeight
25 );
26 wxRegion( const wxPoint& rTopLeft
27 ,const wxPoint& rBottomRight
28 );
29 wxRegion(const wxRect& rRect);
30 wxRegion(WXHRGN hRegion, WXHDC hPS); // Hangs on to this region
31 wxRegion(size_t n, const wxPoint *points, wxPolygonFillMode fillStyle = wxODDEVEN_RULE );
32 wxRegion( const wxBitmap& bmp)
33 {
34 Union(bmp);
35 }
36 wxRegion( const wxBitmap& bmp,
37 const wxColour& transColour, int tolerance = 0)
38 {
39 Union(bmp, transColour, tolerance);
40 }
41
42 wxRegion();
43 virtual ~wxRegion();
44
45 //
46 // Modify region
47 //
48
49 //
50 // Clear current region
51 //
52 virtual void Clear();
53
54 //
55 // Is region empty?
56 //
57 virtual bool IsEmpty() const;
58
59 //
60 // Get internal region handle
61 //
62 WXHRGN GetHRGN() const;
63
64 void SetPS(HPS hPS);
65
66 protected:
67 virtual wxGDIRefData* CreateGDIRefData(void) const;
68 virtual wxGDIRefData* CloneGDIRefData(const wxGDIRefData* pData) const;
69
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 DoCombine(const wxRegion& region, wxRegionOp op);
77
78 friend class WXDLLIMPEXP_FWD_CORE wxRegionIterator;
79 DECLARE_DYNAMIC_CLASS(wxRegion);
80
81 }; // end of CLASS wxRegion
82
83 class WXDLLIMPEXP_CORE wxRegionIterator : public wxObject
84 {
85 public:
86 wxRegionIterator();
87 wxRegionIterator(const wxRegion& rRegion);
88 virtual ~wxRegionIterator();
89
90 void Reset(void) { m_lCurrent = 0; }
91 void Reset(const wxRegion& rRegion);
92
93 operator bool (void) const { return m_lCurrent < m_lNumRects; }
94 bool HaveRects(void) const { return m_lCurrent < m_lNumRects; }
95
96 void operator ++ (void);
97 void operator ++ (int);
98
99 wxCoord GetX(void) const;
100 wxCoord GetY(void) const;
101 wxCoord GetW(void) const;
102 wxCoord GetWidth(void) const { return GetW(); }
103 wxCoord GetH(void) const;
104 wxCoord GetHeight(void) const { return GetH(); }
105 wxRect GetRect(void) const { return wxRect(GetX(), GetY(), GetWidth(), GetHeight()); }
106
107 private:
108 long m_lCurrent;
109 long m_lNumRects;
110 wxRegion m_vRegion;
111 wxRect* m_pRects;
112
113 DECLARE_DYNAMIC_CLASS(wxRegionIterator)
114 }; // end of wxRegionIterator
115
116 #endif // _WX_OS2_REGION_H_