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 88d9e9a2ce5f59954832a95ba63ba170fc8b742e..0d14ea445286c7146a95df7e7822e1515181b0af 100644 (file)
--- a/include/wx/msw/region.h
+++ b/include/wx/msw/region.h
@@ -1,145 +1,195 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxRegion class
 // Purpose:     wxRegion class

-// Author:      Markus Holzem, Julian Smart
+// Author:      Julian Smart

 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart
-// Licence:    wxWindows licence
+// Copyright:   (c) 1997-2002 wxWidgets team
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_REGION_H_
 #define _WX_REGION_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #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
 
 #endif
 

-#include "wx/list.h"

 #include "wx/gdiobj.h"
 #include "wx/gdicmn.h"
 
 class WXDLLEXPORT wxRect;
 class WXDLLEXPORT wxPoint;
 
 #include "wx/gdiobj.h"
 #include "wx/gdicmn.h"
 
 class WXDLLEXPORT wxRect;
 class WXDLLEXPORT wxPoint;
 

-enum wxRegionContain {
-       wxOutRegion = 0, wxPartRegion = 1, wxInRegion = 2
+enum wxRegionContain
+{
+    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.

 };
 
 };
 

-class WXDLLEXPORT wxRegion : public wxGDIObject {
-DECLARE_DYNAMIC_CLASS(wxRegion);
-       friend class WXDLLEXPORT wxRegionIterator;
+class WXDLLEXPORT wxRegion : public wxGDIObject
+{

 public:
 public:

+    wxRegion();

     wxRegion(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
     wxRegion(const wxPoint& topLeft, const wxPoint& bottomRight);
     wxRegion(const wxRect& rect);
     wxRegion(WXHRGN hRegion); // Hangs on to this region
     wxRegion(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
     wxRegion(const wxPoint& topLeft, const wxPoint& bottomRight);
     wxRegion(const wxRect& rect);
     wxRegion(WXHRGN hRegion); // Hangs on to this region

-
-       wxRegion(void);
-       ~wxRegion(void);
-
-       //# Copying
-       inline wxRegion(const wxRegion& r)
-               { Ref(r); }
-       inline wxRegion& operator = (const wxRegion& r)
-               { Ref(r); return (*this); }
-
-       //# Modify region
-       // Clear current region
-       void Clear(void);
-
-       // Union rectangle or region with this.
-       inline bool Union(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_OR); }
-       inline bool Union(const wxRect& rect) { return Combine(rect, wxRGN_OR); }
-       inline bool Union(const wxRegion& region) { return Combine(region, wxRGN_OR); }
-
-       // Intersect rectangle or region with this.
-       inline bool Intersect(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_AND); }
-       inline bool Intersect(const wxRect& rect)  { return Combine(rect, wxRGN_AND); }
-       inline bool Intersect(const wxRegion& region)  { return Combine(region, wxRGN_AND); }
-
-       // Subtract rectangle or region from this:
+    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) : wxGDIObject(r)
+        { Ref(r); }
+    wxRegion& operator = (const wxRegion& r)
+        { Ref(r); return (*this); }
+
+    // Modify region
+    // -------------
+
+    // Clear current region
+    void Clear();
+
+    // Move the region
+    bool Offset(wxCoord x, wxCoord y);
+
+    // Union rectangle or region with this.
+    bool Union(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_OR); }
+    bool Union(const wxRect& rect) { return Combine(rect, wxRGN_OR); }
+    bool Union(const wxRegion& region) { return Combine(region, wxRGN_OR); }
+
+    // Intersect rectangle or region with this.
+    bool Intersect(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_AND); }
+    bool Intersect(const wxRect& rect)  { return Combine(rect, wxRGN_AND); }
+    bool Intersect(const wxRegion& region)  { return Combine(region, wxRGN_AND); }
+
+    // Subtract rectangle or region from this:

     // Combines the parts of 'this' that are not part of the second region.
     // Combines the parts of 'this' that are not part of the second region.

