wx

Package wx

Package wx

Submodules

Submodules
`build`: This package provides the config module, which is used by wxPython's setup.py distutils script. `calendar`: Classes for an interactive Calendar control. `gizmos`: Various gizmo* classes: `DynamicSashWindow`, `EditableListBox`, `LEDNumberCtrl`, `TreeListCtrl`, etc.* `glcanvas`: `GLCanvas` provides an OpenGL Context on a `wx.Window`. `grid`: Classes for implementing a spreadsheet-like control. `html`: Classes for a simple HTML rendering window, HTML Help Window, etc. `lib` `ogl`: The Object Graphics Library provides for simple drawing and manipulation of 2D objects. `py`: The py package, formerly the PyCrust package. `stc`: The `StyledTextCtrl` provides a text editor that can used as a syntax highlighting source code editor, or similar. `tools`: Some useful tools and utilities for wxPython. `wizard`: `Wizard` is a dialog class that guides the user through a sequence of steps, or pages. `xrc`: The `XmlResource` class allows program resources defining menus, layout of controls on a panel, etc.

build: This package provides the config module, which is used by wxPython's setup.py distutils script.
calendar: Classes for an interactive Calendar control.
gizmos: Various gizmo classes: DynamicSashWindow, EditableListBox, LEDNumberCtrl, TreeListCtrl, etc.
glcanvas: GLCanvas provides an OpenGL Context on a wx.Window.
grid: Classes for implementing a spreadsheet-like control.
html: Classes for a simple HTML rendering window, HTML Help Window, etc.
lib
ogl: The Object Graphics Library provides for simple drawing and manipulation of 2D objects.
py: The py package, formerly the PyCrust package.
stc: The StyledTextCtrl provides a text editor that can used as a syntax highlighting source code editor, or similar.
tools: Some useful tools and utilities for wxPython.
wizard: Wizard is a dialog class that guides the user through a sequence of steps, or pages.
xrc: The XmlResource class allows program resources defining menus, layout of controls on a panel, etc.

