Make list consistent with tree in terms of Vetoed changes closing the inline edit...

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

diff --git a/include/wx/gtk/region.h b/include/wx/gtk/region.h
index 0a8848293731d91b72c09a1084d05fbfc3975d61..5eec88fe8222f64bd5808674f80ef360f3e0613e 100644 (file)
--- a/include/wx/gtk/region.h
+++ b/include/wx/gtk/region.h
@@ -1,16 +1,16 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        region.h
+// Name:        wx/gtk/region.h

 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
 // 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__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma interface
 #endif
 
 #pragma interface
 #endif
 


@@ -28,93 +28,154 @@ class wxRegion;
 // constants
 //-----------------------------------------------------------------------------
 
 // constants
 //-----------------------------------------------------------------------------
 

-enum wxRegionContain 
+enum wxRegionContain

 {
 {

-  wxOutRegion = 0, wxPartRegion = 1, wxInRegion = 2
+    wxOutRegion = 0,
+    wxPartRegion = 1,
+    wxInRegion = 2

 };
 
 // So far, for internal use only
 };
 
 // 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
 // wxRegion

-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------

 
 

-class wxRegion : public wxGDIObject 
+class wxRegion : public wxGDIObject

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxRegion);
-  
-  public:
-  
-    wxRegion( long x, long y, long w, long h );
-    wxRegion( const wxPoint& topLeft, const wxPoint& bottomRight );
-    wxRegion( const wxRect& rect );
-    wxRegion();
+public:
+    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)
+    {
+        Union(bmp);
+    }
+    wxRegion( const wxBitmap& bmp,
+              const wxColour& transColour, int tolerance = 0)
+    {
+        Union(bmp, transColour, tolerance);
+    }
+

     ~wxRegion();
 
     ~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 );
-    
+    bool operator != ( const wxRegion& region ) { return !(*this == region); }
+

     void Clear();
 
     void Clear();
 

-    bool Union( long x, long y, long width, long height );
+    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 );
 
     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 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 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 );
 
     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(); }
 
     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;
     wxRegionContain Contains(const wxPoint& pt) const;
     wxRegionContain Contains(const wxRect& rect) const;

-    
-  public:
-  
-    wxList    *GetRectList() 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.  First version takes transparency from bitmap's mask,
+    // second lets the user specify the colour to be treated as transparent
+    // along with an optional tolerance value.
+    // NOTE: implemented in common/rgncmn.cpp
+    bool Union(const wxBitmap& bmp);
+    bool Union(const wxBitmap& bmp,
+               const wxColour& transColour, int tolerance = 0);
+
+
+public:
+    // Init with GdkRegion, set ref count to 2 so that
+    // the C++ class will not destroy the region!
+    wxRegion( GdkRegion *region );
+

     GdkRegion *GetRegion() const;
     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);

 };
 
 };
 

-class wxRegionIterator: public wxObject 
+// ----------------------------------------------------------------------------
+// wxRegionIterator: decomposes a region into rectangles
+// ----------------------------------------------------------------------------
+
+class wxRegionIterator: public wxObject

 {
 public:
     wxRegionIterator();
     wxRegionIterator(const wxRegion& region);
 
 {
 public:
     wxRegionIterator();
     wxRegionIterator(const wxRegion& region);
 

-    void Reset() { m_current = 0; }
+    void Reset() { m_current = 0u; }

     void Reset(const wxRegion& region);
 
     void Reset(const wxRegion& region);
 

-    operator bool () const;

     bool HaveRects() 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;
 
     wxCoord GetX() const;
     wxCoord GetY() const;


@@ -122,11 +183,11 @@ public:
     wxCoord GetWidth() const { return GetW(); }
     wxCoord GetH() const;
     wxCoord GetHeight() const { return GetH(); }
     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:
 
 private:

-    long       m_current;
-    wxRegion   m_region;
+    size_t   m_current;
+    wxRegion m_region;

 
 private:
     DECLARE_DYNAMIC_CLASS(wxRegionIterator);
 
 private:
     DECLARE_DYNAMIC_CLASS(wxRegionIterator);


@@ -134,4 +195,4 @@ private:
 
 
 #endif
 
 
 #endif

-       // __REGIONH__
+        // _WX_GTK_REGION_H_