X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e5e10e234e2325fa6e25b23098470c5015e07a01..6e36db5ecaca60f633fa3321b30feae863eaeecd:/interface/wx/dc.h?ds=sidebyside

diff --git a/interface/wx/dc.h b/interface/wx/dc.h
index e1f100f64c..e8e54c4526 100644
--- a/interface/wx/dc.h
+++ b/interface/wx/dc.h
@@ -1548,10 +1548,12 @@ public:
 /**
     @class wxDCClipper
 
-    wxDCClipper is a small helper class for setting a clipping region on a wxDC
-    and unsetting it automatically. 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:
+    wxDCClipper is a helper class for setting a clipping region on a wxDC
+    during its lifetime.
+
+    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
     void MyFunction(wxDC& dc)
@@ -1568,6 +1570,12 @@ public:
     }
     @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}
     @category{gdi}