Classes
`AcceleratorEntry`	A class used to define items in an `wx.AcceleratorTable`.
`AcceleratorTable`	An accelerator table allows the application to specify a table of keyboard shortcuts for menus or other commands.
`ActivateEvent`
`ANIHandler`
`App`	The `wx.App` class represents the application and is used to:
`ArtProvider`	The wx.ArtProvider class is used to customize the look of wxWidgets application.
`Bitmap`	The wx.Bitmap class encapsulates the concept of a platform-dependent bitmap.
`BitmapButton`	A Button that contains a bitmap.
`BitmapDataObject`	wx.BitmapDataObject is a specialization of wxDataObject for bitmap data.
`BMPHandler`
`BookCtrl`
`BookCtrlEvent`
`BookCtrlSizer`
`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 nested hierarchies of either.
`Brush`	A brush is a drawing tool for filling in areas.
`BrushList`
`BufferedDC`	This simple 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 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.
`BusyCursor`
`BusyInfo`
`Button`	A button is a control that contains a text string, and is one of the most common elements of a GUI.
`CalculateLayoutEvent`
`Caret`
`CheckBox`	A checkbox is a labelled box which by default is either on (the checkmark is visible) or off (no checkmark).
`CheckListBox`
`ChildFocusEvent`
`Choice`	A Choice control is used to select one of a list of strings.
`Choicebook`
`ChoicebookEvent`
`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 event.
`Clipboard`	wx.Clipboard represents the system clipboard and provides methods to copy data to it or paste data from it.
`ClipboardLocker`	A helpful class for opening the clipboard and automatically closing it when the locker is destroyed.
`CloseEvent`
`Color`	A colour is an object representing a combination of Red, Green, and Blue (RGB) intensity values, and is used to determine drawing colours, window colours, etc.
`Colour`	A colour is an object representing a combination of Red, Green, and Blue (RGB) intensity values, and is used to determine drawing colours, window colours, etc.
`ColourData`	This class holds a variety of information related to the colour chooser dialog, used to transfer settings and results to and from the `wx.ColourDialog`.
`ColourDatabase`
`ColourDialog`	This class represents the colour chooser dialog.
`ComboBox`	A combobox is like a combination of an edit control and a listbox.
`CommandEvent`
`Config`	This ConfigBase-derived class will use the registry on Windows, and will be a wx.FileConfig on other platforms.
`ConfigBase`	wx.ConfigBase class defines the basic interface of all config classes.
`ConfigPathChanger`	A handy little class which changes current path to the path of given entry and restores it in the destructoir: so if you declare a local variable of this type, you work in the entry directory and the path is automatically restored when the function returns.
`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`
`Control`	This is the base class for a control or 'widget'.
`ControlWithItems`	wx.ControlWithItems combines the `wx.ItemContainer` class with the wx.Control class, and is used for the base class of various controls that have items.
`CPPFileSystemHandler`
`CURHandler`
`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 format.
`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 sued to support multiple formats.
`DataObjectSimple`	wx.DataObjectSimple is a `wx.DataObject` which only supports one format.
`DateSpan`
`DateTime`
`DC`	A wx.DC is a device context onto which graphics and text can be drawn.
`Dialog`
`DirDialog`	wx.DirDialog allows the user to select a directory by browising the file system.
`DirFilterListCtrl`
`Display`	Represents a display/monitor attached to the system
`DisplayChangedEvent`
`DragImage`
`DropFilesEvent`
`DropSource`
`DropTarget`
`Effects`
`EncodingConverter`
`EraseEvent`
`Event`
`EventLoop`
`EvtHandler`
`FileConfig`	This config class will use a file for storage on all platforms.
`FileDataObject`	wx.FileDataObject is a specialization of `wx.DataObjectSimple` for file names.
`FileDialog`	wx.FileDialog allows the user to select one or more files from the filesystem.
`FileDropTarget`
`FileHistory`
`FileSystem`
`FileSystemHandler`
`FileType`
`FileTypeInfo`
`FindDialogEvent`	Events for the FindReplaceDialog
`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 cells in one row having the same height and all cells 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`
`Font`
`FontData`	This class holds a variety of information related to font dialogs and is used to transfer settings to and results from a `wx.FontDialog`.
`FontDialog`	wx.FontDialog allows the user to select a system font and its attributes.
`FontEnumerator`
`FontList`
`FontMapper`
`Frame`
`FSFile`
`FutureCall`	A convenience class for wx.Timer, that calls the given callable object once after the given amount of milliseconds, passing any positional or keyword args.
`Gauge`
`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 to track the additional data about items in a `wx.GridBagSizer` such as the item's position in the grid and how many rows or columns it spans.
`GBSpan`	This class is used to hold the row and column spanning attributes of items in a `wx.GridBagSizer`.
`GDIObject`
`GenericDirCtrl`
`GIFHandler`
`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 cells having the same size.
`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.
`HtmlListBox`
`ICOHandler`
`Icon`
`IconBundle`
`IconizeEvent`
`IconLocation`
`IdleEvent`
`Image`
`ImageHandler`
`ImageHistogram`
`ImageList`
`IndividualLayoutConstraint`	Objects of this class are stored in the `wx.LayoutConstraints` class as one of eight possible constraints that a window can be involved in.
`InitDialogEvent`
`InputStream`
`InternetFSHandler`
`ItemContainer`	wx.ItemContainer defines an interface which is implemented by all controls which have string subitems, each of which may be selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as `wx.ComboBox` which implements an extended interface deriving from this one.
`Joystick`
`JoystickEvent`
`JPEGHandler`
`KeyEvent`
`LanguageInfo`
`LayoutAlgorithm`
`LayoutConstraints`	Note: constraints are now deprecated and you should use sizers instead.
`Listbook`
`ListbookEvent`
`ListBox`
`ListCtrl`
`ListEvent`
`ListItem`
`ListItemAttr`
`ListView`
`Locale`
`Log`
`LogChain`
`LogGui`
`LogNull`
`LogStderr`
`LogTextCtrl`
`LogWindow`
`Mask`	This class encapsulates a monochrome mask bitmap, where the masked area is black and the unmasked area is white.
`MaximizeEvent`
`MDIChildFrame`
`MDIClientWindow`
`MDIParentFrame`
`MemoryDC`	A memory device context provides a means to draw graphics onto a bitmap.
`MemoryFSHandler`
`Menu`
`MenuBar`
`MenuEvent`
`MenuItem`
`MessageDialog`	This class provides a simple dialog that shows a single or multi-line message, with a choice of OK, Yes, No and/or Cancel buttons.
`MetaFile`
`MetafileDataObject`
`MetaFileDC`
`MimeTypesManager`
`MiniFrame`
`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 -- i.e.
`MouseCaptureChangedEvent`
`MouseEvent`
`MoveEvent`
`MultiChoiceDialog`	A simple dialog with a multi selection listbox.
`MutexGuiLocker`
`NativeEncodingInfo`
`NativeFontInfo`
`NavigationKeyEvent`
`NcPaintEvent`
`Notebook`
`NotebookEvent`
`NotebookPage`	There is an old (and apparently unsolvable) bug when placing a window with a nonstandard background colour in a wxNotebook on wxGTK, as the notbooks's background colour would always be used when the window is refreshed.
`NotebookSizer`
`NotifyEvent`
`Object`	The base class for most wx objects, although in wxPython not much functionality is needed nor exposed.
`OutputStream`
`PageSetupDialog`
`PageSetupDialogData`
`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`
`Palette`
`PaletteChangedEvent`
`Panel`
`PCXHandler`
`Pen`
`PenList`
`PNGHandler`
`PNMHandler`
`Point`	A data structure for representing a point or position with integer x and y properties.
`Point2D`	wx.Point2Ds represent a point or a vector in a 2d coordinate system with floating point values.
`PopupTransientWindow`
`PopupWindow`
`PostScriptDC`	This is a `wx.DC` that can write to PostScript files on any platform.
`PreviewCanvas`
`PreviewControlBar`
`PreviewFrame`
`PrintData`
`PrintDialog`
`PrintDialogData`
`Printer`
`PrinterDC`
`Printout`
`PrintPreview`
`Process`
`ProcessEvent`
`ProgressDialog`	A dialog that shows a short message and a progress bar.
`PropagateOnce`
`PropagationDisabler`
`PyApp`	The `wx.PyApp` class is an implementation detail, please use the `wx.App` class (or some other derived class) instead.
`PyBitmapDataObject`	wx.PyBitmapDataObject is a version of `wx.BitmapDataObject` that is Python-aware and knows how to reflect calls to its C++ virtual methods to methods in the Python derived class.
`PyCommandEvent`
`PyControl`
`PyDataObjectSimple`	wx.PyDataObjectSimple is a version of `wx.DataObjectSimple` that is Python-aware and knows how to reflect calls to its C++ virtual methods to methods in the Python derived class.
`PyDropTarget`
`PyEvent`
`PyEventBinder`	Instances of this class are used to bind specific events to event handlers.
`PyLog`
`PyOnDemandOutputWindow`	A class that can be used for redirecting Python's stdout and stderr streams.
`PyPanel`
`PyPreviewControlBar`
`PyPreviewFrame`
`PyPrintPreview`
`PyScrolledWindow`
`PySimpleApp`	A simple application class.
`PySizer`	wx.PySizer is a special version of `wx.Sizer` that has been instrumented to allow the C++ virtual methods to be overloaded in Python derived classes.
`PyTextDataObject`	wx.PyTextDataObject is a version of `wx.TextDataObject` that is Python-aware and knows how to reflect calls to its C++ virtual methods to methods in the Python derived class.
`PyTimer`
`PyTipProvider`
`PyValidator`
`PyWidgetTester`
`PyWindow`
`Quantize`	Performs quantization, or colour reduction, on a wxImage.
`QueryLayoutInfoEvent`
`QueryNewPaletteEvent`
`RadioBox`
`RadioButton`
`RealPoint`	A data structure for representing a point or position with floating point x and y properties.
`Rect`	A class for representing and manipulating rectangles.
`Region`
`RegionIterator`
`SashEvent`
`SashLayoutWindow`
`SashWindow`
`ScreenDC`	A wxScreenDC can be used to paint anywhere on the screen.
`ScrollBar`
`ScrolledWindow`
`ScrollEvent`
`ScrollWinEvent`
`SetCursorEvent`
`ShowEvent`
`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`	A simple dialog with a single selection listbox.
`SingleInstanceChecker`
`Size`	wx.Size is a useful data structure used to represent the size of something.
`SizeEvent`
`Sizer`	wx.Sizer is the abstract base class used for laying out subwindows in a window.
`SizerItem`	The wx.SizerItem class is used to track the position, size and other attributes of each item managed by a `wx.Sizer`.
`Slider`
`Sound`
`SpinButton`
`SpinCtrl`
`SpinEvent`
`SplashScreen`
`SplashScreenWindow`
`SplitterEvent`	This class represents the events generated by a splitter control.
`SplitterWindow`	wx.SplitterWindow manages up to two subwindows or panes, with an optional vertical or horizontal split which can be used with the mouse or programmatically.
`StaticBitmap`
`StaticBox`
`StaticBoxSizer`	wx.StaticBoxSizer derives from and functions identically to the `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer manages.
`StaticLine`
`StaticText`
`StatusBar`
`StopWatch`
`SysColourChangedEvent`
`SystemOptions`
`SystemSettings`
`TaskBarIcon`
`TaskBarIconEvent`
`TextAttr`
`TextCtrl`
`TextDataObject`	wx.TextDataObject is a specialization of `wx.DataObject` for text data.
`TextDropTarget`
`TextEntryDialog`	A dialog with text control, [ok] and [cancel] buttons
`TextUrlEvent`
`TIFFHandler`
`Timer`
`TimerEvent`
`TimerRunner`
`TimeSpan`
`TipProvider`
`TipWindow`
`ToggleButton`
`ToolBar`
`ToolBarBase`
`ToolBarToolBase`
`ToolTip`
`TopLevelWindow`
`TreeCtrl`
`TreeEvent`
`TreeItemData`
`TreeItemId`
`UpdateUIEvent`
`URLDataObject`	This data object holds a URL in a format that is compatible with some browsers such that it is able to be dragged to or from them.
`Validator`
`VideoMode`	A simple struct containing video mode parameters for a display
`VisualAttributes`	struct containing all the visual attributes of a control
`VListBox`
`VScrolledWindow`
`Window`	wx.Window is the base class for all windows and represents any visible object on the screen.
`WindowCreateEvent`
`WindowDC`	A wx.WindowDC must be constructed if an application wishes to paint on the whole area of a window (client and decorations).
`WindowDestroyEvent`
`WindowDisabler`
`XPMHandler`
`ZipFSHandler`

Exceptions
`PyAssertionError`
`PyDeadObjectError`
`PyNoAppError`
`PyUnbornObjectError`

Function Summary
	`App_CleanUp()` For internal use only, it is used to cleanup after wxWidgets when Python shuts down.
	`App_GetComCtl32Version(...)`
	`App_GetMacAboutMenuItemId(...)`
	`App_GetMacExitMenuItemId(...)`
	`App_GetMacHelpMenuTitleName(...)`
	`App_GetMacPreferencesMenuItemId(...)`
	`App_GetMacSupportPCMenuShortcuts(...)`
	`App_SetMacAboutMenuItemId(...)`
	`App_SetMacExitMenuItemId(...)`
	`App_SetMacHelpMenuTitleName(...)`
	`App_SetMacPreferencesMenuItemId(...)`
	`App_SetMacSupportPCMenuShortcuts(...)`
Bitmap	`ArtProvider_GetBitmap(id, client, size)` Query the providers for bitmap with given ID and return it.
Icon	`ArtProvider_GetIcon(id, client, size)` Query the providers for icon with given ID and return it.
bool	`ArtProvider_PopProvider()` Remove latest added provider and delete it.
	`ArtProvider_PushProvider(provider)` Add new provider to the top of providers stack.
bool	`ArtProvider_RemoveProvider(provider)` Remove provider.
	`BeginBusyCursor(cursor)`
	`Bell()`
Bitmap	`BitmapFromBits(bits, width, height, depth)` Creates a bitmap from an array of bits.
Bitmap	`BitmapFromIcon(icon)` Create a new bitmap from a `wx.Icon` object.
Bitmap	`BitmapFromImage(image, depth)` Creates bitmap object from a `wx.Image`.
Bitmap	`BitmapFromXPMData(listOfStrings)` Construct a Bitmap from a list of strings formatted as XPM data.
VisualAttributes	`BookCtrl_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
VisualAttributes	`Button_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
Size	`Button_GetDefaultSize()` Returns the default button size for this platform.
	`CallAfter(callable, args, *kw)` Call the specified function after the current and pending event handlers have been completed.
int	`Caret_GetBlinkTime()`
	`Caret_SetBlinkTime(milliseconds)`
VisualAttributes	`CheckBox_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
VisualAttributes	`Choice_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
(x, y, width, height)	`ClientDisplayRect()`
Clipboard	`Clipboard_Get()` Returns global instance (wxTheClipboard) of the object.
	`ColorRGB(args, *kwargs)` ColourRGB(unsigned long colRGB) -> Colour
bool	`ColourDisplay()`
	`ColourRGB(args, *kwargs)` ColourRGB(unsigned long colRGB) -> Colour
VisualAttributes	`ComboBox_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
ConfigBase	`ConfigBase_Create()` Create and return a new global config object.
	`ConfigBase_DontCreateOnDemand()` Should Get() try to create a new log object if there isn't a current one?
