API Reference — wx v2.6

Search documentation of wx

# API Reference wx v#2.6

Copy Markdown

## Modules

gl

Erlang wrapper functions for OpenGL

glu

Erlang wrapper functions for OpenGL

wx

A port of wxWidgets.

wxAcceleratorEntry

An object used by an application wishing to create an accelerator table (see `wxAcceleratorTable`).

wxAcceleratorTable

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

wxActivateEvent

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

wxArtProvider

`wxArtProvider` class is used to customize the look of wxWidgets application.

wxAuiDockArt

`wxAuiDockArt` is part of the wxAUI class framework.

wxAuiManager

`wxAuiManager` is the central class of the wxAUI class framework.

wxAuiManagerEvent

Event used to indicate various actions taken with `wxAuiManager`.

wxAuiNotebook

`wxAuiNotebook` is part of the wxAUI class framework, which represents a notebook control, managing multiple windows with associated tabs.

wxAuiNotebookEvent

This class is used by the events generated by `wxAuiNotebook`.

wxAuiPaneInfo

`wxAuiPaneInfo` is part of the wxAUI class framework.

wxAuiSimpleTabArt

Another standard tab art provider for `wxAuiNotebook`.

wxAuiTabArt

Tab art provider defines all the drawing functions used by `wxAuiNotebook`.

wxBitmap

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

wxBitmapButton

A bitmap button is a control that contains a bitmap.

wxBitmapDataObject

`wxBitmapDataObject` is a specialization of `wxDataObject` for bitmap data.

wxBookCtrlBase

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

wxBookCtrlEvent

This class represents the events generated by book controls (`wxNotebook`, `wxListbook`, `wxChoicebook`, `wxTreebook`, `wxAuiNotebook`).

wxBoxSizer

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.

wxBrush

A brush is a drawing tool for filling in areas.

wxBufferedDC

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 `wxBitmap`) and then copied to the screen, using the associated `wxDC`, only once, when this object is destroyed.

wxBufferedPaintDC

This is a subclass of `wxBufferedDC` which can be used inside of an `EVT\_PAINT()` event handler to achieve double-buffered drawing.

wxButton

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

wxCalendarCtrl

The calendar control allows the user to pick a date.

wxCalendarDateAttr

`wxCalendarDateAttr` is a custom attributes for a calendar date.

wxCalendarEvent

The `wxCalendarEvent` class is used together with `wxCalendarCtrl`.

wxCaret

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

wxCheckBox

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

wxCheckListBox

A `wxCheckListBox` is like a `wxListBox`, but allows items to be checked or unchecked.

wxChildFocusEvent

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.

wxChoice

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

wxChoicebook

`wxChoicebook` is a class similar to `wxNotebook`, but uses a `wxChoice` control to show the labels instead of the tabs.

wxClientDC

`wxClientDC` is primarily useful for obtaining information about the window from outside EVT_PAINT() handler.

wxClipboard

A class for manipulating the clipboard.

wxClipboardTextEvent

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

wxCloseEvent

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

wxColourData

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

wxColourDialog

This class represents the colour chooser dialog.

wxColourPickerCtrl

This control allows the user to select a colour.

wxColourPickerEvent

This event class is used for the events generated by `wxColourPickerCtrl`.

wxComboBox

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

wxCommandEvent

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

wxContextMenuEvent

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

wxControl

This is the base class for a control or "widget".

wxControlWithItems

This is convenience class that derives from both `wxControl` and `wxItemContainer` (not implemented in wx).

wxCursor

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.

wxDC

A `wxDC` is a `"device context"` onto which graphics and text can be drawn.

wxDCOverlay

Connects an overlay with a drawing DC.

wxDataObject

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

wxDateEvent

This event class holds information about a date change and is used together with `wxDatePickerCtrl`.

wxDatePickerCtrl

This control allows the user to select a date.

wxDialog

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

wxDirDialog

This class represents the directory chooser dialog.

wxDirPickerCtrl

This control allows the user to select a directory.

