document that setting an empty clipping region destroys the existing one

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@60545 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin 2009-05-07 08:58:54 +00:00
parent 6e1881bec4
commit 3821ccfaa6

View File

@ -602,13 +602,20 @@ public:
/**
Sets the clipping region for this device context to the intersection of
the given region described by the parameters of this method and the
previously set clipping region. You should call DestroyClippingRegion()
if you want to set the clipping region exactly to the region specified.
previously set clipping region.
The clipping region is an area to which drawing is restricted. Possible
uses for the clipping region are for clipping text or for speeding up
window redraws when only a known area of the screen is damaged.
Notice that you need to call DestroyClippingRegion() if you want to set
the clipping region exactly to the region specified.
Also note that if the clipping region is empty, any previously set
clipping region is destroyed, i.e. it is equivalent to calling
DestroyClippingRegion(), and not to clipping out all drawing on the DC
as might be expected.
@see DestroyClippingRegion(), wxRegion
*/
void SetClippingRegion(wxCoord x, wxCoord y, wxCoord width, wxCoord height);