ConfigBase	`ConfigBase_Get(createOnDemand)` Returns the current global config object, creating one if neccessary.
ConfigBase	`ConfigBase_Set(config)` Sets the global config object (the one returned by Get) and returns a reference to the previous global config object.
VisualAttributes	`Control_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
TipProvider	`CreateFileTipProvider(filename, currentTip)`
Cursor	`CursorFromImage(image)` Constructs a cursor from a wxImage.
DataFormat	`CustomDataFormat(format)` Constructs a data format object for a custom format identified by its name.
DateSpan	`DateSpan_Day()`
DateSpan	`DateSpan_Days(days)`
DateSpan	`DateSpan_Month()`
DateSpan	`DateSpan_Months(mon)`
DateSpan	`DateSpan_Week()`
DateSpan	`DateSpan_Weeks(weeks)`
DateSpan	`DateSpan_Year()`
DateSpan	`DateSpan_Years(years)`
int	`DateTime_ConvertYearToBC(year)`
	`DateTime_GetAmPmStrings(args, *kwargs)` GetAmPmStrings() -> (am, pm)
DateTime	`DateTime_GetBeginDST(year, country)`
int	`DateTime_GetCentury(year)`
int	`DateTime_GetCountry()`
int	`DateTime_GetCurrentMonth(cal)`
int	`DateTime_GetCurrentYear(cal)`
DateTime	`DateTime_GetEndDST(year, country)`
String	`DateTime_GetMonthName(month, flags)`
int	`DateTime_GetNumberOfDaysInMonth(month, year, cal)`
int	`DateTime_GetNumberOfDaysinYear(year, cal)`
String	`DateTime_GetWeekDayName(weekday, flags)`
bool	`DateTime_IsDSTApplicable(year, country)`
bool	`DateTime_IsLeapYear(year, cal)`
bool	`DateTime_IsWestEuropeanCountry(country)`
DateTime	`DateTime_Now()`
	`DateTime_SetCountry(country)`
DateTime	`DateTime_SetToWeekOfYear(year, numWeek, weekday)`
DateTime	`DateTime_Today()`
DateTime	`DateTime_UNow()`
DateTime	`DateTimeFromDMY(day, month, year, hour, minute, second, millisec)`
DateTime	`DateTimeFromHMS(hour, minute, second, millisec)`
DateTime	`DateTimeFromJDN(jdn)`
DateTime	`DateTimeFromTimeT(timet)`
VisualAttributes	`Dialog_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
String	`DirSelector(message, defaultPath, style, pos, parent)`
size_t	`Display_GetCount()` Return the number of available displays.
int	`Display_GetFromPoint(pt)` Find the display where the given point lies, return wx.NOT_FOUND if it doesn't belong to any display
int	`Display_GetFromWindow(window)` Find the display where the given window lies, return wx.NOT_FOUND if it is not shown at all.
int	`DisplayDepth()`
(width, height)	`DisplaySize()`
(width, height)	`DisplaySizeMM()`
	`DLG_PNT(win, point_or_x, y)` Convenience function for converting a Point or (x,y) in dialog units to pixel units.
	`DLG_SZE(win, size_width, height)` Convenience function for converting a Size or (w,h) in dialog units to pixel units.
DragImage	`DragIcon(image, cursor)`
DragImage	`DragListItem(listCtrl, id)`
DragImage	`DragString(str, cursor)`
DragImage	`DragTreeItem(treeCtrl, id)`
	`DrawWindowOnDC(window, dc, method)`
Bitmap	`EmptyBitmap(width, height, depth)` Creates a new bitmap of the given size.
Icon	`EmptyIcon()`
Image	`EmptyImage(width, height, clear)`
	`EnableTopLevelWindows(enable)`
bool	`EncodingConverter_CanConvert(encIn, encOut)`
wxFontEncodingArray	`EncodingConverter_GetAllEquivalents(enc)`
wxFontEncodingArray	`EncodingConverter_GetPlatformEquivalents(enc, platform)`
	`EndBusyCursor()`
