-/////////////////////////////////////////////////////////////////////////////
-// Name: region.h
-// Purpose: wxRegion class
-// Author: Julian Smart
-// Modified by:
-// Created: 17/09/98
-// RCS-ID: $Id$
-// Copyright: (c) Julian Smart
-// Licence: wxWindows licence
-/////////////////////////////////////////////////////////////////////////////
-
-#ifndef _WX_REGION_H_
-#define _WX_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"
-
-// ----------------------------------------------------------------------------
-// A list of rectangles type used by wxRegion and wxWindow
-// ----------------------------------------------------------------------------
-
-WX_DECLARE_LIST(wxRect, wxRectList);
-
-
-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;
-public:
- wxRegion(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
- wxRegion(const wxPoint& topLeft, const wxPoint& bottomRight);
- wxRegion(const wxRect& rect);
- wxRegion();
- wxRegion( const wxBitmap& bmp)
- {
- Union(bmp);
- }
- wxRegion( const wxBitmap& bmp,
- const wxColour& transColour, int tolerance = 0)
- {
- Union(bmp, transColour, tolerance);
- }
- ~wxRegion();
-
- //# 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();
-
- // 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 ;
-
- // Is region empty?
- bool Empty() const;
- inline bool IsEmpty() const { return Empty(); }
- bool Ok() const { return (m_refData != NULL) ; }
-
- //# 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
- 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 the internal Region handle
- WXRegion GetXRegion() const;
-
- // 'Naughty' functions that allow wxWidgets to use a list of rects
- // instead of the region, in certain circumstances (e.g. when
- // making a region out of the update rectangles).
- // These are used by wxPaintDC::wxPaintDC and wxRegionIterator::Reset.
- bool UsingRects() const;
- wxRect* GetRects();
- int GetRectCount() const;
- void SetRects(const wxRectList& rectList);
- void SetRects(int count, const wxRect* rects);
-};
-
-class WXDLLEXPORT wxRegionIterator : public wxObject {
- DECLARE_DYNAMIC_CLASS(wxRegionIterator)
-public:
- wxRegionIterator();
- wxRegionIterator(const wxRegion& region);
- ~wxRegionIterator();
-
- void Reset() { m_current = 0; }
- void Reset(const wxRegion& region);
-
- operator bool () const { return m_current < m_numRects; }
- bool HaveRects() const { return m_current < m_numRects; }
-
- void operator ++ ();
- 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()); }
-
-private:
- size_t m_current;
- size_t m_numRects;
- wxRegion m_region;
- wxRect* m_rects;
-};
-
-#endif
-// _WX_REGION_H_
projects / wxWidgets.git / commitdiff
