adding command key accelerator

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

diff --git a/include/wx/os2/region.h b/include/wx/os2/region.h
index e524cc157e7f2f1fb089b61e16c49cc85cfc7a76..b19dfd045da0fbf3fd71595423c1e10c50bc27d2 100644 (file)
--- a/include/wx/os2/region.h
+++ b/include/wx/os2/region.h
@@ -15,124 +15,259 @@
 #include "wx/list.h"
 #include "wx/gdiobj.h"
 #include "wx/gdicmn.h"
 #include "wx/list.h"
 #include "wx/gdiobj.h"
 #include "wx/gdicmn.h"

+#include "wx/bitmap.h"
+#include "wx/os2/private.h"

 
 class WXDLLEXPORT wxRect;
 class WXDLLEXPORT wxPoint;
 
 
 class WXDLLEXPORT wxRect;
 class WXDLLEXPORT wxPoint;
 

-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.
-};
-
-class WXDLLEXPORT wxRegion : public wxGDIObject {
-DECLARE_DYNAMIC_CLASS(wxRegion);
-    friend class WXDLLEXPORT wxRegionIterator;
+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
+{

 public:
 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( const wxBitmap& bmp)
+    {
+        Union(bmp);
+    }
+    wxRegion( const wxBitmap& bmp,
+              const wxColour& transColour, int tolerance = 0)
+    {
+        Union(bmp, transColour, tolerance);
+    }

 
     wxRegion();
     ~wxRegion();
 
 
     wxRegion();
     ~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
     // Clear current region

-    void Clear();
+    //
+    void Clear(void);

 
 

+    bool Offset( wxCoord x
+                ,wxCoord y
+               );
+
+    //

     // Union rectangle or region with this.
     // 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); }
+    //
+    inline bool Union( wxCoord x
+                      ,wxCoord y
+                      ,wxCoord vWidth
+                      ,wxCoord vHeight
+                     )
+    {
+        return Combine( x
+                       ,y
+                       ,vWidth
+                       ,vHeight
+                       ,wxRGN_OR
+                      );
+    }
+    inline bool Union( const wxRect& rRect) { return Combine(rRect, wxRGN_OR); }
+    inline bool Union(const wxRegion& rRegion) { return Combine(rRegion, wxRGN_OR); }

 
 

+    //

     // Intersect rectangle or region with this.
     // 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); }
+    //
+    inline bool Intersect( wxCoord x
+                          ,wxCoord y
+                          ,wxCoord vWidth
+                          ,wxCoord vHeight
+                         )
+    {
+        return Combine( x
+                       ,y
+                       ,vWidth
+                       ,vHeight
+                       ,wxRGN_AND
+                      );
+    }
+    inline bool Intersect(const wxRect& rRect)  { return Combine(rRect, wxRGN_AND); }
+    inline bool Intersect(const wxRegion& rRegion)  { return Combine(rRegion, wxRGN_AND); }

 
 

+    //

     // Subtract rectangle or region from this:
     // Combines the parts of 'this' that are not part of the second region.
     // 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); }
+    //
+    inline bool Subtract( wxCoord x
+                         ,wxCoord y
+                         ,wxCoord vWidth
+                         ,wxCoord vHeight
+                        )
+    {
+        return Combine( x
+                       ,y
+                       ,vWidth
+                       ,vHeight
+                       ,wxRGN_DIFF
+                      );
+    }
+    inline bool Subtract(const wxRect& rRect)  { return Combine(rRect, wxRGN_DIFF); }
+    inline bool Subtract(const wxRegion& rRegion)  { return Combine(rRegion, wxRGN_DIFF); }

 
 

+    //

     // XOR: the union of two combined regions except for any overlapping areas.
     // 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); }
+    //
+    inline bool Xor( wxCoord x
+                    ,wxCoord y
+                    ,wxCoord vWidth
+                    ,wxCoord vHeight
+                   )
+    {
+        return Combine( x
+                       ,y
+                       ,vWidth
+                       ,vHeight
+                       ,wxRGN_XOR
+                      );
+    }
+    inline bool Xor(const wxRect& rRect)  { return Combine(rRect, wxRGN_XOR); }
+    inline bool Xor(const wxRegion& rRegion)  { return Combine(rRegion, wxRGN_XOR); }

 
 

-    //# Information on region
+    //
+    // Information on region

     // Outer bounds of region
     // Outer bounds of region

-    void GetBox(wxCoord& x, wxCoord& y, wxCoord&w, wxCoord &h) const;
-    wxRect GetBox() const ;
+    //
+    void   GetBox( wxCoord& rX
+                  ,wxCoord& rY
+                  ,wxCoord& rWidth
+                  ,wxCoord& rHeight
+                 ) const;
+    wxRect GetBox(void) const;

 
 

+    //

     // Is region empty?
     // Is region empty?

-    bool Empty() const;
+    //
+    bool        Empty(void) const;

     inline bool IsEmpty() const { return Empty(); }
 
     inline bool IsEmpty() const { return Empty(); }
 

-    //# Tests
+    //
+    // Tests

     // Does the region contain the point (x,y)?
     // Does the region contain the point (x,y)?

-    wxRegionContain Contains(wxCoord x, wxCoord y) const;
+    //
+    inline wxRegionContain Contains( wxCoord lX, wxCoord lY ) const{
+        return Contains( wxPoint( lX, lY ) );
+    }
+    //
+    // Convert the region to a B&W bitmap with the black pixels being inside
+    // the region.
+    //
+    wxBitmap        ConvertToBitmap(void) 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);
+
+    //

     // Does the region contain the point pt?
     // Does the region contain the point pt?

-    wxRegionContain Contains(const wxPoint& pt) const;
+    //
+    wxRegionContain Contains(const wxPoint& rPoint) const;
+
+    //

     // Does the region contain the rectangle (x, y, w, h)?
     // Does the region contain the rectangle (x, y, w, h)?

-    wxRegionContain Contains(wxCoord x, wxCoord y, wxCoord w, wxCoord h) const;
+    //
+    wxRegionContain Contains( wxCoord x
+                             ,wxCoord y
+                             ,wxCoord lWidth
+                             ,wxCoord lHeight
+                            ) const;
+
+    //

     // Does the region contain the rectangle rect?
     // Does the region contain the rectangle rect?

-    wxRegionContain Contains(const wxRect& rect) const;
+    //
+    inline wxRegionContain Contains(const wxRect& rRect) const{
+         return Contains( rRect.x, rRect.y,
+                          rRect.GetWidth(), rRect.GetHeight());
+    }

 
 

-// 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);
+    //
+    // Internal
+    //
+    bool Combine( wxCoord    x
+                 ,wxCoord    y
+                 ,wxCoord    vWidth
+                 ,wxCoord    vHeight
+                 ,wxRegionOp eOp
+                );
+    bool Combine( const wxRegion& rRegion
+                 ,wxRegionOp      eOp
+                );
+    bool Combine( const wxRect& rRect
+                 ,wxRegionOp    eOp
+                );

 
 

+    //

     // Get internal region handle
     // Get internal region handle

-    WXHRGN GetHRGN() const;
-};
+    //
+    WXHRGN GetHRGN(void) const;
+    void   SetPS(HPS hPS);
+
+protected:
+    virtual wxObjectRefData* CreateData(void) const;
+    virtual wxObjectRefData* CloneData(const wxObjectRefData* pData) const;
+
+    friend class WXDLLEXPORT wxRegionIterator;
+    DECLARE_DYNAMIC_CLASS(wxRegion);
+
+}; // end of CLASS wxRegion

 
 

-class WXDLLEXPORT wxRegionIterator : public wxObject {
+class WXDLLEXPORT wxRegionIterator : public wxObject
+{

 DECLARE_DYNAMIC_CLASS(wxRegionIterator);
 public:
     wxRegionIterator();
 DECLARE_DYNAMIC_CLASS(wxRegionIterator);
 public:
     wxRegionIterator();

-    wxRegionIterator(const wxRegion& region);
+    wxRegionIterator(const wxRegion& rRegion);

     ~wxRegionIterator();
 
     ~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);
 
     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:
 
 private:

-    long     m_current;
-    long     m_numRects;
-    wxRegion m_region;
-    wxRect*  m_rects;
-};
+    long                            m_lCurrent;
+    long                            m_lNumRects;
+    wxRegion                        m_vRegion;
+    wxRect*                         m_pRects;
+}; // end of wxRegionIterator

 
 #endif
     // _WX_REGION_H_
 
 #endif
     // _WX_REGION_H_