EventLoop	`EventLoop_GetActive()`
	`EventLoop_SetActive(loop)`
long	`Execute(command, flags, process)`
	`Exit()` Force an exit of the application.
String	`ExpandEnvVars(sz)` Replace environment variables ($SOMETHING) with their values.
String	`FileSelector(message, default_path, default_filename, default_extension, wildcard, flags, parent, x, y)`
	`FileSystem_AddHandler(handler)`
	`FileSystem_CleanUpHandlers()`
String	`FileSystem_FileNameToURL(filename)`
String	`FileSystem_URLToFileName(url)`
String	`FileType_ExpandCommand(command, filename, mimetype)`
FileTypeInfo	`FileTypeInfoSequence(sArray)`
Window	`FindWindowAtPoint(pt)`
Window	`FindWindowById(id, parent)` Find the first window in the application with the given id.
Window	`FindWindowByLabel(label, parent)` Find a window by its label.
Window	`FindWindowByName(name, parent)` Find a window by its name (as given in a window constructor or Create function call).
Font	`Font2(pointSize, family, flags, face, encoding)`
int	`Font_GetDefaultEncoding()`
	`Font_SetDefaultEncoding(encoding)`
Font	`FontFromNativeInfo(info)`
Font	`FontFromNativeInfoString(info)`
Font	`FontFromPixelSize(pixelSize, family, style, weight, underlined, face, encoding)`
FontMapper	`FontMapper_Get()`
String	`FontMapper_GetDefaultConfigPath()`
int	`FontMapper_GetEncoding(n)`
String	`FontMapper_GetEncodingDescription(encoding)`
int	`FontMapper_GetEncodingFromName(name)`
String	`FontMapper_GetEncodingName(encoding)`
size_t	`FontMapper_GetSupportedEncodingsCount()`
FontMapper	`FontMapper_Set(mapper)`
VisualAttributes	`Frame_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
VisualAttributes	`Gauge_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
GBSizerItem	`GBSizerItemSizer(sizer, pos, span, flag, border, userData)` Construct a `wx.GBSizerItem` for a sizer
GBSizerItem	`GBSizerItemSpacer(width, height, pos, span, flag, border, userData)` Construct a `wx.GBSizerItem` for a spacer.
GBSizerItem	`GBSizerItemWindow(window, pos, span, flag, border, userData)` Construct a `wx.GBSizerItem` for a window.
Window	`GenericFindWindowAtPoint(pt)`
AcceleratorEntry	`GetAccelFromString(label)`
Window	`GetActiveWindow()`
PyApp	`GetApp()` Return a reference to the current wx.App object.
Rect	`GetClientDisplayRect()`
long	`GetCurrentId()`
long	`GetCurrentTime()`
int	`GetDisplayDepth()`
Size	`GetDisplaySize()`
Size	`GetDisplaySizeMM()`
long	`GetElapsedTime(resetTimer)`
String	`GetEmailAddress()`
long	`GetFreeMemory()`
String	`GetFullHostName()`
String	`GetHomeDir()`
String	`GetHostName()`
bool	`GetKeyState(key)` Get the state of a key (true if pressed or toggled on, false if not.) This is generally most useful getting the state of the modifier or toggle keys.
Locale	`GetLocale()`
long	`GetLocalTime()`
wxLongLong	`GetLocalTimeMillis()`
(x,y)	`GetMousePosition()`
NativeEncodingInfo	`GetNativeFontEncoding(encoding)`
long	`GetNumberFromUser(message, prompt, caption, value, min, max, parent, pos)`
String	`GetOsDescription()`
(platform, major, minor)	`GetOsVersion()`
String	`GetPasswordFromUser(message, caption, default_value, parent)`
unsigned long	`GetProcessId()`
String	`GetSingleChoice(message, caption, choices, choices_array, parent, x, y, centre, width, height)`
int	`GetSingleChoiceIndex(message, caption, choices, choices_array, parent, x, y, centre, width, height)`
String	`GetStockLabel(id)`
String	`GetTextFromUser(message, caption, default_value, parent, x, y, centre)`
Window	`GetTopLevelParent(win)`
String	`GetTranslation(str)` GetTranslation(String str, String strPlural, size_t n) -> String
String	`GetUserHome(user)`
String	`GetUserId()`
String	`GetUserName()`
long	`GetUTCTime()`
HelpProvider	`HelpProvider_Get()` Return the current application-wide help provider.
HelpProvider	`HelpProvider_Set(helpProvider)` Sset the current, application-wide help provider.
IconBundle	`IconBundleFromFile(file, type)`
IconBundle	`IconBundleFromIcon(icon)`
Icon	`IconFromBitmap(bmp)`
Icon	`IconFromLocation(loc)`
Icon	`IconFromXPMData(listOfStrings)`
bool	`IdleEvent_CanSend(win)`
int	`IdleEvent_GetMode()`
	`IdleEvent_SetMode(mode)`
	`Image_AddHandler(handler)`
bool	`Image_CanRead(name)`
bool	`Image_CanReadStream(stream)`
int	`Image_GetImageCount(name, type)`
String	`Image_GetImageExtWildcard()`
	`Image_InsertHandler(handler)`
bool	`Image_RemoveHandler(name)`
Image	`ImageFromBitmap(bitmap)`
	`ImageFromData(args, *kwargs)` ImageFromData(int width, int height, unsigned char data) -> Image
Image	`ImageFromMime(name, mimetype, index)`
Image	`ImageFromStream(stream, type, index)`
Image	`ImageFromStreamMime(stream, mimetype, index)`
	`ImageHistogram_MakeKey(args, *kwargs)` ImageHistogram_MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
	`InitAllImageHandlers()` The former functionality of InitAllImageHanders is now done internal to the _core_ extension module and so this function has become a simple NOP.
Rect	`IntersectRect(r1, r2)` Calculate and return the intersection of r1 and r2.
bool	`IsBusy()`
bool	`IsDragResultOk(res)`
bool	`IsStockID(id)`
bool	`IsStockLabel(id, label)`
VisualAttributes	`ListBox_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
VisualAttributes	`ListCtrl_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
String	`LoadFileSelector(what, extension, default_name, parent)`
	`Locale_AddCatalogLookupPathPrefix(prefix)`
	`Locale_AddLanguage(info)`
LanguageInfo	`Locale_FindLanguageInfo(locale)`
LanguageInfo	`Locale_GetLanguageInfo(lang)`
String	`Locale_GetLanguageName(lang)`
int	`Locale_GetSystemEncoding()`
String	`Locale_GetSystemEncodingName()`
int	`Locale_GetSystemLanguage()`
	`Log_AddTraceMask(str)`
	`Log_ClearTraceMasks()`
	`Log_DontCreateOnDemand()`
bool	`Log_EnableLogging(doIt)`
	`Log_FlushActive()`
Log	`Log_GetActiveTarget()`
wxLogLevel	`Log_GetLogLevel()`
wxChar	`Log_GetTimestamp()`
wxTraceMask	`Log_GetTraceMask()`
wxArrayString	`Log_GetTraceMasks()`
bool	`Log_GetVerbose()`
bool	`Log_IsAllowedTraceMask(mask)`
bool	`Log_IsEnabled()`
	`Log_OnLog(level, szString, t)`
	`Log_RemoveTraceMask(str)`
	`Log_Resume()`
