Add comment about wxBitmap::SetPalette() not being implemented

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

diff --git a/include/wx/msw/region.h b/include/wx/msw/region.h
index 72f8dfcd020123d0d5e3bf73c5ff360d709e237e..0d14ea445286c7146a95df7e7822e1515181b0af 100644 (file)
--- a/include/wx/msw/region.h
+++ b/include/wx/msw/region.h
@@ -1,22 +1,21 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/msw/region.h
 // Purpose:     wxRegion class
-// Author:      Markus Holzem, Julian Smart
+// Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart
+// Copyright:   (c) 1997-2002 wxWidgets team
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_REGION_H_
 #define _WX_REGION_H_
 
-#ifdef __GNUG__
-#pragma interface "region.h"
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+    #pragma interface "region.h"
 #endif
 
-#include "wx/list.h"
 #include "wx/gdiobj.h"
 #include "wx/gdicmn.h"
 
@@ -49,11 +48,20 @@ public:
     wxRegion(const wxRect& rect);
     wxRegion(WXHRGN hRegion); // Hangs on to this region
     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);
+    }
 
     virtual ~wxRegion();
 
     // Copying
-    wxRegion(const wxRegion& r)
+    wxRegion(const wxRegion& r) : wxGDIObject(r)
         { Ref(r); }
     wxRegion& operator = (const wxRegion& r)
         { Ref(r); return (*this); }
@@ -93,11 +101,11 @@ public:
 
     // Outer bounds of region
     void GetBox(wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h) const;
-    wxRect GetBox(void) const ;
+    wxRect GetBox() const ;
 
     // Is region empty?
-    bool Empty(void) const;
-    inline bool IsEmpty(void) const { return Empty(); }
+    bool Empty() const;
+    inline bool IsEmpty() const { return Empty(); }
 
     // Tests
     // Does the region contain the point (x,y)?
@@ -109,6 +117,19 @@ public:
     // Does the region contain the rectangle rect?
     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.  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);
+
 // Internal
     bool Combine(wxCoord x, wxCoord y, wxCoord width, wxCoord height, wxRegionOp op);
     bool Combine(const wxRegion& region, wxRegionOp op);
@@ -129,37 +150,45 @@ protected:
 class WXDLLEXPORT wxRegionIterator : public wxObject
 {
 public:
-    wxRegionIterator(void);
+    wxRegionIterator() { Init(); }
     wxRegionIterator(const wxRegion& region);
-    ~wxRegionIterator(void);
+    wxRegionIterator(const wxRegionIterator& ri) : wxObject(ri) { Init(); *this = ri; }
+
+    wxRegionIterator& operator=(const wxRegionIterator& ri);
 
-    void Reset(void) { m_current = 0; }
+    virtual ~wxRegionIterator();
+
+    void Reset() { m_current = 0; }
     void Reset(const wxRegion& region);
 
+    bool HaveRects() const { return (m_current < m_numRects); }
+
 #ifndef __SALFORDC__
-    operator bool (void) const { return (m_current < m_numRects); }
+    operator bool () const { return HaveRects(); }
 #endif
 
-    bool HaveRects(void) const { return (m_current < m_numRects); }
+    wxRegionIterator& operator++();
+    wxRegionIterator operator++(int);
 
-    void operator ++ (void);
-    void operator ++ (int);
+    wxCoord GetX() const;
+    wxCoord GetY() const;
+    wxCoord GetW() const;
+    wxCoord GetWidth() const { return GetW(); }
+    wxCoord GetH() const;
+    wxCoord GetHeight() const { return GetH(); }
 
-    wxCoord GetX(void) const;
-    wxCoord GetY(void) const;
-    wxCoord GetW(void) const;
-    wxCoord GetWidth(void) const { return GetW(); }
-    wxCoord GetH(void) const;
-    wxCoord GetHeight(void) const { return GetH(); }
-    wxRect GetRect() const { return wxRect(GetX(), GetY(), GetWidth(), GetHeight()); }
+    wxRect GetRect() const { return wxRect(GetX(), GetY(), GetW(), GetH()); }
 
 private:
+    // common part of all ctors
+    void Init();
+
     long     m_current;
     long     m_numRects;
     wxRegion m_region;
     wxRect*  m_rects;
 
-    DECLARE_DYNAMIC_CLASS(wxRegionIterator);
+    DECLARE_DYNAMIC_CLASS(wxRegionIterator)
 };
 
 #endif