wx

The classes in this module are the most commonly used classes for wxPython, which is why they have been made visible in the core wx namespace. Everything you need for building typical GUI applications is here.

Class Summary

Class

Short Description

AcceleratorEntry

An object used by an application wishing to create an accelerator table (see wx.AcceleratorTable).

AcceleratorTable

An accelerator table allows the application to specify a table of keyboard shortcuts for menu or button commands.

Accessible

The wx.Accessible class allows wxWidgets applications, and wxWidgets itself, to return extended information about user interface elements to client applications such as screen readers.

ActivateEvent

An activate event is sent when a window or application is being activated or deactivated.

AffineMatrix2D

A 3x2 matrix representing an affine 2D transformation.

AffineMatrix2DBase

A 2x3 matrix representing an affine 2D transformation.

AlphaPixelData

A class providing direct access to a wx.Bitmap’s

AlphaPixelData_Accessor

AnyButton

A class for common button functionality used as the base for the various button classes.

App

The wx.App class represents the application and is used to:

AppConsole

This class is essential for writing console-only or hybrid apps without having to define USE_GUI=0 .

AppTraits

The wx.AppTraits class defines various configurable aspects of a wx.App.

ArchiveFSHandler

A file system handler for accessing files inside of archives.

ArtProvider

wx.ArtProvider class is used to customize the look of wxWidgets application.

AutoBufferedPaintDC

This wx.DC derivative can be used inside of an EVT_PAINT() event handler to achieve double-buffered drawing.

Bitmap

This class encapsulates the concept of a platform-dependent bitmap, either monochrome or colour or colour with alpha channel support.

BitmapButton

A bitmap button is a control that contains a bitmap.

BitmapDataObject

wx.BitmapDataObject is a specialization of wx.DataObject for bitmap data.

BitmapToggleButton

wx.BitmapToggleButton is a wx.ToggleButton that contains a bitmap instead of text.

BookCtrlBase

A book control is a convenient way of displaying multiple pages of information, displayed one page at a time.

BookCtrlEvent

This class represents the events generated by book controls ( wx.Notebook, wx.Listbook, wx.Choicebook, wx.Treebook, wx.aui.AuiNotebook).

BoxSizer

The basic idea behind a box sizer is that windows will most often be laid out in rather simple basic geometry, typically in a row or a column or several hierarchies of either.

Brush

A brush is a drawing tool for filling in areas.

BrushList

A brush list is a list containing all brushes which have been created.

BufferedDC

This class provides a simple way to avoid flicker: when drawing on it, everything is in fact first drawn on an in-memory buffer (a wx.Bitmap) and then copied to the screen, using the associated wx.DC, only once, when this object is destroyed.

BufferedPaintDC

This is a subclass of wx.BufferedDC which can be used inside of an EVT_PAINT() event handler to achieve double-buffered drawing.

BusyCursor

This class makes it easy to tell your user that the program is temporarily busy.

BusyInfo

This class makes it easy to tell your user that the program is temporarily busy.

BusyInfoFlags

Parameters for wx.BusyInfo.

Button

A button is a control that contains a text string, and is one of the most common elements of a GUI.

CallLater

A convenience class for wx.Timer, that calls the given callable

Caret

A caret is a blinking cursor showing the position where the typed text will appear.

CheckBox

A checkbox is a labelled box which by default is either on (checkmark is visible) or off (no checkmark).

CheckListBox

A wx.CheckListBox is like a wx.ListBox, but allows items to be checked or unchecked.

ChildFocusEvent

A child focus event is sent to a (parent-)window when one of its child windows gains focus, so that the window could restore the focus back to its corresponding child if it loses it now and regains later.

ChildrenRepositioningGuard

Helper for ensuring EndRepositioningChildren is called correctly.

Choice

A choice item is used to select one of a list of strings.

Choicebook

wx.Choicebook is a class similar to wx.Notebook, but uses a wx.Choice control to show the labels instead of the tabs.

ClassInfo

This class stores meta-information about classes.

ClientDataContainer

This class is a mixin that provides storage and management of “client data”.

ClientDC

A wx.ClientDC must be constructed if an application wishes to paint on the client area of a window from outside an EVT_PAINT() handler.

Clipboard

A class for manipulating the clipboard.

ClipboardTextEvent

This class represents the events generated by a control (typically a wx.TextCtrl but other windows can generate these events as well) when its content gets copied or cut to, or pasted from the clipboard.

CloseEvent

This event class contains information about window and session close events.

CollapsiblePane

A collapsible pane is a container with an embedded button-like control which can be used by the user to collapse or expand the pane’s contents.

CollapsiblePaneEvent

This event class is used for the events generated by wx.CollapsiblePane.

Colour

A colour is an object representing a combination of Red, Green, and Blue (RGB) intensity values and an Alpha value, and is used to determine drawing colours.

ColourData

This class holds a variety of information related to colour dialogs.

ColourDatabase

wxWidgets maintains a database of standard RGB colours for a predefined set of named colours.

ColourDialog

This class represents the colour chooser dialog.

ColourDialogEvent

This event class is used for the events generated by wx.ColourDialog.

ColourPickerCtrl

This control allows the user to select a colour.

ColourPickerEvent

This event class is used for the events generated by wx.ColourPickerCtrl.

ComboBox

A combobox is like a combination of an edit control and a listbox.

ComboCtrl

A combo control is a generic combobox that allows totally custom popup.

ComboCtrlFeatures

Features enabled for wx.ComboCtrl.

ComboPopup

In order to use a custom popup with wx.ComboCtrl, an interface class must be derived from wx.ComboPopup.

Command

wx.Command is a base class for modelling an application command, which is an action usually performed by selecting a menu item, pressing a toolbar button or any other means provided by the application to change the data or view.

CommandEvent

This event class contains information about command events, which originate from a variety of simple controls.

CommandProcessor

wx.CommandProcessor is a class that maintains a history of Commands, with undo/redo functionality built-in.

ConfigBase

wx.ConfigBase defines the basic interface of all config classes.

ConfigPathChanger

A handy little class which changes the current path in a Config object and restores it in dtor.

ContextHelp

This class changes the cursor to a query and puts the application into a ‘context-sensitive help mode’.

ContextHelpButton

Instances of this class may be used to add a question mark button that when pressed, puts the application into context-help mode.

ContextMenuEvent

