wx.ClientDC¶

Deprecated class for drawing on the client area of a window.

wx.ClientDC should not be used any longer, please use InfoDC instead for obtaining information about the device context associated with a window.

wx.ClientDC objects should normally be constructed as temporary stack objects, i.e. don’t store a wx.ClientDC object.

A wx.ClientDC object is initialized to use the same font and colours as the window it is associated with.

Note

While wx.ClientDC may also be used for drawing on the client area of a window from outside an EVT_PAINT() handler in some ports, this does not work on all platforms: neither wxOSX nor wxGTK with GTK 3 Wayland backend support this at all, so drawing using wx.ClientDC simply doesn’t have any effect there. CanBeUsedForDrawing can be used to determine whether wx.ClientDC can be used for drawing in the current environment, but it is recommended to only draw on the window using wx.PaintDC, as this is guaranteed to work everywhere. To redraw a small part of the window, use wx.Window.RefreshRect to invalidate just this part and check wx.Window.GetUpdateRegion in the paint event handler to redraw this part only.

Class Hierarchy¶

Inheritance diagram for class ClientDC:

Known Subclasses¶

wx.PaintDC

Methods Summary¶

`__init__`	Constructor.
`CanBeUsedForDrawing`	Return `True` if drawing on wx.ClientDC actually works.

Class API¶

class wx.ClientDC(WindowDC)¶

Possible constructors:

ClientDC(window) -> None

Deprecated class for drawing on the client area of a window.

Methods¶

__init__(self, window)¶

Constructor.

Pass a pointer to the window on which you wish to paint.

Parameters:: window (wx.Window)
Return type:: None

static CanBeUsedForDrawing(window)¶

Return True if drawing on wx.ClientDC actually works.

In many environments (currently this includes wxGTK when using Wayland backend, wxMSW when using double buffering and wxOSX in all cases), wx.ClientDC can be only used for obtaining information about the device context, but not for actually drawing on it. Portable code should avoid using wx.ClientDC completely, as explained in the class documentation, but it is also possible to optionally use it only when it does work, i.e. when this function returns True.

Parameters:: window (wx.Window) – The window that would be used with wx.ClientDC.
Return type:: bool

Added in version 4.3/wxWidgets-3.3.0.

Navigation