Log	`Log_SetActiveTarget(pLogger)`
	`Log_SetLogLevel(logLevel)`
	`Log_SetTimestamp(ts)`
	`Log_SetTraceMask(ulMask)`
	`Log_SetVerbose(bVerbose)`
	`Log_Suspend()`
String	`Log_TimeStamp()`
	`LogDebug(msg)`
	`LogError(msg)`
	`LogFatalError(msg)`
	`LogGeneric(args, *kwargs)` LogGeneric(unsigned long level, String msg)
	`LogInfo(msg)`
	`LogMessage(msg)`
	`LogStatus(msg)`
	`LogStatusFrame(pFrame, msg)`
	`LogSysError(msg)`
	`LogTrace(*args)` LogTrace(unsigned long mask, String msg) LogTrace(String mask, String msg)
	`LogVerbose(msg)`
	`LogWarning(msg)`
	`MaskColour(args, *kwargs)` wx.MaskColour is deprecated, use `wx.Mask` instead.
MemoryDC	`MemoryDCFromDC(oldDC)` Creates a DC that is compatible with the oldDC.
	`MemoryFSHandler_AddFile(filename, dataItem, imgType)` Add 'file' to the memory filesystem.
	`MemoryFSHandler_RemoveFile(filename)`
int	`MenuItem_GetDefaultMarginWidth()`
String	`MenuItem_GetLabelFromText(text)`
int	`MessageBox(message, caption, style, parent, x, y)`
	`MicroSleep(args, *kwargs)` MicroSleep(unsigned long microseconds)
	`MilliSleep(args, *kwargs)` MilliSleep(unsigned long milliseconds)
bool	`MimeTypesManager_IsOfType(mimeType, wildcard)`
	`MutexGuiEnter()`
	`MutexGuiLeave()`
Colour	`NamedColor(colorName)` Constructs a colour object using a colour name listed in `wx.TheColourDatabase`.
Colour	`NamedColour(colorName)` Constructs a colour object using a colour name listed in `wx.TheColourDatabase`.
wxEventType	`NewEventType()`
long	`NewId()`
VisualAttributes	`Notebook_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
String	`Now()`
FileTypeInfo	`NullFileTypeInfo()`
VisualAttributes	`Panel_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
Point2D	`Point2DCopy(pt)` Create a w.Point2D object.
Point2D	`Point2DFromPoint(pt)` Create a w.Point2D object.
	`PostEvent(dest, event)` Send an event to a window or other wx.EvtHandler to be processed later.
int	`PostScriptDC_GetResolution()` Return resolution used in PostScript output.
	`PostScriptDC_SetResolution(ppi)` Set resolution (in pixels per inch) that will be used in PostScript output.
BitmapButton	`PreBitmapButton()` Precreate a BitmapButton for 2-phase creation.
Button	`PreButton()` Precreate a Button for 2-phase creation.
CheckBox	`PreCheckBox()` Precreate a CheckBox for 2-phase creation.
CheckListBox	`PreCheckListBox()`
Choice	`PreChoice()` Precreate a Choice control for 2-phase creation.
Choicebook	`PreChoicebook()`
ComboBox	`PreComboBox()` Precreate a ComboBox control for 2-phase creation.
Control	`PreControl()` Precreate a Control control for 2-phase creation
Dialog	`PreDialog()`
DirFilterListCtrl	`PreDirFilterListCtrl()`
FindReplaceDialog	`PreFindReplaceDialog()` Precreate a FindReplaceDialog for 2-phase creation
Frame	`PreFrame()`
Gauge	`PreGauge()`
GenericDirCtrl	`PreGenericDirCtrl()`
HtmlListBox	`PreHtmlListBox()`
Listbook	`PreListbook()`
ListBox	`PreListBox()`
ListCtrl	`PreListCtrl()`
ListView	`PreListView()`
MDIChildFrame	`PreMDIChildFrame()`
MDIClientWindow	`PreMDIClientWindow()`
MDIParentFrame	`PreMDIParentFrame()`
MiniFrame	`PreMiniFrame()`
Notebook	`PreNotebook()`
Panel	`PrePanel()`
PopupTransientWindow	`PrePopupTransientWindow()`
PopupWindow	`PrePopupWindow()`
PyControl	`PrePyControl()`
PyPanel	`PrePyPanel()`
PyScrolledWindow	`PrePyScrolledWindow()`
PyWindow	`PrePyWindow()`
RadioBox	`PreRadioBox()`
RadioButton	`PreRadioButton()`
SashLayoutWindow	`PreSashLayoutWindow()`
SashWindow	`PreSashWindow()`
ScrollBar	`PreScrollBar()`
ScrolledWindow	`PreScrolledWindow()`
SingleInstanceChecker	`PreSingleInstanceChecker()`
Slider	`PreSlider()`
SpinButton	`PreSpinButton()`
SpinCtrl	`PreSpinCtrl()`
SplitterWindow	`PreSplitterWindow()` Precreate a SplitterWindow for 2-phase creation.
StaticBitmap	`PreStaticBitmap()`
StaticBox	`PreStaticBox()`
StaticLine	`PreStaticLine()`
StaticText	`PreStaticText()`
StatusBar	`PreStatusBar()`
TextCtrl	`PreTextCtrl()`
ToggleButton	`PreToggleButton()`
ToolBar	`PreToolBar()`
TreeCtrl	`PreTreeCtrl()`
VListBox	`PreVListBox()`
VScrolledWindow	`PreVScrolledWindow()`
Window	`PreWindow()` Precreate a Window for 2-phase creation.
int	`Printer_GetLastError()`
bool	`Process_Exists(pid)`
int	`Process_Kill(pid, sig)`
Process	`Process_Open(cmd, flags)`
int	`PyApp_GetComCtl32Version()` Returns 400, 470, 471, etc.
long	`PyApp_GetMacAboutMenuItemId()`
long	`PyApp_GetMacExitMenuItemId()`
String	`PyApp_GetMacHelpMenuTitleName()`
long	`PyApp_GetMacPreferencesMenuItemId()`
bool	`PyApp_GetMacSupportPCMenuShortcuts()`
bool	`PyApp_IsMainLoopRunning()` Returns True if we're running the main loop, i.e.
	`PyApp_SetMacAboutMenuItemId(val)`
	`PyApp_SetMacExitMenuItemId(val)`
	`PyApp_SetMacHelpMenuTitleName(val)`
	`PyApp_SetMacPreferencesMenuItemId(val)`
	`PyApp_SetMacSupportPCMenuShortcuts(val)`
bool	`Quantize_Quantize(src, dest, desiredNoColours, flags)` Reduce the colours in the source image and put the result into the destination image, setting the palette in the destination if needed.
VisualAttributes	`RadioBox_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
VisualAttributes	`RadioButton_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
Rect	`RectPP(topLeft, bottomRight)` Create a new Rect object from Points representing two corners.
Rect	`RectPS(pos, size)` Create a new Rect from a position and size.
Region	`RegionFromBitmap(bmp)`
Region	`RegionFromBitmapColour(bmp, transColour, tolerance)`
Region	`RegionFromPoints(points, points_array, fillStyle)`
	`RegisterId(id)`
	`SafeShowMessage(title, text)`