This class is used for context menu events, sent to give the application a chance to show a context (popup) menu for a wx.Window.

Control

This is the base class for a control or “widget”.

ControlWithItems

This is convenience class that derives from both wx.Control and wx.ItemContainer.

Cursor

A cursor is a small bitmap usually used for denoting where the mouse pointer is, with a picture that might indicate the interpretation of a mouse click.

CustomDataObject

wx.CustomDataObject is a specialization of wx.DataObjectSimple for some application-specific data in arbitrary (either custom or one of the standard ones).

DataFormat

A wx.DataFormat is an encapsulation of a platform-specific format handle which is used by the system for the clipboard and drag and drop operations.

DataObject

A wx.DataObject represents data that can be copied to or from the clipboard, or dragged and dropped.

DataObjectComposite

wx.DataObjectComposite is the simplest wx.DataObject derivation which may be used to support multiple formats.

DataObjectSimple

This is the simplest possible implementation of the wx.DataObject class.

DateSpan

This class is a “logical time span” and is useful for implementing program logic for such things as “add one month to the date” which, in general, doesn’t mean to add 60x60x24x31 seconds to it, but to take the same date the next month (to understand that this is indeed different consider adding one month to Feb, 15

DateTime

wx.DateTime class represents an absolute moment in time.

DC

A wx.DC is a “device context” onto which graphics and text can be drawn.

DCBrushChanger

wx.DCBrushChanger is a small helper class for setting a brush on a wx.DC and unsetting it automatically in the destructor, restoring the previous one.

DCClipper

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

DCFontChanger

wx.DCFontChanger is a small helper class for setting a font on a wx.DC and unsetting it automatically in the destructor, restoring the previous one.

DCOverlay

Connects an overlay with a drawing DC.

DCPenChanger

wx.DCPenChanger is a small helper class for setting a pen on a wx.DC and unsetting it automatically in the destructor, restoring the previous one.

DCTextBgColourChanger

wx.DCTextBgColourChanger is a small helper class for setting a background text colour on a wx.DC and unsetting it automatically in the destructor, restoring the previous one.

DCTextBgModeChanger

wx.DCTextBgModeChanger is a small helper class for setting a background text mode on a wx.DC and unsetting it automatically in the destructor, restoring the previous one.

DCTextColourChanger

wx.DCTextColourChanger is a small helper class for setting a foreground text colour on a wx.DC and unsetting it automatically in the destructor, restoring the previous one.

DelegateRendererNative

wx.DelegateRendererNative allows reuse of renderers code by forwarding all the wx.RendererNative methods to the given object and thus allowing you to only modify some of its methods

Dialog

A dialog box is a window with a title bar and sometimes a system menu, which can be moved around the screen.

DialogLayoutAdapter

This abstract class is the base for classes that help wxWidgets perform run-time layout adaptation of dialogs.

DirDialog

This class represents the directory chooser dialog.

DirFilterListCtrl

DirPickerCtrl

This control allows the user to select a directory.

Display

Determines the sizes and locations of displays connected to the system.

DisplayChangedEvent

A display changed event is sent to top-level windows when the display resolution has changed.

DPIChangedEvent

Event sent when the display scale factor or pixel density (measured in dots-per-inch, or DPI) of the monitor a window is on changes.

DragImage

This class is used when you wish to drag an object on the screen, and a simple cursor is not enough.

DropFilesEvent

This class is used for drop files events, that is, when files have been dropped onto the window.

DropSource

This class represents a source for a drag and drop operation.

DropTarget

This class represents a target for a drag and drop operation.

EraseEvent

An erase event is sent when a window’s background needs to be repainted.

Event

An event is a structure holding information about an event passed to a callback or member function.

EventBlocker

This class is a special event handler which allows discarding any event (or a set of event types) directed to a specific window.

EventFilter

A global event filter for pre-processing all the events generated in the program.

EventLoopActivator

Makes an event loop temporarily active.

EventLoopBase

Base class for all event loop implementations.

EvtHandler

A class that can handle events from the windowing system.

FileConfig

wx.FileConfig implements wx.ConfigBase interface for storing and retrieving configuration information using plain text files.

FileCtrl

This control allows the user to select a file.

FileCtrlEvent

A file control event holds information about events associated with wx.FileCtrl objects.

FileDataObject

wx.FileDataObject is a specialization of wx.DataObject for file names.

FileDialog

This class represents the file chooser dialog.

FileDirPickerEvent

This event class is used for the events generated by wx.FilePickerCtrl and by wx.DirPickerCtrl.

FileDropTarget

This is a drop target which accepts files (dragged from File Manager or Explorer).

FileHistory

The wx.FileHistory encapsulates a user interface convenience, the list of most recently visited files as shown on a menu (usually the File menu).

FilePickerCtrl

This control allows the user to select a file.

FileSystem

This class provides an interface for opening files on different file systems.

FileSystemHandler

Classes derived from wx.FileSystemHandler are used to access virtual file systems.

FileSystemWatcher

The wx.FileSystemWatcher class allows receiving notifications of file system changes.

FileSystemWatcherEvent

A class of events sent when a file system event occurs.

FileTranslationsLoader

Standard wx.TranslationsLoader implementation.

FileType

This class holds information about a given file type.

FileTypeInfo

Container of information about wx.FileType.

FilterFSHandler

Filter file system handler.

FindDialogEvent

wx.FindReplaceDialog events.

FindReplaceData

wx.FindReplaceData holds the data for wx.FindReplaceDialog.

FindReplaceDialog

wx.FindReplaceDialog is a standard modeless dialog which is used to allow the user to search for some text (and possibly replace it with something else).

FlexGridSizer

A flex grid sizer is a sizer which lays out its children in a two-dimensional table with all table fields in one row having the same height and all fields in one column having the same width, but all rows or all columns are not necessarily the same height or width as in the wx.GridSizer.

FocusEvent

A focus event is sent when a window’s focus changes.

Font

A font is an object which determines the appearance of text.

FontData

This class holds a variety of information related to font dialogs.

FontDialog

This class represents the font chooser dialog.

FontEnumerator

wx.FontEnumerator enumerates either all available fonts on the system or only the ones with given attributes - either only fixed-width (suited for use in programs such as terminal emulators and the like) or the fonts available in the given encoding).

FontInfo

This class is a helper used for wx.Font creation using named parameter idiom: it allows specifying various wx.Font attributes using the chained calls to its clearly named methods instead of passing them in the fixed order to wx.Font constructors.

