wxPython API Documentation

Welcome! This is the API reference documentation for the 4.2.2 release of wxPython Phoenix, built on 12 September 2024.

If you are porting your code from Classic wxPython, be sure to read the Migration Guide to get a better feel for how some things have changed.

You can download a local copy of this documentation using a new utility script included with wxPython called wxdocs. It will open the local copy of the documentation in your default browser, downloading it first if needed. There is also a similar tool called wxdemo that will download (if needed) and launch the wxPython demo for you.

Note

If you wish to help in the documentation effort, the main docstrings guidelines are outlined in the Docstring Guidelines document.

Sections

wx Overview Documents A collection of overview and how-to documents about various wx topics. wx functions The index of top-level functions available in the wx package.

Modules

wx The classes which appear in the main wx namespace wx.adv Less commonly used or more advanced classes wx.grid Widget and supporting classes for displaying and editing tabular data wx.dataview Classes for viewing tabular or hierarchical data wx.richtext A generic, ground-up implementation of a text control capable of showing multiple text styles and images. wx.ribbon A set of classes for writing a ribbon-based UI, typically a combination of tabs and toolbar, similar to the UI in MS Office and Windows 10. wx.html Widget and supporting classes for a generic html renderer wx.html2 Widget and supporting classes for a native html renderer, with CSS and javascript support wx.aui Docking/floating window panes, draggable notebook tabs, etc. wx.svg Classes to parse and render Scalable Vector Graphics files.

wx.lib Our pure-Python library of widgets wx.glcanvas Classes for embedding OpenGL views in a window wx.stc Classes for Styled Text Control, a.k.a Scintilla wx.msw A few classes available only on Windows wx.media MediaCtrl and related classes wx.propgrid PropertyGrid and related classes for editing a grid of name/value pairs. wx.xrc Classes for loading widgets and layout from XML wx.xml Some simple XML classes for use with XRC wx.py The py package, containing PyCrust and related modules wx.tools Some useful tools and utilities for wxPython. functions Top-level functions in the wx package.