wxDisplay

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

wxDisplayChangedEvent

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

wxDropFilesEvent

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

wxEraseEvent

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

wxEvent

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

wxEvtHandler

The Event handler

wxFileDataObject

`wxFileDataObject` is a specialization of `wxDataObject` for file names.

wxFileDialog

This class represents the file chooser dialog.

wxFileDirPickerEvent

This event class is used for the events generated by `wxFilePickerCtrl` and by `wxDirPickerCtrl`.

wxFilePickerCtrl

This control allows the user to select a file.

wxFindReplaceData

`wxFindReplaceData` holds the data for `wxFindReplaceDialog`.

wxFindReplaceDialog

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

wxFlexGridSizer

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 `wxGridSizer`.

wxFocusEvent

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

wxFont

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

wxFontData

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

wxFontDialog

This class represents the font chooser dialog.

wxFontPickerCtrl

This control allows the user to select a font.

wxFontPickerEvent

This event class is used for the events generated by `wxFontPickerCtrl`.

wxFrame

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

wxGBSizerItem

The `wxGBSizerItem` class is used by the `wxGridBagSizer` for tracking the items in the sizer.

wxGCDC

`wxGCDC` is a device context that draws on a `wxGraphicsContext`.

wxGLCanvas

`wxGLCanvas` is a class for displaying OpenGL graphics.

wxGLContext

An instance of a `wxGLContext` represents the state of an OpenGL state machine and the connection between OpenGL and the system.

wxGauge

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

wxGenericDirCtrl

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

wxGraphicsBrush

A `wxGraphicsBrush` is a native representation of a brush.

wxGraphicsContext

A `wxGraphicsContext` instance is the object that is drawn upon.

wxGraphicsFont

A `wxGraphicsFont` is a native representation of a font.

wxGraphicsGradientStops

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

wxGraphicsMatrix

A `wxGraphicsMatrix` is a native representation of an affine matrix.

wxGraphicsObject

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

wxGraphicsPath

A `wxGraphicsPath` is a native representation of a geometric path.

wxGraphicsPen

A `wxGraphicsPen` is a native representation of a pen.

wxGraphicsRenderer

A `wxGraphicsRenderer` is the instance corresponding to the rendering engine used.

wxGrid

`wxGrid` and its related classes are used for displaying and editing tabular data.

wxGridBagSizer

A `wxSizer` that can lay out items in a virtual grid like a `wxFlexGridSizer` but in this case explicit positioning of the items is allowed using `wxGBPosition` (not implemented in wx), and items can optionally span more than one row and/or column using `wxGBSpan` (not implemented in wx).

wxGridCellAttr

This class can be used to alter the cells' appearance in the grid by changing their attributes from the defaults.

wxGridCellBoolEditor

Grid cell editor for boolean data.

wxGridCellBoolRenderer

This class may be used to format boolean data in a cell.

wxGridCellChoiceEditor

Grid cell editor for string data providing the user a choice from a list of strings.

wxGridCellEditor

This class is responsible for providing and manipulating the in-place edit controls for the grid.

wxGridCellFloatEditor

The editor for floating point numbers data.

wxGridCellFloatRenderer

This class may be used to format floating point data in a cell.

wxGridCellNumberEditor

Grid cell editor for numeric integer data.

wxGridCellNumberRenderer

This class may be used to format integer data in a cell.

wxGridCellRenderer

This class is responsible for actually drawing the cell in the grid.

wxGridCellStringRenderer

This class may be used to format string data in a cell; it is the default for string cells.

wxGridCellTextEditor

Grid cell editor for string/text data.

wxGridEvent

This event class contains information about various grid events.

wxGridSizer

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.

wxHelpEvent

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

wxHtmlEasyPrinting

This class provides very simple interface to printing architecture.

wxHtmlLinkEvent

This event class is used for the events generated by `wxHtmlWindow`.

wxHtmlWindow

`wxHtmlWindow` is probably the only class you will directly use unless you want to do something special (like adding new tag handlers or MIME filters).

