Document that wxDCClipper currently resets clipping region.

Unlike other similar classes, this one doesn't restore the previous clipping
region but just resets it because there is no way to get the current clipping
region from wxDC now. At least document this limitation until it can be fixed.

See #13834.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71296 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2012-04-28 22:24:31 +00:00
parent d6256ab96d
commit 586f402336

View File

@@ -1548,10 +1548,12 @@ public:
/** /**
@class wxDCClipper @class wxDCClipper
wxDCClipper is a small helper class for setting a clipping region on a wxDC wxDCClipper is a helper class for setting a clipping region on a wxDC
and unsetting it automatically. An object of wxDCClipper class is typically during its lifetime.
created on the stack so that it is automatically destroyed when the object
goes out of scope. A typical usage example: An object of wxDCClipper class is typically created on the stack so that it
is automatically destroyed when the object goes out of scope. A typical
usage example:
@code @code
void MyFunction(wxDC& dc) void MyFunction(wxDC& dc)
@@ -1568,6 +1570,12 @@ public:
} }
@endcode @endcode
@note Unlike other similar classes such as wxDCFontChanger, wxDCClipper
currently doesn't restore the previously active clipping region when it
is destroyed but simply resets clipping on the associated wxDC. This
may be changed in the future wxWidgets versions but has to be taken
into account explicitly in the current one.
@library{wxcore} @library{wxcore}
@category{gdi} @category{gdi}