bool	`SafeYield(win, onlyIfNeeded)` This function is similar to `wx.Yield`, except that it disables the user input to all program windows before calling `wx.Yield` and re-enables it again afterwards.
String	`SaveFileSelector(what, extension, default_name, parent)`
VisualAttributes	`ScrollBar_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
VisualAttributes	`ScrolledWindow_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
	`SetCursor(cursor)`
bool	`Shell(command)`
bool	`ShowTip(parent, tipProvider, showAtStartup)`
bool	`Shutdown(wFlags)`
SizerItem	`SizerItemSizer(sizer, proportion, flag, border, userData)` Constructs a `wx.SizerItem` for tracking a subsizer
SizerItem	`SizerItemSpacer(width, height, proportion, flag, border, userData)` Constructs a `wx.SizerItem` for tracking a spacer.
SizerItem	`SizerItemWindow(window, proportion, flag, border, userData)` Constructs a `wx.SizerItem` for tracking a window.
	`Sleep(secs)`
VisualAttributes	`Slider_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
	`Sound_PlaySound(args, *kwargs)` Sound_PlaySound(String filename, unsigned int flags=SOUND_ASYNC) -> bool
	`Sound_Stop()`
Sound	`SoundFromData(data)`
VisualAttributes	`SpinButton_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
VisualAttributes	`SpinCtrl_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
VisualAttributes	`SplitterWindow_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
	`StartTimer()`
VisualAttributes	`StaticBitmap_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
VisualAttributes	`StaticBox_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
VisualAttributes	`StaticLine_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
int	`StaticLine_GetDefaultSize()`
VisualAttributes	`StaticText_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
VisualAttributes	`StatusBar_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
Cursor	`StockCursor(id)` Create a cursor using one of the stock cursors.
String	`StripMenuCodes(in)`
unsigned long	`SysErrorCode()`
	`SysErrorMsg(args, *kwargs)` SysErrorMsg(unsigned long nErrCode=0) -> String
String	`SystemOptions_GetOption(name)`
int	`SystemOptions_GetOptionInt(name)`
bool	`SystemOptions_HasOption(name)`
	`SystemOptions_SetOption(name, value)`
	`SystemOptions_SetOptionInt(name, value)`
Colour	`SystemSettings_GetColour(index)`
Font	`SystemSettings_GetFont(index)`
int	`SystemSettings_GetMetric(index)`
int	`SystemSettings_GetScreenType()`
bool	`SystemSettings_HasFeature(index)`
	`SystemSettings_SetScreenType(screen)`
bool	`TestFontEncoding(info)`
TextAttr	`TextAttr_Combine(attr, attrDef, text)`
VisualAttributes	`TextCtrl_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
bool	`Thread_IsMain()`
TimeSpan	`TimeSpan_Day()`
TimeSpan	`TimeSpan_Days(days)`
TimeSpan	`TimeSpan_Hour()`
TimeSpan	`TimeSpan_Hours(hours)`
TimeSpan	`TimeSpan_Minute()`
TimeSpan	`TimeSpan_Minutes(min)`
TimeSpan	`TimeSpan_Second()`
TimeSpan	`TimeSpan_Seconds(sec)`
TimeSpan	`TimeSpan_Week()`
TimeSpan	`TimeSpan_Weeks(days)`
VisualAttributes	`ToggleButton_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
VisualAttributes	`ToolBar_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
	`ToolTip_Enable(flag)`
	`ToolTip_SetDelay(milliseconds)`
	`Trap()`