wxIcon

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

wxIconBundle

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

wxIconizeEvent

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

wxIdleEvent

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

wxImage

This class encapsulates a platform-independent image.

wxImageList

A `wxImageList` contains a list of images, which are stored in an unspecified form.

wxInitDialogEvent

A `wxInitDialogEvent` is sent as a dialog or panel is being initialised.

wxJoystickEvent

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

wxKeyEvent

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

wxLayoutAlgorithm

`wxLayoutAlgorithm` implements layout of subwindows in MDI or SDI frames.

wxListBox

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

wxListCtrl

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

wxListEvent

A list event holds information about events associated with `wxListCtrl` objects.

wxListItem

This class stores information about a `wxListCtrl` item or column.

wxListItemAttr

Functions for wxListItemAttr class

wxListView

This class currently simply presents a simpler to use interface for the `wxListCtrl` -- it can be thought of as a `façade` for that complicated class.

wxListbook

`wxListbook` is a class similar to `wxNotebook` but which uses a `wxListCtrl` to show the labels instead of the tabs.

wxLocale

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

wxLogNull

This class allows you to temporarily suspend logging.

wxMDIChildFrame

An MDI child frame is a frame that can only exist inside a `wxMDIClientWindow`, which is itself a child of `wxMDIParentFrame`.

wxMDIClientWindow

An MDI client window is a child of `wxMDIParentFrame`, and manages zero or more `wxMDIChildFrame` objects.

wxMDIParentFrame

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.

wxMask

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

wxMaximizeEvent

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

wxMemoryDC

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

wxMenu

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).

wxMenuBar

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

wxMenuEvent

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

wxMenuItem

A menu item represents an item in a menu.

wxMessageDialog

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

wxMiniFrame

A miniframe is a frame with a small title bar.

wxMirrorDC

`wxMirrorDC` is a simple wrapper class which is always associated with a real `wxDC` 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 -- i.e.

wxMouseCaptureChangedEvent

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

wxMouseCaptureLostEvent

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).

wxMouseEvent

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

wxMoveEvent

A move event holds information about window position change.

wxMultiChoiceDialog

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

wxNavigationKeyEvent

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

wxNotebook

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

wxNotificationMessage

This class allows showing the user a message non intrusively.

wxNotifyEvent

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

wxOverlay

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

wxPageSetupDialog

This class represents the page setup common dialog.

wxPageSetupDialogData

This class holds a variety of information related to `wxPageSetupDialog`.

wxPaintDC

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

wxPaintEvent

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

wxPalette

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

wxPaletteChangedEvent

Functions for wxPaletteChangedEvent class

wxPanel

A panel is a window on which controls are placed.

wxPasswordEntryDialog

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

wxPen

A pen is a drawing tool for drawing outlines.

wxPickerBase

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

wxPopupTransientWindow

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

wxPopupWindow

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

wxPostScriptDC

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

wxPreviewCanvas

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

wxPreviewControlBar

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

wxPreviewFrame

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

wxPrintData

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

wxPrintDialog

This class represents the print and print setup common dialogs.

wxPrintDialogData

This class holds information related to the visual characteristics of `wxPrintDialog`.

wxPrintPreview

Objects of this class manage the print preview process.

wxPrinter

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

wxPrintout

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

wxProgressDialog

If supported by the platform this class will provide the platform's native progress dialog, else it will simply be the `wxGenericProgressDialog` (not implemented in wx).

wxQueryNewPaletteEvent

Functions for wxQueryNewPaletteEvent class

wxRadioBox

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

wxRadioButton

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

wxRegion

A `wxRegion` represents a simple or complex region on a device context or window.

wxSashEvent

A sash event is sent when the sash of a `wxSashWindow` has been dragged by the user.

wxSashLayoutWindow

`wxSashLayoutWindow` responds to OnCalculateLayout events generated by `wxLayoutAlgorithm`.

wxSashWindow

`wxSashWindow` allows any of its edges to have a sash which can be dragged to resize the window.

