fixed outdated filenames
[wxWidgets.git] / include / wx / gtk / region.h
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
5fc7ede9 2// Name: wx/gtk/region.h
c801d85f
KB
3// Purpose:
4// Author: Robert Roebling
58614078
RR
5// Id: $Id$
6// Copyright: (c) 1998 Robert Roebling
5fc7ede9 7// Licence: wxWindows licence
c801d85f
KB
8/////////////////////////////////////////////////////////////////////////////
9
5fc7ede9
VZ
10#ifndef _WX_GTK_REGION_H_
11#define _WX_GTK_REGION_H_
c801d85f
KB
12
13#ifdef __GNUG__
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
25class wxRegion;
26
27//-----------------------------------------------------------------------------
28// constants
29//-----------------------------------------------------------------------------
30
5fc7ede9 31enum wxRegionContain
c801d85f 32{
1e6feb95
VZ
33 wxOutRegion = 0,
34 wxPartRegion = 1,
e1208c31 35 wxInRegion = 2
c801d85f
KB
36};
37
38// So far, for internal use only
1e6feb95 39enum wxRegionOp
e1208c31
RR
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.
c801d85f
KB
46};
47
1e6feb95 48// ----------------------------------------------------------------------------
c801d85f 49// wxRegion
1e6feb95 50// ----------------------------------------------------------------------------
c801d85f 51
5fc7ede9 52class wxRegion : public wxGDIObject
c801d85f 53{
e1208c31 54public:
9fe4c99c
VZ
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 );
c89f5c02 74 ~wxRegion();
c801d85f 75
c89f5c02
RR
76 wxRegion( const wxRegion& region ) { Ref(region); }
77 wxRegion& operator = ( const wxRegion& region ) { Ref(region); return *this; }
78
79 bool Ok() const { return m_refData != NULL; }
c801d85f 80
76ed8f8d 81 bool operator == ( const wxRegion& region );
c89f5c02 82 bool operator != ( const wxRegion& region ) { return !(*this == region); }
5fc7ede9 83
07818da8 84 void Clear();
9fe4c99c 85
35917d22 86 bool Offset( wxCoord x, wxCoord y );
c801d85f 87
5fc7ede9 88 bool Union( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
c801d85f
KB
89 bool Union( const wxRect& rect );
90 bool Union( const wxRegion& region );
91
5fc7ede9 92 bool Intersect( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
c801d85f
KB
93 bool Intersect( const wxRect& rect );
94 bool Intersect( const wxRegion& region );
95
5fc7ede9 96 bool Subtract( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
c801d85f
KB
97 bool Subtract( const wxRect& rect );
98 bool Subtract( const wxRegion& region );
99
5fc7ede9 100 bool Xor( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
c801d85f
KB
101 bool Xor( const wxRect& rect );
102 bool Xor( const wxRegion& region );
103
5fc7ede9 104 void GetBox( wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h ) const;
07818da8 105 wxRect GetBox() const ;
c801d85f 106
07818da8
VZ
107 bool Empty() const;
108 bool IsEmpty() const { return Empty(); }
c801d85f 109
5fc7ede9
VZ
110 wxRegionContain Contains( wxCoord x, wxCoord y ) const;
111 wxRegionContain Contains( wxCoord x, wxCoord y, wxCoord w, wxCoord h ) const;
8429bec1
RR
112 wxRegionContain Contains(const wxPoint& pt) const;
113 wxRegionContain Contains(const wxRect& rect) const;
5fc7ede9 114
e1208c31 115public:
07818da8 116 GdkRegion *GetRegion() const;
1e6feb95
VZ
117
118protected:
e0f0b197
RR
119 // ref counting code
120 virtual wxObjectRefData *CreateRefData() const;
121 virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
122
9fe4c99c
VZ
123 // common part of ctors for a rectangle region
124 void InitRect(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
125
e1208c31 126private:
1e6feb95 127 DECLARE_DYNAMIC_CLASS(wxRegion);
c801d85f
KB
128};
129
1e6feb95
VZ
130// ----------------------------------------------------------------------------
131// wxRegionIterator: decomposes a region into rectangles
132// ----------------------------------------------------------------------------
133
5fc7ede9 134class wxRegionIterator: public wxObject
8429bec1 135{
738f9e5a 136public:
07818da8 137 wxRegionIterator();
8429bec1
RR
138 wxRegionIterator(const wxRegion& region);
139
6f2a55e3 140 void Reset() { m_current = 0u; }
8429bec1
RR
141 void Reset(const wxRegion& region);
142
07818da8
VZ
143 operator bool () const;
144 bool HaveRects() const;
8429bec1 145
07818da8 146 void operator ++ ();
8429bec1
RR
147 void operator ++ (int);
148
b02da6b1
VZ
149 wxCoord GetX() const;
150 wxCoord GetY() const;
151 wxCoord GetW() const;
152 wxCoord GetWidth() const { return GetW(); }
153 wxCoord GetH() const;
154 wxCoord GetHeight() const { return GetH(); }
1e6feb95 155 wxRect GetRect() const;
8429bec1 156
738f9e5a 157private:
6f2a55e3
VZ
158 size_t m_current;
159 wxRegion m_region;
738f9e5a
RR
160
161private:
162 DECLARE_DYNAMIC_CLASS(wxRegionIterator);
8429bec1
RR
163};
164
165
c801d85f 166#endif
5fc7ede9 167 // _WX_GTK_REGION_H_