wx.DCClipper

wx.DCClipper is a helper class for setting a clipping region on a wx.DC during its lifetime.

An object of wx.DCClipper class is typically created on the stack so that it is automatically destroyed when the object goes out of scope. A typical usage example:

def MyFunction(dc):

    clip = wx.DCClipper(dc, rect)
    # ... drawing functions here are affected by clipping rect ...


def OtherFunction():

    dc = wx.DC()
    MyFunction(dc)
    # ... drawing functions here are not affected by clipping rect ...

Note

Unlike other similar classes such as wx.DCFontChanger, wx.DCClipper currently doesn’t restore the previously active clipping region when it is destroyed but simply resets clipping on the associated wx.DC. This may be changed in the future wxWidgets versions but has to be taken into account explicitly in the current one.

See also

wx.DC.SetClippingRegion , wx.DCFontChanger, wx.DCTextColourChanger, wx.DCPenChanger, wx.DCBrushChanger

Class Hierarchy

Inheritance diagram for class DCClipper:

Methods Summary

__init__	Sets the clipping region to the specified region/coordinates.
__enter__
__exit__

Class API

---

class wx.DCClipper(object)

Possible constructors:

DCClipper(dc, region)

DCClipper(dc, rect)

DCClipper(dc, x, y, w, h)

DCClipper is a helper class for setting a clipping region on a DC during its lifetime.

Methods

---

__init__(self, *args, **kw)

Sets the clipping region to the specified region/coordinates.

The clipping region is automatically unset when this object is destroyed.

Overloaded Implementations:

---

__init__ (self, dc, region)

Parameters:

• dc (wx.DC) –
• region (wx.Region) –

---

__init__ (self, dc, rect)

Parameters:

• dc (wx.DC) –
• rect (wx.Rect) –

---

__init__ (self, dc, x, y, w, h)

Parameters:

• dc (wx.DC) –
• x (int) –
• y (int) –
• w (int) –
• h (int) –

---

---

__enter__(self)

---

__exit__(self, exc_type, exc_val, exc_tb)