]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/gtk/region.h
added test for writing empty value to the config
[wxWidgets.git] / include / wx / gtk / region.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/gtk/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#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
31enum wxRegionContain
32{
33 wxOutRegion = 0,
34 wxPartRegion = 1,
35 wxInRegion = 2
36};
37
38// So far, for internal use only
39enum wxRegionOp
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.
46};
47
48// ----------------------------------------------------------------------------
49// wxRegion
50// ----------------------------------------------------------------------------
51
52class wxRegion : public wxGDIObject
53{
54public:
55 wxRegion( wxCoord x, wxCoord y, wxCoord w, wxCoord h );
56 wxRegion( const wxPoint& topLeft, const wxPoint& bottomRight );
57 wxRegion( const wxRect& rect );
58 wxRegion();
59 virtual ~wxRegion();
60
61 wxRegion( const wxRegion& r ) { Ref(r); }
62 wxRegion& operator = ( const wxRegion& r ) { Ref(r); return *this; }
63
64 bool operator == ( const wxRegion& region );
65 bool operator != ( const wxRegion& region );
66
67 void Clear();
68
69 bool Union( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
70 bool Union( const wxRect& rect );
71 bool Union( const wxRegion& region );
72
73 bool Intersect( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
74 bool Intersect( const wxRect& rect );
75 bool Intersect( const wxRegion& region );
76
77 bool Subtract( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
78 bool Subtract( const wxRect& rect );
79 bool Subtract( const wxRegion& region );
80
81 bool Xor( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
82 bool Xor( const wxRect& rect );
83 bool Xor( const wxRegion& region );
84
85 void GetBox( wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h ) const;
86 wxRect GetBox() const ;
87
88 bool Empty() const;
89 bool IsEmpty() const { return Empty(); }
90
91 wxRegionContain Contains( wxCoord x, wxCoord y ) const;
92 wxRegionContain Contains( wxCoord x, wxCoord y, wxCoord w, wxCoord h ) const;
93 wxRegionContain Contains(const wxPoint& pt) const;
94 wxRegionContain Contains(const wxRect& rect) const;
95
96public:
97 wxList *GetRectList() const;
98 GdkRegion *GetRegion() const;
99
100protected:
101 // helper of Intersect()
102 bool IntersectRegionOnly(const wxRegion& reg);
103
104 // call this before modifying the region
105 void Unshare();
106
107private:
108 DECLARE_DYNAMIC_CLASS(wxRegion);
109};
110
111// ----------------------------------------------------------------------------
112// wxRegionIterator: decomposes a region into rectangles
113// ----------------------------------------------------------------------------
114
115class wxRegionIterator: public wxObject
116{
117public:
118 wxRegionIterator();
119 wxRegionIterator(const wxRegion& region);
120
121 void Reset() { m_current = 0u; }
122 void Reset(const wxRegion& region);
123
124 operator bool () const;
125 bool HaveRects() const;
126
127 void operator ++ ();
128 void operator ++ (int);
129
130 wxCoord GetX() const;
131 wxCoord GetY() const;
132 wxCoord GetW() const;
133 wxCoord GetWidth() const { return GetW(); }
134 wxCoord GetH() const;
135 wxCoord GetHeight() const { return GetH(); }
136 wxRect GetRect() const;
137
138private:
139 size_t m_current;
140 wxRegion m_region;
141
142private:
143 DECLARE_DYNAMIC_CLASS(wxRegionIterator);
144};
145
146
147#endif
148 // _WX_GTK_REGION_H_