VisualAttributes	`TreeCtrl_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
bool	`UpdateUIEvent_CanUpdate(win)`
int	`UpdateUIEvent_GetMode()`
long	`UpdateUIEvent_GetUpdateInterval()`
	`UpdateUIEvent_ResetUpdateTime()`
	`UpdateUIEvent_SetMode(mode)`
	`UpdateUIEvent_SetUpdateInterval(updateInterval)`
	`Usleep(args, *kwargs)` MilliSleep(unsigned long milliseconds)
bool	`Validator_IsSilent()`
	`Validator_SetBellOnError(doIt)`
	`WakeUpIdle()` Cause the message queue to become empty again, so idle events will be sent.
	`WakeUpMainThread()`
Window	`Window_FindFocus()` Returns the window or control that currently has the keyboard focus, or None.
	`Window_FromHWND(args, *kwargs)` Window_FromHWND(Window parent, unsigned long _hWnd) -> Window
Window	`Window_GetCapture()` Returns the window which currently captures the mouse or None
VisualAttributes	`Window_GetClassDefaultAttributes(variant)` Get the default attributes for this class.
int	`Window_NewControlId()` Generate a control id for the controls which were not given one.
int	`Window_NextControlId(winid)` Get the id of the control following the one with the given autogenerated) id
int	`Window_PrevControlId(winid)` Get the id of the control preceding the one with the given autogenerated) id
bool	`Yield()` Yield to other apps/messages.
bool	`YieldIfNeeded()` Yield to other apps/messages.

Function Details

App_CleanUp()

For internal use only, it is used to cleanup after wxWidgets when Python shuts down.

ArtProvider_GetBitmap(id, client=ART_OTHER, size=DefaultSize)

Query the providers for bitmap with given ID and return it. Return wx.NullBitmap if no provider provides it.

Parameters:: id
(type=String); client
(type=String); size
(type=Size)

Returns:: Bitmap

ArtProvider_GetIcon(id, client=ART_OTHER, size=DefaultSize)

Query the providers for icon with given ID and return it. Return wx.NullIcon if no provider provides it.

Parameters:: id
(type=String); client
(type=String); size
(type=Size)

Returns:: Icon

ArtProvider_PopProvider()

Remove latest added provider and delete it.

Returns:: bool

ArtProvider_PushProvider(provider)

Add new provider to the top of providers stack.

Parameters:: provider
(type=ArtProvider)

ArtProvider_RemoveProvider(provider)

Remove provider. The provider must have been added previously! The provider is _not_ deleted.

Parameters:: provider
(type=ArtProvider)

Returns:: bool

BitmapFromBits(bits, width, height, depth=1)

Creates a bitmap from an array of bits. You should only use this function for monochrome bitmaps (depth 1) in portable programs: in this case the bits parameter should contain an XBM image. For other bit depths, the behaviour is platform dependent.

Parameters:: bits
(type=PyObject); width
(type=int); height
(type=int); depth
(type=int)

Returns:: Bitmap

BitmapFromIcon(icon)

Create a new bitmap from a wx.Icon object.

Parameters:: icon
(type=Icon)

Returns:: Bitmap

BitmapFromImage(image, depth=-1)

Creates bitmap object from a wx.Image. This has to be done to actually display a wx.Image as you cannot draw an image directly on a window. The resulting bitmap will use the provided colour depth (or that of the current screen colour depth if depth is -1) which entails that a colour reduction may have to take place.

Parameters:: image
(type=Image); depth
(type=int)

Returns:: Bitmap

BitmapFromXPMData(listOfStrings)

Construct a Bitmap from a list of strings formatted as XPM data.

Parameters:: listOfStrings
(type=PyObject)

Returns:: Bitmap

BookCtrl_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Get the default attributes for this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes.

The variant parameter is only relevant under Mac currently and is ignore under other platforms. Under Mac, it will change the size of the returned font. See wx.Window.SetWindowVariant for more about this.

Parameters:: variant
(type=int)

Returns:: VisualAttributes

Button_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

Button_GetDefaultSize()

Returns the default button size for this platform.

Returns:: Size

CallAfter(callable, *args, **kw)

Call the specified function after the current and pending event handlers have been completed. This is also good for making GUI method calls from non-GUI threads. Any extra positional or keyword args are passed on to the callable when it is called.

: See Also: wx.FutureCall

CheckBox_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

Choice_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

Clipboard_Get()

Returns global instance (wxTheClipboard) of the object.

Returns:: Clipboard

ColorRGB(*args, **kwargs)

ColourRGB(unsigned long colRGB) -> Colour

Constructs a colour from a packed RGB value.

ColourRGB(*args, **kwargs)

ColourRGB(unsigned long colRGB) -> Colour

Constructs a colour from a packed RGB value.

ComboBox_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

ConfigBase_Create()

Create and return a new global config object. This function will create the "best" implementation of wx.Config available for the current platform.

Returns:: ConfigBase

ConfigBase_DontCreateOnDemand()

Should Get() try to create a new log object if there isn't a current one?

ConfigBase_Get(createOnDemand=True)

Returns the current global config object, creating one if neccessary.

Parameters:: createOnDemand
(type=bool)

Returns:: ConfigBase

ConfigBase_Set(config)

Sets the global config object (the one returned by Get) and returns a reference to the previous global config object.

Parameters:: config
(type=ConfigBase)

Returns:: ConfigBase

Control_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

CursorFromImage(image)

Constructs a cursor from a wxImage. The cursor is monochrome, colors with the RGB elements all greater than 127 will be foreground, colors less than this background. The mask (if any) will be used as transparent. In MSW the foreground will be white and the background black. The cursor is resized to 32x32.

In GTK, the two most frequent colors will be used for foreground and background. The cursor will be displayed at the size of the image.

On MacOS the cursor is resized to 16x16 and currently only shown as black/white (mask respected).

Parameters:: image
(type=Image)

Returns:: Cursor

CustomDataFormat(format)

Constructs a data format object for a custom format identified by its name.

Parameters:: format
(type=String)

Returns:: DataFormat

DateTime_GetAmPmStrings(*args, **kwargs)

GetAmPmStrings() -> (am, pm)

Get the AM and PM strings in the current locale (may be empty)

Dialog_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

Display_GetCount()

Return the number of available displays.

Returns:: size_t

Display_GetFromPoint(pt)

Find the display where the given point lies, return wx.NOT_FOUND if it doesn't belong to any display

Parameters:: pt
(type=Point)

Returns:: int

Display_GetFromWindow(window)

Find the display where the given window lies, return wx.NOT_FOUND if it is not shown at all.

Parameters:: window
(type=Window)

Returns:: int

DLG_PNT(win, point_or_x, y=None)

Convenience function for converting a Point or (x,y) in dialog units to pixel units.

DLG_SZE(win, size_width, height=None)

Convenience function for converting a Size or (w,h) in dialog units to pixel units.

EmptyBitmap(width, height, depth=-1)

Creates a new bitmap of the given size. A depth of -1 indicates the depth of the current screen or visual. Some platforms only support 1 for monochrome and -1 for the current colour setting.

Parameters:: width
(type=int); height
(type=int); depth
(type=int)

Returns:: Bitmap

Exit()

Force an exit of the application. Convenience for wx.GetApp().Exit()

ExpandEnvVars(sz)

Replace environment variables ($SOMETHING) with their values. The format is $VARNAME or ${VARNAME} where VARNAME contains alphanumeric characters and '_' only. '$' must be escaped ('$') in order to be taken literally.

Parameters:: sz
(type=String)

Returns:: String

FindWindowById(id, parent=None)

Find the first window in the application with the given id. If parent is None, the search will start from all top-level frames and dialog boxes; if non-None, the search will be limited to the given window hierarchy. The search is recursive in both cases.

Parameters:: id
(type=long); parent
(type=Window)

Returns:: Window

FindWindowByLabel(label, parent=None)

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 non-None, the search will be limited to the given window hierarchy. The search is recursive in both cases.

Parameters:: label
(type=String); parent
(type=Window)

Returns:: Window

FindWindowByName(name, parent=None)

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 non-None, the search will be limited to the given window hierarchy. The search is recursive in both cases.

If no window with such name is found, wx.FindWindowByLabel is called.

Parameters:: name
(type=String); parent
(type=Window)

Returns:: Window

Frame_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

Gauge_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

GBSizerItemSizer(sizer, pos, span, flag, border, userData=None)

Construct a wx.GBSizerItem for a sizer

Parameters:: sizer
(type=Sizer); pos
(type=GBPosition); span
(type=GBSpan); flag
(type=int); border
(type=int); userData
(type=PyObject)

Returns:: GBSizerItem

GBSizerItemSpacer(width, height, pos, span, flag, border, userData=None)

Construct a wx.GBSizerItem for a spacer.

Parameters:: width
(type=int); height
(type=int); pos
(type=GBPosition); span
(type=GBSpan); flag
(type=int); border
(type=int); userData
(type=PyObject)

Returns:: GBSizerItem

GBSizerItemWindow(window, pos, span, flag, border, userData=None)

Construct a wx.GBSizerItem for a window.

Parameters:: window
(type=Window); pos
(type=GBPosition); span
(type=GBSpan); flag
(type=int); border
(type=int); userData
(type=PyObject)

Returns:: GBSizerItem

GetApp()

Return a reference to the current wx.App object.

Returns:: PyApp

GetKeyState(key)

Get the state of a key (true if pressed or toggled on, false if not.) This is generally most useful getting the state of the modifier or toggle keys. On some platforms those may be the only keys that work.

Parameters:: key
(type=int)

Returns:: bool

GetTranslation(str)

GetTranslation(String str, String strPlural, size_t n) -> String

Parameters:: str
(type=String)

Returns:: String

HelpProvider_Get()

Return the current application-wide help provider.

Returns:: HelpProvider

HelpProvider_Set(helpProvider)

Sset the current, application-wide help provider. Returns the previous one. Unlike some other classes, the help provider is not created on demand. This must be explicitly done by the application.

Parameters:: helpProvider
(type=HelpProvider)

Returns:: HelpProvider

ImageFromData(*args, **kwargs)

ImageFromData(int width, int height, unsigned char data) -> Image

ImageHistogram_MakeKey(*args, **kwargs)

ImageHistogram_MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long

Get the key in the histogram for the given RGB values

InitAllImageHandlers()

The former functionality of InitAllImageHanders is now done internal to the _core_ extension module and so this function has become a simple NOP.

IntersectRect(r1, r2)

Calculate and return the intersection of r1 and r2.

Parameters:: r1
(type=Rect); r2
(type=Rect)

Returns:: Rect

ListBox_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

ListCtrl_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

LogGeneric(*args, **kwargs)

LogGeneric(unsigned long level, String msg)

LogTrace(*args)

LogTrace(unsigned long mask, String msg) LogTrace(String mask, String msg)

MaskColour(*args, **kwargs)

wx.MaskColour is deprecated, use wx.Mask instead.

MemoryDCFromDC(oldDC)

Creates a DC that is compatible with the oldDC.

Parameters:: oldDC
(type=DC)

Returns:: MemoryDC

MemoryFSHandler_AddFile(filename, dataItem, imgType=-1)

Add 'file' to the memory filesystem. The dataItem parameter can either be a wx.Bitmap, wx.Image or a string that can contain arbitrary data. If a bitmap or image is used then the imgType parameter should specify what kind of image file it should be written as, wx.BITMAP_TYPE_PNG, etc.

MicroSleep(*args, **kwargs)

MicroSleep(unsigned long microseconds)

MilliSleep(*args, **kwargs)

MilliSleep(unsigned long milliseconds)

NamedColor(colorName)

Constructs a colour object using a colour name listed in wx.TheColourDatabase.

Parameters:: colorName
(type=String)

Returns:: Colour

NamedColour(colorName)

Constructs a colour object using a colour name listed in wx.TheColourDatabase.

Parameters:: colorName
(type=String)

Returns:: Colour

Notebook_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

Panel_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

Point2DCopy(pt)

Create a w.Point2D object.

Parameters:: pt
(type=Point2D)

Returns:: Point2D

Point2DFromPoint(pt)

Create a w.Point2D object.

Parameters:: pt
(type=Point)

Returns:: Point2D

PostEvent(dest, event)

Send an event to a window or other wx.EvtHandler to be processed later.

Parameters:: dest
(type=EvtHandler); event
(type=Event)

PostScriptDC_GetResolution()

Return resolution used in PostScript output.

Returns:: int

PostScriptDC_SetResolution(ppi)

Set resolution (in pixels per inch) that will be used in PostScript output. Default is 720ppi.

Parameters:: ppi
(type=int)

PreBitmapButton()

Precreate a BitmapButton for 2-phase creation.

Returns:: BitmapButton

PreButton()

Precreate a Button for 2-phase creation.

Returns:: Button

PreCheckBox()

Precreate a CheckBox for 2-phase creation.

Returns:: CheckBox

PreChoice()

Precreate a Choice control for 2-phase creation.

Returns:: Choice

PreComboBox()

Precreate a ComboBox control for 2-phase creation.

Returns:: ComboBox

PreControl()

Precreate a Control control for 2-phase creation

Returns:: Control

PreFindReplaceDialog()

Precreate a FindReplaceDialog for 2-phase creation

Returns:: FindReplaceDialog

PreSplitterWindow()

Precreate a SplitterWindow for 2-phase creation.

Returns:: SplitterWindow

PreWindow()

Precreate a Window for 2-phase creation.

Returns:: Window

PyApp_GetComCtl32Version()

Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if it wasn't found at all. Raises an exception on non-Windows platforms.

Returns:: int

PyApp_IsMainLoopRunning()

Returns True if we're running the main loop, i.e. if the events can currently be dispatched.

Returns:: bool

Quantize_Quantize(src, dest, desiredNoColours=236, flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTIN...)

Reduce the colours in the source image and put the result into the destination image, setting the palette in the destination if needed. Both images may be the same, to overwrite the source image. :todo: Create a version that returns the wx.Palette used.

Parameters:: src
(type=Image); dest
(type=Image); desiredNoColours
(type=int); flags
(type=int)

Returns:: bool

RadioBox_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

RadioButton_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

RectPP(topLeft, bottomRight)

Create a new Rect object from Points representing two corners.

Parameters:: topLeft
(type=Point); bottomRight
(type=Point)

Returns:: Rect

RectPS(pos, size)

Create a new Rect from a position and size.

Parameters:: pos
(type=Point); size
(type=Size)

Returns:: Rect

SafeYield(win=None, onlyIfNeeded=False)

This function is similar to wx.Yield, except that it disables the user input to all program windows before calling wx.Yield and re-enables it again afterwards. If win is not None, this window will remain enabled, allowing the implementation of some limited user interaction.

Parameters:: win
(type=Window); onlyIfNeeded
(type=bool)

Returns:: the result of the call to wx.Yield.
(type=bool)

ScrollBar_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

ScrolledWindow_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

SizerItemSizer(sizer, proportion, flag, border, userData=None)

Constructs a wx.SizerItem for tracking a subsizer

Parameters:: sizer
(type=Sizer); proportion
(type=int); flag
(type=int); border
(type=int); userData
(type=PyObject)

Returns:: SizerItem

SizerItemSpacer(width, height, proportion, flag, border, userData=None)

Constructs a wx.SizerItem for tracking a spacer.

Parameters:: width
(type=int); height
(type=int); proportion
(type=int); flag
(type=int); border
(type=int); userData
(type=PyObject)

Returns:: SizerItem

SizerItemWindow(window, proportion, flag, border, userData=None)

Constructs a wx.SizerItem for tracking a window.

Parameters:: window
(type=Window); proportion
(type=int); flag
(type=int); border
(type=int); userData
(type=PyObject)

Returns:: SizerItem

Slider_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

Sound_PlaySound(*args, **kwargs)

Sound_PlaySound(String filename, unsigned int flags=SOUND_ASYNC) -> bool

SpinButton_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

SpinCtrl_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

SplitterWindow_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

StaticBitmap_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

StaticBox_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

StaticLine_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

StaticText_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

StatusBar_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

StockCursor(id)

Create a cursor using one of the stock cursors. Note that not all cursors are available on all platforms.

Parameters:: id
(type=int)

Returns:: Cursor

SysErrorMsg(*args, **kwargs)

SysErrorMsg(unsigned long nErrCode=0) -> String

TextCtrl_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

ToggleButton_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

ToolBar_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

TreeCtrl_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

Usleep(*args, **kwargs)

MilliSleep(unsigned long milliseconds)

WakeUpIdle()

Cause the message queue to become empty again, so idle events will be sent.

Window_FindFocus()

Returns the window or control that currently has the keyboard focus, or None.

Returns:: Window

Window_FromHWND(*args, **kwargs)

Window_FromHWND(Window parent, unsigned long _hWnd) -> Window

Window_GetCapture()

Returns the window which currently captures the mouse or None

Returns:: Window

Window_GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:: variant
(type=int)

Returns:: VisualAttributes

Window_NewControlId()

Generate a control id for the controls which were not given one.

Returns:: int

Window_NextControlId(winid)

Get the id of the control following the one with the given autogenerated) id

Parameters:: winid
(type=int)

Returns:: int

Window_PrevControlId(winid)

Get the id of the control preceding the one with the given autogenerated) id

Parameters:: winid
(type=int)

Returns:: int

Yield()

Yield to other apps/messages. Convenience for wx.GetApp().Yield()

Returns:: bool

YieldIfNeeded()

Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)

Returns:: bool

Generated by Epydoc 2.1.20040428.rpd on Tue Nov 9 17:03:36 2004

http://epydoc.sf.net