wxScreenDC

A `wxScreenDC` can be used to paint on the screen.

wxScrollBar

A `wxScrollBar` is a control that represents a horizontal or vertical scrollbar.

wxScrollEvent

A scroll event holds information about events sent from stand-alone scrollbars (see `wxScrollBar`) and sliders (see `wxSlider`).

wxScrollWinEvent

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

wxScrolledWindow

The `wxScrolled` (not implemented in wx) 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.

wxSetCursorEvent

A `wxSetCursorEvent` is generated from `wxWindow` when the mouse cursor is about to be set as a result of mouse motion.

wxShowEvent

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

wxSingleChoiceDialog

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

wxSizeEvent

A size event holds information about size change events of `wxWindow`.

wxSizer

`wxSizer` is the abstract base class used for laying out subwindows in a window.

wxSizerFlags

Container for sizer items flags providing readable names for them.

wxSizerItem

The `wxSizerItem` class is used to track the position, size and other attributes of each item managed by a `wxSizer`.

wxSlider

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

wxSpinButton

A `wxSpinButton` has two small up and down (or left and right) arrow buttons.

wxSpinCtrl

`wxSpinCtrl` combines `wxTextCtrl` and `wxSpinButton` in one control.

wxSpinEvent

This event class is used for the events generated by `wxSpinButton` and `wxSpinCtrl`.

wxSplashScreen

`wxSplashScreen` shows a window with a thin border, displaying a bitmap describing your application.

wxSplitterEvent

This class represents the events generated by a splitter control.

wxSplitterWindow

This class manages up to two subwindows.

wxStaticBitmap

A static bitmap control displays a bitmap.

wxStaticBox

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

wxStaticBoxSizer

`wxStaticBoxSizer` is a sizer derived from `wxBoxSizer` but adds a static box around the sizer.

wxStaticLine

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

wxStaticText

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

wxStatusBar

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

wxStdDialogButtonSizer

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).

wxStyledTextCtrl

A wxWidgets implementation of the Scintilla source code editing component.

wxStyledTextEvent

The type of events sent from `wxStyledTextCtrl`.

wxSysColourChangedEvent

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

wxSystemOptions

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

wxSystemSettings

`wxSystemSettings` allows the application to ask for details about the system.

wxTaskBarIcon

This class represents a taskbar icon.

wxTaskBarIconEvent

The event class used by `wxTaskBarIcon`.

wxTextAttr

`wxTextAttr` represents the character and paragraph attributes, or style, for a range of text in a `wxTextCtrl` or `wxRichTextCtrl` (not implemented in wx).

wxTextCtrl

A text control allows text to be displayed and edited.

wxTextDataObject

`wxTextDataObject` is a specialization of `wxDataObjectSimple` (not implemented in wx) for text data.

wxTextEntryDialog

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

wxToggleButton

`wxToggleButton` is a button that stays pressed when clicked by the user.

wxToolBar

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

wxToolTip

This class holds information about a tooltip associated with a window (see `wxWindow:setToolTip/2`).

wxToolbook

`wxToolbook` is a class similar to `wxNotebook` but which uses a `wxToolBar` to show the labels instead of the tabs.

wxTopLevelWindow

`wxTopLevelWindow` is a common base class for `wxDialog` and `wxFrame`.

wxTreeCtrl

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

wxTreeEvent

A tree event holds information about events associated with `wxTreeCtrl` objects.

wxTreebook

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

wxUpdateUIEvent

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

wxWebView

This control may be used to render web (HTML / CSS / javascript) documents.

wxWebViewEvent

A navigation event holds information about events associated with `wxWebView` objects.

wxWindow

`wxWindow` is the base class for all windows and represents any visible object on screen.

wxWindowCreateEvent

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

wxWindowDC

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

wxWindowDestroyEvent

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

wxXmlResource

This is the main class for interacting with the XML-based resource system.

wx_misc

Miscellaneous functions.

wx_object

wx_object - Generic wx object behaviour