FontList

A font list is a list containing all fonts which have been created.

FontMapper

wx.FontMapper manages user-definable correspondence between logical font names and the fonts present on the machine.

FontMetrics

Simple collection of various font metrics.

FontPickerCtrl

This control allows the user to select a font.

FontPickerEvent

This event class is used for the events generated by wx.FontPickerCtrl.

Frame

A frame is a window whose size and position can (usually) be changed by the user.

FSFile

This class represents a single file opened by wx.FileSystem.

Gauge

A gauge is a horizontal or vertical bar which shows a quantity (often time).

GBPosition

This class represents the position of an item in a virtual grid of rows and columns managed by a wx.GridBagSizer.

GBSizerItem

The wx.GBSizerItem class is used by the wx.GridBagSizer for tracking the items in the sizer.

GBSpan

This class is used to hold the row and column spanning attributes of items in a wx.GridBagSizer.

GCDC

wx.GCDC is a device context that draws on a wx.GraphicsContext.

GDIObject

This class allows platforms to implement functionality to optimise GDI objects, such as wx.Pen, wx.Brush and wx.Font.

GenericDirCtrl

This control can be used to place a directory listing (with optional files) on an arbitrary window.

GenericDragImage

This class is used when you wish to drag an object on the screen, and a simple cursor is not enough.

GenericMessageDialog

This class represents a dialog that shows a single or multi-line message, with a choice of wx.OK, Yes, No and Cancel buttons.

GenericProgressDialog

This class represents a dialog that shows a short message and a progress bar.

GeometrySerializer

Class used with SaveGeometry and RestoreToGeometry.

GestureEvent

This is the base class for all supported gesture events.

GIFHandler

This is the image handler for the GIF format.

GraphicsBitmap

Represents a bitmap.

GraphicsBrush

A wx.GraphicsBrush is a native representation of a brush.

GraphicsContext

A wx.GraphicsContext instance is the object that is drawn upon.

GraphicsFont

A wx.GraphicsFont is a native representation of a font.

GraphicsGradientStop

Represents a single gradient stop in a collection of gradient stops as represented by wx.GraphicsGradientStops.

GraphicsGradientStops

Represents a collection of GraphicGradientStop values for use with CreateLinearGradientBrush and CreateRadialGradientBrush.

GraphicsMatrix

A wx.GraphicsMatrix is a native representation of an affine matrix.

GraphicsObject

This class is the superclass of native graphics objects like pens etc.

GraphicsPath

A wx.GraphicsPath is a native representation of a geometric path.

GraphicsPen

A wx.GraphicsPen is a native representation of a pen.

GraphicsPenInfo

This class is a helper used for wx.GraphicsPen creation using named parameter idiom: it allows specifying various wx.GraphicsPen attributes using the chained calls to its clearly named methods instead of passing them in the fixed order to wx.GraphicsPen constructors.

GraphicsRenderer

A wx.GraphicsRenderer is the instance corresponding to the rendering engine used.

GridBagSizer

A wx.Sizer that can lay out items in a virtual grid like a wx.FlexGridSizer but in this case explicit positioning of the items is allowed using wx.GBPosition, and items can optionally span more than one row and/or column using wx.GBSpan.

GridSizer

A grid sizer is a sizer which lays out its children in a two-dimensional table with all table fields having the same size, i.e.

GUIEventLoop

A generic implementation of the GUI event loop.

HeaderButtonParams

This struct can optionally be used with wx.RendererNative.DrawHeaderButton to specify custom values used to draw the text or bitmap label.

HeaderColumn

Represents a column header in controls displaying tabular data such as wx.dataview.DataViewCtrl or wx.grid.Grid.

HeaderColumnSimple

Simple container for the information about the column.

HeaderCtrl

wx.HeaderCtrl is the control containing the column headings which is usually used for display of tabular data.

HeaderCtrlEvent

Event class representing the events generated by wx.HeaderCtrl.

HeaderCtrlSimple

wx.HeaderCtrlSimple is a concrete header control which can be used directly, without inheriting from it as you need to do when using wx.HeaderCtrl itself.

HelpControllerBase

This is the abstract base class a family of classes by which applications may invoke a help viewer to provide on-line help.

HelpControllerHelpProvider

wx.HelpControllerHelpProvider is an implementation of wx.HelpProvider which supports both context identifiers and plain text help strings.

HelpEvent

A help event is sent when the user has requested context-sensitive help.

HelpProvider

wx.HelpProvider is an abstract class used by a program implementing context-sensitive help to show the help text for the given window.

HScrolledWindow

In the name of this class, “H” stands for “horizontal” because it can be used for scrolling columns of variable widths.

HSVValue

A simple class which stores hue, saturation and value as doubles in the range 0.0-1.0.

HTMLDataObject

wx.HTMLDataObject is used for working with HTML-formatted text.

HVScrolledWindow

This window inherits all functionality of both vertical and horizontal, variable scrolled windows.

Icon

An icon is a small rectangular bitmap usually used for denoting a minimized application.

IconBundle

This class contains multiple copies of an icon in different sizes.

IconizeEvent

An event being sent when the frame is iconized (minimized) or restored.

IconLocation

