fixed unimportant typo

[wxWidgets.git] / include / wx / gtk1 / region.h

diff --git a/include/wx/gtk1/region.h b/include/wx/gtk1/region.h
index 0a8848293731d91b72c09a1084d05fbfc3975d61..3409ce33391d8878a734c01210f989b0e7ce4c72 100644 (file)
--- a/include/wx/gtk1/region.h
+++ b/include/wx/gtk1/region.h
@@ -1,14 +1,14 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        region.h
+// Name:        wx/gtk/region.h
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
-// Licence:    wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __REGIONH__
-#define __REGIONH__
+#ifndef _WX_GTK_REGION_H_
+#define _WX_GTK_REGION_H_
 
 #ifdef __GNUG__
 #pragma interface
@@ -28,86 +28,98 @@ class wxRegion;
 // constants
 //-----------------------------------------------------------------------------
 
-enum wxRegionContain 
+enum wxRegionContain
 {
-  wxOutRegion = 0, wxPartRegion = 1, wxInRegion = 2
+    wxOutRegion = 0,
+    wxPartRegion = 1,
+    wxInRegion = 2
 };
 
 // So far, for internal use only
-enum wxRegionOp {
-wxRGN_AND,          // Creates the intersection of the two combined regions.
-wxRGN_COPY,         // Creates a copy of the region identified by hrgnSrc1.
-wxRGN_DIFF,         // Combines the parts of hrgnSrc1 that are not part of hrgnSrc2.
-wxRGN_OR,           // Creates the union of two combined regions.
-wxRGN_XOR           // Creates the union of two combined regions except for any overlapping areas.
+enum wxRegionOp
+{
+   wxRGN_AND,          // Creates the intersection of the two combined regions.
+   wxRGN_COPY,         // Creates a copy of the region identified by hrgnSrc1.
+   wxRGN_DIFF,         // Combines the parts of hrgnSrc1 that are not part of hrgnSrc2.
+   wxRGN_OR,           // Creates the union of two combined regions.
+   wxRGN_XOR           // Creates the union of two combined regions except for any overlapping areas.
 };
 
-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
 // wxRegion
-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
 
-class wxRegion : public wxGDIObject 
+class wxRegion : public wxGDIObject
 {
-  DECLARE_DYNAMIC_CLASS(wxRegion);
-  
-  public:
-  
-    wxRegion( long x, long y, long w, long h );
+public:
+    wxRegion();
+    wxRegion( wxCoord x, wxCoord y, wxCoord w, wxCoord h );
     wxRegion( const wxPoint& topLeft, const wxPoint& bottomRight );
     wxRegion( const wxRect& rect );
-    wxRegion();
-    ~wxRegion();
+    wxRegion(size_t n, const wxPoint *points, int fillStyle = wxODDEVEN_RULE );
+    virtual ~wxRegion();
 
-    inline wxRegion( const wxRegion& r ): wxGDIObject()
-      { Ref(r); }
-    inline wxRegion& operator = ( const wxRegion& r )
-      { Ref(r); return (*this); }
+    wxRegion( const wxRegion& r ) { Ref(r); }
+    wxRegion& operator = ( const wxRegion& r ) { Ref(r); return *this; }
 
     bool operator == ( const wxRegion& region );
     bool operator != ( const wxRegion& region );
-    
+
     void Clear();
 
-    bool Union( long x, long y, long width, long height );
+    bool Union( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
     bool Union( const wxRect& rect );
     bool Union( const wxRegion& region );
 
-    bool Intersect( long x, long y, long width, long height );
+    bool Intersect( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
     bool Intersect( const wxRect& rect );
     bool Intersect( const wxRegion& region );
 
-    bool Subtract( long x, long y, long width, long height );
+    bool Subtract( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
     bool Subtract( const wxRect& rect );
     bool Subtract( const wxRegion& region );
 
-    bool Xor( long x, long y, long width, long height );
+    bool Xor( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
     bool Xor( const wxRect& rect );
     bool Xor( const wxRegion& region );
 
-    void GetBox( long& x, long& y, long&w, long &h ) const;
+    void GetBox( wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h ) const;
     wxRect GetBox() const ;
 
     bool Empty() const;
     bool IsEmpty() const { return Empty(); }
 
-    wxRegionContain Contains( long x, long y ) const;
-    wxRegionContain Contains( long x, long y, long w, long h ) const;
+    wxRegionContain Contains( wxCoord x, wxCoord y ) const;
+    wxRegionContain Contains( wxCoord x, wxCoord y, wxCoord w, wxCoord h ) const;
     wxRegionContain Contains(const wxPoint& pt) const;
     wxRegionContain Contains(const wxRect& rect) const;
-    
-  public:
-  
-    wxList    *GetRectList() const;    
+
+public:
+    wxList    *GetRectList() const;
     GdkRegion *GetRegion() const;
+
+protected:
+    // helper of Intersect()
+    bool IntersectRegionOnly(const wxRegion& reg);
+
+    // call this before modifying the region
+    void Unshare();
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxRegion);
 };
 
-class wxRegionIterator: public wxObject 
+// ----------------------------------------------------------------------------
+// wxRegionIterator: decomposes a region into rectangles
+// ----------------------------------------------------------------------------
+
+class wxRegionIterator: public wxObject
 {
 public:
     wxRegionIterator();
     wxRegionIterator(const wxRegion& region);
 
-    void Reset() { m_current = 0; }
+    void Reset() { m_current = 0u; }
     void Reset(const wxRegion& region);
 
     operator bool () const;
@@ -122,11 +134,11 @@ public:
     wxCoord GetWidth() const { return GetW(); }
     wxCoord GetH() const;
     wxCoord GetHeight() const { return GetH(); }
-    wxRect GetRect() const { return wxRect(GetX(), GetY(), GetWidth(), GetHeight()); }
+    wxRect GetRect() const;
 
 private:
-    long       m_current;
-    wxRegion   m_region;
+    size_t   m_current;
+    wxRegion m_region;
 
 private:
     DECLARE_DYNAMIC_CLASS(wxRegionIterator);
@@ -134,4 +146,4 @@ private:
 
 
 #endif
-       // __REGIONH__
+        // _WX_GTK_REGION_H_