-       inline bool Subtract(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_DIFF); }
-       inline bool Subtract(const wxRect& rect)  { return Combine(rect, wxRGN_DIFF); }
-       inline bool Subtract(const wxRegion& region)  { return Combine(region, wxRGN_DIFF); }
-
-       // XOR: the union of two combined regions except for any overlapping areas.
-       inline bool Xor(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_XOR); }
-       inline bool Xor(const wxRect& rect)  { return Combine(rect, wxRGN_XOR); }
-       inline bool Xor(const wxRegion& region)  { return Combine(region, wxRGN_XOR); }
-
-       //# Information on region
-       // Outer bounds of region
-       void GetBox(wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h) const;
-       wxRect GetBox(void) const ;
-
-       // Is region empty?
-       bool Empty(void) const;
-    inline bool IsEmpty(void) const { return Empty(); }
-
-       //# Tests
-       // Does the region contain the point (x,y)?
-       wxRegionContain Contains(wxCoord x, wxCoord y) const;
-       // Does the region contain the point pt?
-       wxRegionContain Contains(const wxPoint& pt) const;
-       // Does the region contain the rectangle (x, y, w, h)?
-       wxRegionContain Contains(wxCoord x, wxCoord y, wxCoord w, wxCoord h) const;
-       // Does the region contain the rectangle rect?
-       wxRegionContain Contains(const wxRect& rect) const;
+    bool Subtract(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_DIFF); }
+    bool Subtract(const wxRect& rect)  { return Combine(rect, wxRGN_DIFF); }
+    bool Subtract(const wxRegion& region)  { return Combine(region, wxRGN_DIFF); }
+
+    // XOR: the union of two combined regions except for any overlapping areas.
+    bool Xor(wxCoord x, wxCoord y, wxCoord width, wxCoord height) { return Combine(x, y, width, height, wxRGN_XOR); }
+    bool Xor(const wxRect& rect)  { return Combine(rect, wxRGN_XOR); }
+    bool Xor(const wxRegion& region)  { return Combine(region, wxRGN_XOR); }
+
+    // Information on region
+    // ---------------------
+
+    // Outer bounds of region
+    void GetBox(wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h) const;
+    wxRect GetBox() const ;
+
+    // Is region empty?
+    bool Empty() const;
+    inline bool IsEmpty() const { return Empty(); }
+
+    // Tests
+    // Does the region contain the point (x,y)?
+    wxRegionContain Contains(wxCoord x, wxCoord y) const;
+    // Does the region contain the point pt?
+    wxRegionContain Contains(const wxPoint& pt) const;
+    // Does the region contain the rectangle (x, y, w, h)?
+    wxRegionContain Contains(wxCoord x, wxCoord y, wxCoord w, wxCoord h) const;
+    // 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
 
 // Internal

-       bool Combine(wxCoord x, wxCoord y, wxCoord width, wxCoord height, wxRegionOp op);
-       bool Combine(const wxRegion& region, wxRegionOp op);
-       bool Combine(const wxRect& rect, wxRegionOp op);
+    bool Combine(wxCoord x, wxCoord y, wxCoord width, wxCoord height, wxRegionOp op);
+    bool Combine(const wxRegion& region, wxRegionOp op);
+    bool Combine(const wxRect& rect, wxRegionOp op);

 
     // Get internal region handle
     WXHRGN GetHRGN() const;
 
     // Get internal region handle
     WXHRGN GetHRGN() const;

+
+protected:
+    virtual wxObjectRefData *CreateRefData() const;
+    virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
+
+    friend class WXDLLEXPORT wxRegionIterator;
+
+    DECLARE_DYNAMIC_CLASS(wxRegion)

 };
 
 };
 

-class WXDLLEXPORT wxRegionIterator : public wxObject {
-DECLARE_DYNAMIC_CLASS(wxRegionIterator);
+class WXDLLEXPORT wxRegionIterator : public wxObject
+{

 public:
 public:

-       wxRegionIterator(void);
-       wxRegionIterator(const wxRegion& region);
-       ~wxRegionIterator(void);
+    wxRegionIterator() { Init(); }
+    wxRegionIterator(const wxRegion& region);
+    wxRegionIterator(const wxRegionIterator& ri) : wxObject(ri) { Init(); *this = ri; }
+
+    wxRegionIterator& operator=(const wxRegionIterator& ri);
+
+    virtual ~wxRegionIterator();

 
 

-       void Reset(void) { m_current = 0; }
-       void Reset(const wxRegion& region);
+    void Reset() { m_current = 0; }
+    void Reset(const wxRegion& region);
+
+    bool HaveRects() const { return (m_current < m_numRects); }

 
 #ifndef __SALFORDC__
 
 #ifndef __SALFORDC__

-       operator bool (void) const { return (m_current < m_numRects); }
+    operator bool () const { return HaveRects(); }

 #endif
 
 #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:
 
 private:

-       long     m_current;
-       long     m_numRects;
-       wxRegion m_region;
+    // common part of all ctors
+    void Init();
+
+    long     m_current;
+    long     m_numRects;
+    wxRegion m_region;

     wxRect*  m_rects;
     wxRect*  m_rects;

+
+    DECLARE_DYNAMIC_CLASS(wxRegionIterator)

 };
 
 #endif
 };
 
 #endif

-       // _WX_REGION_H_
+    // _WX_REGION_H_