wx.IconLocation is a tiny class describing the location of an (external, i.e.

IdleEvent

This class is used for idle events, which are generated when the system becomes idle.

IdManager

wx.IdManager is responsible for allocating and releasing window IDs.

IFFHandler

This is the image handler for the IFF format.

Image

This class encapsulates a platform-independent image.

ImageHandler

This is the base class for implementing image file loading/saving, and image creation from data.

ImageHistogram

ImageList

A wx.ImageList contains a list of images, which are stored in an unspecified form.

IndividualLayoutConstraint

InfoBar

An info bar is a transient window shown at top or bottom of its parent window to display non-critical information to the user.

InitDialogEvent

A wx.InitDialogEvent is sent as a dialog or panel is being initialised.

InputStream

wx.InputStream is an abstract base class which may not be used directly.

InternetFSHandler

A file system handler for accessing files from internet servers.

ItemAttr

Represents the attributes (colour, font, …) of an item of a control with multiple items such as e.g.

ItemContainer

This class is an abstract base class for some wxWidgets controls which contain several items such as wx.ListBox, wx.CheckListBox, wx.ComboBox or wx.Choice.

ItemContainerImmutable

wx.ItemContainer defines an interface which is implemented by all controls which have string subitems each of which may be selected.

JoystickEvent

This event class contains information about joystick events, particularly events received by windows.

JPEGHandler

This is the image handler for the JPEG format.

KeyboardState

Provides methods for testing the state of the keyboard modifier keys.

KeyEvent

This event class contains information about key press and release events.

LanguageInfo

Encapsulates a wx.Language identifier together with OS-specific information related to that language.

LayoutConstraints

LinuxDistributionInfo

A structure containing information about a Linux distribution as returned by the lsb_release utility.

Listbook

wx.Listbook is a class similar to wx.Notebook but which uses a wx.ListCtrl to show the labels instead of the tabs.

ListBox

A listbox is used to select one or more of a list of strings.

ListCtrl

A list control presents lists in a number of formats: list view, report view, icon view and small icon view.

ListEvent

A list event holds information about events associated with wx.ListCtrl objects.

ListItem

This class stores information about a wx.ListCtrl item or column.

ListView

This class currently simply presents a simpler to use interface for the wx.ListCtrl façade for that complicated class.

Locale

wx.Locale class encapsulates all language-dependent settings and is a generalization of the C locale concept.

Log

wx.Log class defines the interface for the log targets used by wxWidgets logging functions as explained in the Logging Overview.

LogBuffer

wx.LogBuffer is a very simple implementation of log sink which simply collects all the logged messages in a string (except the debug messages which are output in the usual way immediately as we’re presumably not interested in collecting them for later).

LogChain

This simple class allows you to chain log sinks, that is to install a new sink but keep passing log messages to the old one instead of replacing it completely as wx.Log.SetActiveTarget does.

LogFormatter

wx.LogFormatter class is used to format the log messages.

LogGui

This is the default log target for the GUI wxWidgets applications.

LogInterposer

A special version of wx.LogChain which uses itself as the new log target.

LogInterposerTemp

A special version of wx.LogChain which uses itself as the new log target.

LogNull

This class allows you to temporarily suspend logging.

LogRecordInfo

Information about a log record (unit of the log output).

LogStderr

This class can be used to redirect the log messages to a C file stream (not to be confused with C++ streams).

LogTextCtrl

Using these target all the log messages can be redirected to a text control.

LogWindow

This class represents a background log window: to be precise, it collects all log messages in the log frame which it manages but also passes them on to the log target which was active at the moment of its creation.

LongPressEvent

This event is generated when one finger touches the surface and remains stationary.

Mask

This class encapsulates a monochrome mask bitmap, where the masked area is black and the unmasked area is white.

Matrix2D

A simple container for 2x2 matrix.

MaximizeEvent

An event being sent when a top level window is maximized.

MDIChildFrame

An MDI child frame is a frame that can only exist inside a wx.MDIClientWindow, which is itself a child of wx.MDIParentFrame.

MDIClientWindow

An MDI client window is a child of wx.MDIParentFrame, and manages zero or more wx.MDIChildFrame objects.

MDIParentFrame

An MDI (Multiple Document Interface) parent frame is a window which can contain MDI child frames in its client area which emulates the full desktop.

MemoryDC

A memory device context provides a means to draw graphics onto a bitmap.

MemoryFSHandler

This wx.FileSystem handler can store arbitrary data in memory stream and make them accessible via an URL.

Menu

A menu is a popup (or pull down) list of items, one of which may be selected before the menu goes away (clicking elsewhere dismisses the menu).

MenuBar

A menu bar is a series of menus accessible from the top of a frame.

MenuEvent

This class is used for a variety of menu-related events.

MenuItem

A menu item represents an item in a menu.

MessageDialog

This class represents a dialog that shows a single or multi-line message, with a choice of wx.OK, Yes, No and Cancel buttons.

MessageParameters

Class representing message parameters.

Metafile

A ** wx.Metafile ** represents the MS Windows metafile object, so metafile operations have no effect in X.

MetafileDC

This is a type of device context that allows a metafile object to be created (Windows only), and has most of the characteristics of a normal ** wx.DC ** .

MimeTypesManager

This class allows the application to retrieve information about all known MIME types from a system-specific location and the filename extensions to the MIME types and vice versa.

MiniFrame

A miniframe is a frame with a small title bar.

MirrorDC

wx.MirrorDC is a simple wrapper class which is always associated with a real wx.DC object and either forwards all of its operations to it without changes (no mirroring takes place) or exchanges x and y coordinates which makes it possible to reuse the same code to draw a figure and its mirror

ModalDialogHook

Allows intercepting all modal dialog calls.

MouseCaptureChangedEvent

An mouse capture changed event is sent to a window that loses its mouse capture.

MouseCaptureLostEvent

A mouse capture lost event is sent to a window that had obtained mouse capture, which was subsequently lost due to an “external” event (for example, when a dialog box is shown or if another application captures the mouse).

MouseEvent

This event class contains information about the events generated by the mouse: they include mouse buttons press and release events and mouse move events.

MouseEventsManager

Helper for handling mouse input events in windows containing multiple items.

MouseState

Represents the mouse state.

MoveEvent

A move event holds information about window position change.

MultiChoiceDialog

This class represents a dialog that shows a list of strings, and allows the user to select one or more.

NativeFontInfo

wx.NativeFontInfo is platform-specific font representation: this class should be considered as an opaque font description only used by the native functions, the user code can only get the objects of this type from somewhere and pass it somewhere else (possibly save them somewhere using wx.ToString and restore them using wx.FromString )

NativePixelData

A class providing direct access to a wx.Bitmap’s

NativePixelData_Accessor

NavigationKeyEvent

This event class contains information about navigation events, generated by navigation keys such as tab and page down.

NonOwnedWindow

Common base class for all non-child windows.

Notebook

This class represents a notebook control, which manages multiple windows with associated tabs.

NotifyEvent

This class is not used by the event handlers by itself, but is a base class for other event classes (such as wx.BookCtrlEvent).

NumberEntryDialog

This class represents a dialog that requests a numeric input from the user.

Object

This is the root class of many of the wxWidgets classes.

OutputStream

wx.OutputStream is an abstract base class which may not be used directly.

Overlay

Creates an overlay over an existing window, allowing for manipulations like rubberbanding, etc.

PageSetupDialog

This class represents the page setup common dialog.

PageSetupDialogData

This class holds a variety of information related to wx.PageSetupDialog.

PaintDC

A wx.PaintDC must be constructed if an application wishes to paint on the client area of a window from within an EVT_PAINT() event handler.

PaintEvent

A paint event is sent when a window’s contents needs to be repainted.

Palette

A palette is a table that maps pixel values to RGB colours.

PaletteChangedEvent

Panel

A panel is a window on which controls are placed.

PanGestureEvent

This event is generated when the user moves a finger on the surface.

PasswordEntryDialog

This class represents a dialog that requests a one-line password string from the user.

PCXHandler

This is the image handler for the PCX format.

Pen

A pen is a drawing tool for drawing outlines.

PenInfo

This class is a helper used for wx.Pen creation using named parameter idiom: it allows specifying various wx.Pen attributes using the chained calls to its clearly named methods instead of passing them in the fixed order to wx.Pen constructors.

PenList

There is only one instance of this class: wx.ThePenList .

PickerBase

Base abstract class for all pickers which support an auxiliary text control.

PixelDataBase

PlatformInformation

This class holds information about the operating system, the toolkit and the basic architecture of the machine where the application is currently running.

PNGHandler

This is the image handler for the PNG format.

PNMHandler

This is the image handler for the PNM format.

Point

A wx.Point is a useful data structure for graphics operations.

Point2D

PopupTransientWindow

A wx.PopupWindow which disappears automatically when the user clicks mouse outside it or if it loses focus in any other way.

PopupWindow

A special kind of top level window used for popup menus, combobox popups and such.

Position

This class represents the position of an item in any kind of grid of rows and columns such as wx.GridBagSizer, or wx.HVScrolledWindow.

PostScriptDC

This defines the wxWidgets Encapsulated PostScript device context, which can write PostScript files on any platform.

PowerEvent

The power events are generated when the system power state changes, e.g.

PowerResource

Helper functions for acquiring and releasing the given power resource.

PowerResourceBlocker

Helper RAII class ensuring that power resources are released.

PreferencesEditor

Manage preferences dialog.

PreferencesPage

One page of preferences dialog.

PressAndTapEvent

This event is generated when the user press the surface with one finger and taps with another.

PreviewCanvas

A preview canvas is the default canvas used by the print preview system to display the preview.

PreviewControlBar

This is the default implementation of the preview control bar, a panel with buttons and a zoom control.

PreviewFrame

This class provides the default method of managing the print preview interface.

PrintAbortDialog

The dialog created by default by the print framework that enables aborting the printing process.

PrintData

This class holds a variety of information related to printers and printer device contexts.

PrintDialog

This class represents the print and print setup common dialogs.

PrintDialogData

This class holds information related to the visual characteristics of wx.PrintDialog.

Printer

This class represents the Windows or PostScript printer, and is the vehicle through which printing may be launched by an application.

PrinterDC

A printer device context is specific to MSW and Mac, and allows access to any printer with a Windows or Macintosh driver.

Printout

This class encapsulates the functionality of printing out an application document.

PrintPreview

Objects of this class manage the print preview process.

Process

The objects of this class are used in conjunction with the wx.Execute function.

ProcessEvent

A process event is sent to the wx.EvtHandler specified to wx.Process when a process is terminated.

ProgressDialog

If supported by the platform this class will provide the platform’s native progress dialog, else it will simply be the ` wx.GenericProgressDialog ` .

PropagateOnce

Helper class to temporarily lower propagation level.

PropagationDisabler

Helper class to temporarily change an event to not propagate.

PyApp

The wx.App class represents the application itself when USE_GUI=1 .

PyCommandEvent

PyCommandEvent can be used as a base class for implementing

PyEvent

PyEvent can be used as a base class for implementing custom

PyEventBinder

Instances of this class are used to bind specific events to event handlers.

PyOnDemandOutputWindow

A class that can be used for redirecting Python’s stdout and

PySimpleApp

This class is deprecated. Please use App instead.

QueryNewPaletteEvent

RadioBox

A radio box item is used to select one of number of mutually exclusive choices.

RadioButton

A radio button item is a button which usually denotes one of several mutually exclusive options.

RealPoint

A wx.RealPoint is a useful data structure for graphics operations.

RearrangeCtrl

A composite control containing a wx.RearrangeList and the buttons allowing to move the items in it.

RearrangeDialog

A dialog allowing the user to rearrange the specified items.

RearrangeList

A listbox-like control allowing the user to rearrange the items and to enable or disable them.

Rect

Represents a rectangle with integer coordinates.

Rect2D

RefCounter

This class is used to manage reference-counting providing a simple interface and a counter.

Region

A wx.Region represents a simple or complex region on a device context or window.

RegionIterator

This class is used to iterate through the rectangles in a region, typically when examining the damaged regions of a window within an OnPaint call.

RendererNative

First, a brief introduction to wx.RendererNative and why it is needed.

RendererVersion

This simple struct represents the wx.RendererNative interface version and is only used as the return value of wx.RendererNative.GetVersion .

RGBValue

A simple class which stores red, green and blue values as 8 bit integers in the range of 0-255.

RichMessageDialog

Extension of wx.MessageDialog with additional functionality.

RotateGestureEvent

This event is generated when two fingers move in opposite directions on the surface.

ScreenDC

A wx.ScreenDC can be used to paint on the screen.

ScrollBar

A wx.ScrollBar is a control that represents a horizontal or vertical scrollbar.

Scrolled

The wx.Scrolled class manages scrolling for its client area, transforming the coordinates according to the scrollbar positions, and setting the scroll positions, thumb sizes and ranges according to the area in view.

ScrolledCanvas

The ScrolledCanvas class is a combination of the Window and

ScrolledWindow

Scrolled window derived from wx.Panel.

ScrollEvent

A scroll event holds information about events sent from stand-alone scrollbars (see wx.ScrollBar) and sliders (see wx.Slider).

ScrollWinEvent

A scroll event holds information about events sent from scrolling windows.

SearchCtrl

A search control is a composite control with a search button, a text control, and a cancel button.

SetCursorEvent

A wx.SetCursorEvent is generated from wx.Window when the mouse cursor is about to be set as a result of mouse motion.

SettableHeaderColumn

Adds methods to set the column attributes to wx.HeaderColumn.

ShowEvent

An event being sent when the window is shown or hidden.

Simplebook

wx.Simplebook is a control showing exactly one of its several pages.

SimpleHelpProvider

wx.SimpleHelpProvider is an implementation of wx.HelpProvider which supports only plain text help strings, and shows the string associated with the control (if any) in a tooltip.

SingleChoiceDialog

This class represents a dialog that shows a list of strings, and allows the user to select one.

SingleInstanceChecker

wx.SingleInstanceChecker class allows checking that only a single instance of a program is running.

Size

A wx.Size is a useful data structure for graphics operations.

SizeEvent

A size event holds information about size change events of wx.Window.

Sizer

wx.Sizer is the abstract base class used for laying out subwindows in a window.

SizerFlags

Container for sizer items flags providing readable names for them.

SizerItem

The wx.SizerItem class is used to track the position, size and other attributes of each item managed by a wx.Sizer.

Slider

A slider is a control with a handle which can be pulled back and forth to change the value.

SpinButton

A wx.SpinButton has two small up and down (or left and right) arrow buttons.

SpinCtrl

wx.SpinCtrl combines wx.TextCtrl and wx.SpinButton in one control.

SpinCtrlDouble

wx.SpinCtrlDouble combines wx.TextCtrl and wx.SpinButton in one control and displays a real number.

SpinDoubleEvent

This event class is used for the events generated by wx.SpinCtrlDouble.

SpinEvent

This event class is used for the events generated by wx.SpinButton and wx.SpinCtrl.

SplitterEvent

This class represents the events generated by a splitter control.

SplitterRenderParams

This is just a simple struct used as a return value of wx.RendererNative.GetSplitterParams .

SplitterWindow

This class manages up to two subwindows.

StandardPaths

wx.StandardPaths returns the standard locations in the file system and should be used by applications to find their data files in a portable way.

StaticBitmap

A static bitmap control displays a bitmap.

StaticBox

A static box is a rectangle drawn around other windows to denote a logical grouping of items.

StaticBoxSizer

wx.StaticBoxSizer is a sizer derived from wx.BoxSizer but adds a static box around the sizer.

StaticLine

A static line is just a line which may be used in a dialog to separate the groups of controls.

StaticText

A static text control displays one or more lines of read-only text.

StatusBar

A status bar is a narrow window that can be placed along the bottom of a frame to give small amounts of status information.

StatusBarPane

A status bar pane data container used by wx.StatusBar.

StdDialogButtonSizer

This class creates button layouts which conform to the standard button spacing and ordering defined by the platform or toolkit’s user interface guidelines (if such things exist).

StockPreferencesPage

Specialization of wx.PreferencesPage useful for certain commonly used preferences page.

StopWatch

The wx.StopWatch class allow you to measure time intervals.

StreamBase

This class is the base class of most stream related classes in wxWidgets.

SVGBitmapEmbedHandler

Handler embedding bitmaps as base64-encoded PNGs into the SVG.

SVGBitmapFileHandler

Handler saving bitmaps to external PNG files and linking to it from the SVG.

SVGBitmapHandler

Abstract base class for handling bitmaps inside a wx.SVGFileDC.

SVGFileDC

A wx.SVGFileDC is a device context onto which graphics and text can be drawn, and the output produced as a vector file, in SVG format.

SysColourChangedEvent

This class is used for system colour change events, which are generated when the user changes the colour settings using the control panel.

SystemAppearance

Provides information about the current system appearance.

SystemOptions

wx.SystemOptions stores option/value pairs that wxWidgets itself or applications can use to alter behaviour at run-time.

SystemSettings

wx.SystemSettings allows the application to ask for details about the system.

TextAttr

wx.TextAttr represents the character and paragraph attributes, or style, for a range of text in a wx.TextCtrl or wx.richtext.RichTextCtrl.

TextCompleter

Base class for custom text completer objects.

TextCompleterSimple

A simpler base class for custom completer objects.

TextCtrl

A text control allows text to be displayed and edited.

TextDataObject

wx.TextDataObject is a specialization of wx.DataObjectSimple for text data.

TextDropTarget

A predefined drop target for dealing with text data.

TextEntry

Common base class for single line text entry fields.

TextEntryDialog

This class represents a dialog that requests a one-line text string from the user.

TextUrlEvent

TGAHandler

This is the image handler for the TGA format.

TIFFHandler

This is the image handler for the TIFF format.

Timer

The wx.Timer class allows you to execute code at specified intervals.

TimerEvent

wx.TimerEvent object is passed to the event handler of timer events (see wx.Timer.SetOwner ).

TimerRunner

Starts the timer in its constructor, stops in the dtor.

TimeSpan

wx.TimeSpan class represents a time interval.

TimeZone

Class representing a time zone.

TipWindow

Shows simple text in a popup tip window on creation.

Tm

Contains broken down date-time representation.

ToggleButton

wx.ToggleButton is a button that stays pressed when clicked by the user.

ToolBar

A toolbar is a bar of buttons and/or other controls usually placed below the menu bar in a wx.Frame.

ToolBarToolBase

A toolbar tool represents one item on the toolbar.

Toolbook

wx.Toolbook is a class similar to wx.Notebook but which uses a wx.ToolBar to show the labels instead of the tabs.

ToolTip

This class holds information about a tooltip associated with a window (see wx.Window.SetToolTip ).

TopLevelWindow

wx.TopLevelWindow is a common base class for wx.Dialog and wx.Frame.

Trackable

Add-on base class for a trackable object.

Translations

This class allows getting translations for strings.

TranslationsLoader

Abstraction of translations discovery and loading.

Treebook

This class is an extension of the wx.Notebook class that allows a tree structured set of pages to be shown in a control.

TreeCtrl

A tree control presents information as a hierarchy, with items that may be expanded to show further items.

TreeEvent

A tree event holds information about events associated with wx.TreeCtrl objects.

TreeItemId

An opaque reference to a tree item.

TwoFingerTapEvent

This event is generated when two fingers touch the surface at the same time.

UIActionSimulator

wx.UIActionSimulator is a class used to simulate user interface actions such as a mouse click or a key press.

UniChar

This class represents a single Unicode character.

UpdateUIEvent

This class is used for pseudo-events which are called by wxWidgets to give an application the chance to update various user interface elements.

URLDataObject

wx.URLDataObject is a wx.DataObject containing an URL and can be used e.g.

Validator

wx.Validator is the base class for a family of validator classes that mediate between a class of control, and application data.

VarHScrollHelper

This class provides functions wrapping the wx.VarScrollHelperBase class, targeted for horizontal-specific scrolling.

VarHVScrollHelper

This class provides functions wrapping the wx.VarHScrollHelper and wx.VarVScrollHelper classes, targeted for scrolling a window in both axis.

VarScrollHelperBase

This class provides all common base functionality for scroll calculations shared among all variable scrolled window implementations as well as automatic scrollbar functionality, saved scroll positions, controlling target windows to be scrolled, as well as defining all required virtual functions that need to be implemented for any orientation specific work.

VarVScrollHelper

This class provides functions wrapping the wx.VarScrollHelperBase class, targeted for vertical-specific scrolling.

VersionInfo

wx.VersionInfo contains version information.

VideoMode

Determines the sizes and locations of displays connected to the system.

VisualAttributes

Struct containing all the visual attributes of a control.

VListBox

wx.VListBox is a ListBox-like control with the following two main differences from a regular wx.ListBox: it can have an arbitrarily huge number of items because it doesn’t store them itself but uses the OnDrawItem callback to draw them (so it is a virtual listbox) and its items can have variable height as determined by OnMeasureItem (so it is also a listbox with the lines of variable height).

VScrolledWindow

In the name of this class, “V” may stand for “variable” because it can be used for scrolling rows of variable heights; “virtual”, because it is not necessary to know the heights of all rows in advance

Window

wx.Window is the base class for all windows and represents any visible object on screen.

WindowBase

WindowCreateEvent

This event is sent just after the actual window associated with a wx.Window object has been created.

WindowDC

A wx.WindowDC must be constructed if an application wishes to paint on the whole area of a window (client and decorations).

WindowDestroyEvent

This event is sent as early as possible during the window destruction process.

WindowDisabler

This class disables all top level windows of the application (maybe with the exception of one of them) in its constructor and enables them back in its destructor.

WindowIDRef

A WindowIDRef object wraps an ID value and marks it as being in-use until all references to that ID are gone.

WindowModalDialogEvent

Event sent by wx.Dialog.ShowWindowModal when the dialog closes.

WithImages

A mixin class to be used with other classes that use a wx.ImageList.

WrapSizer

A wrap sizer lays out its items in a single line, like a box sizer

XPMHandler

This is the image handler for the XPM format.

ZoomGestureEvent

This event is generated when two fingers pinch the surface to zoom in or out.

Functions Summary

Function

Short Description

Abort

Exits the program immediately.

AutoBufferedPaintDCFactory

Check if the window is natively double buffered and will return a wx.PaintDC if it is, a wx.BufferedPaintDC otherwise.

BeginBusyCursor

Changes the cursor to the given cursor for all windows in the application.

Bell

Ring the system bell.

BitmapFromBuffer

A compatibility wrapper for wx.Bitmap.FromBuffer and wx.Bitmap.FromBufferAndAlpha

BitmapFromBufferRGBA

A compatibility wrapper for wx.Bitmap.FromBufferRGBA

BitmapFromImage

A compatibility wrapper for the wx.Bitmap(wx.Image) constructor

CallAfter

Call the specified function after the current and pending event

CheckOsVersion

Returns True if the version of the operating system on which the program is running under is the same or later than the given version.

ClientDisplayRect

Returns the dimensions of the work area on the display.

ColourDisplay

Returns True if the display is colour, False otherwise.

DateTimeFromDMY

Compatibility wrapper for DateTime.FromDMY

DateTimeFromHMS

Compatibility wrapper for DateTime.FromHMS

DateTimeFromJDN

Compatibility wrapper for DateTime.FromJDN

DateTimeFromTimeT

Compatibility wrapper for DateTime.FromTimeT

DecToHex

Convert decimal integer to 2-character hexadecimal string.

DirSelector

Pops up a directory selector dialog.

DisableAsserts

Disable the condition checks in the assertions.

DisplayDepth

Returns the depth of the display (a value of 1 denotes a monochrome display).

DisplaySize

Returns the display size in pixels.

DisplaySizeMM

Returns the display size in millimeters.

EmptyBitmap

A compatibility wrapper for the wx.Bitmap(width, height, depth) constructor

EmptyBitmapRGBA

A compatibility wrapper for wx.Bitmap.FromRGBA

EmptyIcon

A compatibility wrapper for the Icon constructor

EmptyImage

A compatibility wrapper for the wx.Image(width, height) constructor

EnableTopLevelWindows

This function enables or disables all top level windows.

EndBusyCursor

Changes the cursor back to the original cursor, for all windows in the application.

Execute

Executes another program in Unix or Windows.

Exit

Exits application after calling wx.App.OnExit .

FFont

FileSelector

Pops up a file selector box.

FileSelectorEx

An extended version of wx.FileSelector

FindMenuItemId

Find a menu item identifier associated with the given frame’s menu bar.

FindWindowAtPoint

Find the deepest window at the given mouse position in screen coordinates, returning the window if found, or None if not.

FindWindowAtPointer

Find the deepest window at the mouse pointer position, returning the window and current pointer position in screen coordinates.

FindWindowById

FindWindowById(id, parent=None) . Window

FindWindowByLabel

Find a window by its label. Depending on the type of window, the label may be a window title or panel item label. If parent is None, the search will start from all top-level frames and dialog boxes; if not None, the search will be limited to the given window hierarchy. The search is recursive in both cases.

FindWindowByName

Find a window by its name (as given in a window constructor or Create function call). If parent is None, the search will start from all top-level frames and dialog boxes; if not None, the search will be limited to the given window hierarchy. The search is recursive in both cases.

GetAccelFromString

GetActiveWindow

Gets the currently active window (implemented for MSW and GTK only currently, always returns None in the other ports).

GetApp

Returns the current application object.

GetBatteryState

Returns battery state as one of BATTERY_NORMAL_STATE , BATTERY_LOW_STATE , BATTERY_CRITICAL_STATE , BATTERY_SHUTDOWN_STATE or BATTERY_UNKNOWN_STATE .

GetClientDisplayRect

Returns the dimensions of the work area on the display.

GetColourFromUser

Shows the colour selection dialog and returns the colour selected by user or invalid colour (use wx.Colour.IsOk to test whether a colour is valid) if the dialog was cancelled.

GetDisplayPPI

Returns the display resolution in pixels per inch.

GetDisplaySize

Returns the display size in pixels.

GetDisplaySizeMM

Returns the display size in millimeters.

GetEmailAddress

Copies the user’s email address into the supplied buffer, by concatenating the values returned by wx.GetFullHostName and wx.GetUserId .

GetFontFromUser

Shows the font selection dialog and returns the font selected by user or invalid font (use wx.Font.IsOk to test whether a font is valid) if the dialog was cancelled.

GetFullHostName

Returns the FQDN (fully qualified domain host name) or an empty string on error.

GetHomeDir

Return the (current) user’s home directory.

GetHostName

Copies the current host machine’s name into the supplied buffer.

GetKeyState

For normal keys, returns True if the specified key is currently down.

GetLibraryVersionInfo

Get wxWidgets version information.

GetLocale

Get the current locale object (note that it may be None!)

GetMousePosition

Returns the mouse position in screen coordinates.

GetMouseState

Returns the current state of the mouse.

GetNumberFromUser

Shows a dialog asking the user for numeric input.

GetOsDescription

Returns the string containing the description of the current platform in a user-readable form.

GetOsVersion

Gets the version and the operating system ID for currently running OS.

GetPasswordFromUser

Similar to wx.GetTextFromUser but the text entered in the dialog is not shown on screen but replaced with stars.

GetPowerType

Returns the type of power source as one of POWER_SOCKET , POWER_BATTERY or POWER_UNKNOWN .

GetProcessId

Returns the number uniquely identifying the current process in the system.

GetSingleChoice

Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection listbox.

GetStockLabel

Returns label that should be used for given id element.

GetTextFromUser

Pop up a dialog box with title set to caption, message , and a default_value .

GetTopLevelParent

Returns the first top level parent of the given window, or in other words, the frame or dialog containing it, or None.

GetTopLevelWindows

Returns a list-like object of the the application’s top-level windows, (frames,dialogs, etc.)

GetTranslation

This function returns the translation of string in the current locale() .

GetUserHome

Returns the home directory for the given user.

GetUserId

This function returns the “user id” also known as “login name” under Unix (i.e.

GetUserName

This function returns the full user name (something like “Mr. John Smith”).

HandleFatalExceptions

If doIt is True, the fatal exceptions (also known as general protection faults under Windows or segmentation violations in the Unix world) will be caught and passed to wx.App.OnFatalException .

HexToDec

Convert 2-character hexadecimal string to decimal integer.

ImageFromBitmap

Create a Image from a wx.Bitmap

ImageFromBuffer

Creates a Image from the data in dataBuffer. The dataBuffer

ImageFromData

Compatibility wrapper for creating an image from RGB data

ImageFromDataWithAlpha

Compatibility wrapper for creating an image from RGB and Alpha data

ImageFromStream

Load an image from a stream (file-like object)

InfoMessageBox

Shows a message box with the information about the wxWidgets build used, including its version, most important build parameters and the version of the underlying GUI toolkit.

InitAllImageHandlers

Initializes all available image handlers.

IntersectRect

Calculate and return the intersection of r1 and r2. Returns None if there

IsBusy

Returns True if between two wx.BeginBusyCursor and wx.EndBusyCursor calls.

IsDragResultOk

Returns True if res indicates that something was done during a DnD operation, i.e.

IsMainThread

Returns True if the current thread is what considers the GUI thread.

IsPlatform64Bit

Returns True if the operating system the program is running under is 64 bit.

IsPlatformLittleEndian

Returns True if the current platform is little endian (instead of big endian).

Kill

Equivalent to the Unix kill function: send the given signal sig to the process with PID pid.

LaunchDefaultApplication

Opens the document in the application associated with the files of this type.

LaunchDefaultBrowser

Opens the url in user’s default browser.

LoadFileSelector

Shows a file dialog asking the user for a file name for opening a file.

LogDebug

The right functions for debug output.

LogError

The functions to use for error messages, i.e.

LogFatalError

Like wx.LogError , but also terminates the program with the exit code 3.

LogGeneric

Logs a message with the given LogLevel.

LogInfo

For low priority messages.

LogMessage

For all normal, informational messages.

LogStatus

Messages logged by this function will appear in the statusbar of the frame or of the top level application window by default (i.e.

LogSysError

Mostly used by wxWidgets itself, but might be handy for logging errors after system call (API function) failure.

LogVerbose

For verbose output.

LogWarning

For warnings - they are also normally shown to the user, but don’t interrupt the program work.

MacThemeColour

rtype

wx.Colour

MessageBox

Show a general purpose message dialog.

MicroSleep

Sleeps for the specified number of microseconds.

MilliSleep

Sleeps for the specified number of milliseconds.

NewEventType

Generates a new unique event type.

NewId

Generates an integer identifier unique to this run of the program.

NewIdRef

Reserves a new Window ID (or range of WindowIDs) and returns a

Now

Returns a string representing the current date and time.

PostEvent

In a GUI application, this function posts event to the specified dest object using wx.EvtHandler.AddPendingEvent .

QueueEvent

Queue an event for processing on the given object.

RegisterId

Ensures that Ids subsequently generated by wx.NewId do not clash with the given id.

SafeShowMessage

This function shows a message to the user in a safe way and should be safe to call even before the application has been initialized or if it is currently in some other strange state (for example, about to crash).

SafeYield

Calls wx.App.SafeYield .

SaveFileSelector

Shows a file dialog asking the user for a file name for saving a file.

SetCursor

Globally sets the cursor; only has an effect on Windows, Mac and GTK+.

Shell

Executes a command in an interactive shell window.

Shutdown

This function shuts down or reboots the computer depending on the value of the flags.

Sleep

Sleeps for the specified number of seconds.

StripMenuCodes

Strips any menu codes from str and returns the result.

SysErrorCode

Returns the error code from the last system call.

SysErrorMsg

Returns the error message corresponding to the given system error code.

SysErrorMsgStr

Returns the error message corresponding to the given system error code.

Trap

Generate a debugger exception meaning that the control is passed to the debugger if one is attached to the process.

WakeUpIdle

This function wakes up the (internal and platform dependent) idle system, i.e.

Yield

Calls wx.AppConsole.Yield if there is an existing application object.

YieldIfNeeded

Convenience function for wx.GetApp().Yield(True)

date2pydate

Convert a DateTime object to a Python datetime.

pydate2wxdate

Convert a Python date or datetime to a DateTime object

version

Returns a string containing version and port info