Decided that not doing methods for keyboard commands was not worth the

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

diff --git a/include/wx/gtk/region.h b/include/wx/gtk/region.h
index 7369192305fbbe78871d9e3b9a9bb70cd83c9790..90356ba2ea8a05b0b212a2bdbfd9686bd7d1b1f5 100644 (file)
--- a/include/wx/gtk/region.h
+++ b/include/wx/gtk/region.h
@@ -10,7 +10,7 @@
 #ifndef _WX_GTK_REGION_H_
 #define _WX_GTK_REGION_H_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface
 #endif
 
@@ -30,13 +30,13 @@ class wxRegion;
 
 enum wxRegionContain
 {
-    wxOutRegion = 0, 
-    wxPartRegion = 1, 
+    wxOutRegion = 0,
+    wxPartRegion = 1,
     wxInRegion = 2
 };
 
 // So far, for internal use only
-enum wxRegionOp 
+enum wxRegionOp
 {
    wxRGN_AND,          // Creates the intersection of the two combined regions.
    wxRGN_COPY,         // Creates a copy of the region identified by hrgnSrc1.
@@ -45,29 +45,56 @@ enum wxRegionOp
    wxRGN_XOR           // Creates the union of two combined regions except for any overlapping areas.
 };
 
-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
 // wxRegion
-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
 
 class wxRegion : public wxGDIObject
 {
 public:
-    wxRegion( wxCoord x, wxCoord y, wxCoord w, wxCoord h );
-    wxRegion( const wxPoint& topLeft, const wxPoint& bottomRight );
-    wxRegion( const wxRect& rect );
-    wxRegion();
+    wxRegion() { }
+
+    wxRegion( wxCoord x, wxCoord y, wxCoord w, wxCoord h )
+    {
+        InitRect(x, y, w, h);
+    }
+
+    wxRegion( const wxPoint& topLeft, const wxPoint& bottomRight )
+    {
+        InitRect(topLeft.x, topLeft.y,
+                 bottomRight.x - topLeft.x, bottomRight.y - topLeft.y);
+    }
+
+    wxRegion( const wxRect& rect )
+    {
+        InitRect(rect.x, rect.y, rect.width, rect.height);
+    }
+
+    wxRegion( size_t n, const wxPoint *points, int fillStyle = wxODDEVEN_RULE );
+
+    wxRegion( const wxBitmap& bmp,
+              const wxColour& transColour = wxNullColour,
+              int   tolerance = 0)
+    {
+        Union(bmp, transColour, tolerance);
+    }
+
     ~wxRegion();
 
-    inline wxRegion( const wxRegion& r ): wxGDIObject()
-      { Ref(r); }
-    inline wxRegion& operator = ( const wxRegion& r )
-      { Ref(r); return (*this); }
+    wxRegion( const wxRegion& region )
+        : wxGDIObject()
+        { Ref(region); }
+    wxRegion& operator = ( const wxRegion& region ) { Ref(region); return *this; }
+
+    bool Ok() const { return m_refData != NULL; }
 
     bool operator == ( const wxRegion& region );
-    bool operator != ( const wxRegion& region );
+    bool operator != ( const wxRegion& region ) { return !(*this == region); }
 
     void Clear();
 
+    bool Offset( wxCoord x, wxCoord y );
+
     bool Union( wxCoord x, wxCoord y, wxCoord width, wxCoord height );
     bool Union( const wxRect& rect );
     bool Union( const wxRegion& region );
@@ -95,14 +122,42 @@ public:
     wxRegionContain Contains(const wxPoint& pt) const;
     wxRegionContain Contains(const wxRect& rect) const;
 
+    // Convert the region to a B&W bitmap with the white pixels being inside
+    // the region.
+    wxBitmap ConvertToBitmap() const;
+
+    // Use the non-transparent pixels of a wxBitmap for the region to combine
+    // with this region.  If the bitmap has a mask then it will be used,
+    // otherwise the colour to be treated as transparent may be specified,
+    // along with an optional tolerance value.
+    bool Union(const wxBitmap& bmp,
+               const wxColour& transColour = wxNullColour,
+               int   tolerance = 0);
+
+
 public:
-    wxList    *GetRectList() const;
+    // Init with GdkRegion, set ref count to 2 so that
+    // the C++ class will not destroy the region!
+    wxRegion( GdkRegion *region );
+
     GdkRegion *GetRegion() const;
-    
+
+protected:
+    // ref counting code
+    virtual wxObjectRefData *CreateRefData() const;
+    virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
+
+    // common part of ctors for a rectangle region
+    void InitRect(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
+
 private:
-  DECLARE_DYNAMIC_CLASS(wxRegion);
+    DECLARE_DYNAMIC_CLASS(wxRegion);
 };
 
+// ----------------------------------------------------------------------------
+// wxRegionIterator: decomposes a region into rectangles
+// ----------------------------------------------------------------------------
+
 class wxRegionIterator: public wxObject
 {
 public:
@@ -112,11 +167,11 @@ public:
     void Reset() { m_current = 0u; }
     void Reset(const wxRegion& region);
 
-    operator bool () const;
     bool HaveRects() const;
+    operator bool () const { return HaveRects(); }
 
-    void operator ++ ();
-    void operator ++ (int);
+    wxRegionIterator& operator ++ ();
+    wxRegionIterator operator ++ (int);
 
     wxCoord GetX() const;
     wxCoord GetY() const;
@@ -124,7 +179,7 @@ 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:
     size_t   m_current;