]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/os2/region.h
use wx-style header and commets; fix indentation to be 4 spaces; move Doxygen comment...
[wxWidgets.git] / include / wx / os2 / region.h
index e524cc157e7f2f1fb089b61e16c49cc85cfc7a76..126deb0937deb21cee031d598e9df0e16f6943f8 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        region.h
+// Name:        wx/os2/region.h
 // Purpose:     wxRegion class
 // Author:      David Webster
 // Modified by:
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef _WX_REGION_H_
-#define _WX_REGION_H_
+#ifndef _WX_OS2_REGION_H_
+#define _WX_OS2_REGION_H_
 
 #include "wx/list.h"
-#include "wx/gdiobj.h"
-#include "wx/gdicmn.h"
-
-class WXDLLEXPORT wxRect;
-class WXDLLEXPORT wxPoint;
-
-enum wxRegionContain {
-    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.
-};
-
-class WXDLLEXPORT wxRegion : public wxGDIObject {
-DECLARE_DYNAMIC_CLASS(wxRegion);
-    friend class WXDLLEXPORT wxRegionIterator;
+#include "wx/os2/private.h"
+
+class WXDLLEXPORT wxRegion : public wxRegionWithCombine
+{
 public:
-    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 vWidth
+             ,wxCoord vHeight
+            );
+    wxRegion( const wxPoint& rTopLeft
+             ,const wxPoint& rBottomRight
+            );
+    wxRegion(const wxRect& rRect);
+    wxRegion(WXHRGN hRegion, WXHDC hPS); // 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);
+    }
 
     wxRegion();
-    ~wxRegion();
+    virtual ~wxRegion();
 
-    //# Copying
-    inline wxRegion(const wxRegion& r)
-        { Ref(r); }
-    inline wxRegion& operator = (const wxRegion& r)
-        { Ref(r); return (*this); }
+    //
+    // Modify region
+    //
 
-    //# Modify region
+    //
     // Clear current region
-    void Clear();
-
-    // 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:
-    // 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() const ;
+    //
+    virtual void Clear();
 
+    //
     // 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;
-
-// 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);
+    //
+    virtual bool IsEmpty() const;
 
+    //
     // Get internal region handle
+    //
     WXHRGN GetHRGN() const;
-};
 
-class WXDLLEXPORT wxRegionIterator : public wxObject {
-DECLARE_DYNAMIC_CLASS(wxRegionIterator);
+    void   SetPS(HPS hPS);
+
+protected:
+    virtual wxGDIRefData* CreateGDIRefData(void) const;
+    virtual wxGDIRefData* CloneGDIRefData(const wxGDIRefData* pData) const;
+
+    virtual bool DoIsEqual(const wxRegion& region) const;
+    virtual bool DoGetBox(wxCoord& x, wxCoord& y, wxCoord& w, wxCoord& h) const;
+    virtual wxRegionContain DoContainsPoint(wxCoord x, wxCoord y) const;
+    virtual wxRegionContain DoContainsRect(const wxRect& rect) const;
+
+    virtual bool DoOffset(wxCoord x, wxCoord y);
+    virtual bool DoCombine(const wxRegion& region, wxRegionOp op);
+
+    friend class WXDLLIMPEXP_FWD_CORE wxRegionIterator;
+    DECLARE_DYNAMIC_CLASS(wxRegion);
+
+}; // end of CLASS wxRegion
+
+class WXDLLEXPORT wxRegionIterator : public wxObject
+{
 public:
     wxRegionIterator();
-    wxRegionIterator(const wxRegion& region);
-    ~wxRegionIterator();
+    wxRegionIterator(const wxRegion& rRegion);
+    virtual ~wxRegionIterator();
 
-    void Reset() { m_current = 0; }
-    void Reset(const wxRegion& region);
+    void Reset(void) { m_lCurrent = 0; }
+    void Reset(const wxRegion& rRegion);
 
-    operator bool () const { return m_current < m_numRects; }
-    bool HaveRects() const { return m_current < m_numRects; }
+    operator bool (void) const { return m_lCurrent < m_lNumRects; }
+    bool HaveRects(void) const { return m_lCurrent < m_lNumRects; }
 
-    void operator ++ ();
+    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(); }
-    wxRect GetRect() const { return wxRect(GetX(), GetY(), GetWidth(), GetHeight()); }
+    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(void) const { return wxRect(GetX(), GetY(), GetWidth(), GetHeight()); }
 
 private:
-    long     m_current;
-    long     m_numRects;
-    wxRegion m_region;
-    wxRect*  m_rects;
-};
-
-#endif
-    // _WX_REGION_H_
+    long                            m_lCurrent;
+    long                            m_lNumRects;
+    wxRegion                        m_vRegion;
+    wxRect*                         m_pRects;
+
+    DECLARE_DYNAMIC_CLASS(wxRegionIterator)
+}; // end of wxRegionIterator
+
+#endif // _WX_OS2_REGION_H_