.. include:: headings.inc ========================================================================= **Core** Classes ========================================================================= This is an alphabetical listing of all the classes defined in the **Core** module, together with a brief description of them (if available). You can look up a class using the alphabetical listing of them. Class Summary ============= ================================================================================ ================================================================================ **Class** **Short Description** ================================================================================ ================================================================================ :ref:`AcceleratorEntry` An object used by an application wishing to create an accelerator table (see :ref:`AcceleratorTable`). :ref:`AcceleratorTable` An accelerator table allows the application to specify a table of keyboard shortcuts for menu or button commands. :ref:`ActivateEvent` An activate event is sent when a window or application is being activated or deactivated. :ref:`AffineMatrix2D` A 3x2 matrix representing an affine ``2D`` transformation. :ref:`AffineMatrix2DBase` A 2x3 matrix representing an affine ``2D`` transformation. :ref:`AnyButton` A class for common button functionality used as the base for the various button classes. :ref:`App` The ``wx.App`` class represents the application and is used to: :ref:`AppConsole` This class is essential for writing console-only or hybrid apps without having to define ``USE_GUI=0`` . :ref:`AppTraits` The :ref:`AppTraits` class defines various configurable aspects of a :ref:`App`. :ref:`ArchiveFSHandler` A file system handler for accessing files inside of archives. :ref:`ArtProvider` :ref:`ArtProvider` class is used to customize the look of wxWidgets application. :ref:`AutoBufferedPaintDC` This :ref:`DC` derivative can be used inside of an ``EVT_PAINT()`` event handler to achieve double-buffered drawing. :ref:`Bitmap` This class encapsulates the concept of a platform-dependent bitmap, either monochrome or colour or colour with alpha channel support. :ref:`BitmapButton` A bitmap button is a control that contains a bitmap. :ref:`BitmapDataObject` :ref:`BitmapDataObject` is a specialization of :ref:`DataObject` for bitmap data. :ref:`BitmapToggleButton` :ref:`BitmapToggleButton` is a :ref:`ToggleButton` that contains a bitmap instead of text. :ref:`BookCtrlBase` A book control is a convenient way of displaying multiple pages of information, displayed one page at a time. :ref:`BookCtrlEvent` This class represents the events generated by book controls (:ref:`Notebook`, `Listbook`, `Choicebook`, `Treebook`, `AuiNotebook`). :ref:`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. :ref:`Brush` A brush is a drawing tool for filling in areas. :ref:`BrushList` A brush list is a list containing all brushes which have been created. :ref:`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 :ref:`Bitmap`) and then copied to the screen, using the associated :ref:`DC`, only once, when this object is destroyed. :ref:`BufferedPaintDC` This is a subclass of :ref:`BufferedDC` which can be used inside of an ``EVT_PAINT()`` event handler to achieve double-buffered drawing. :ref:`BusyCursor` This class makes it easy to tell your user that the program is temporarily busy. :ref:`Button` A button is a control that contains a text string, and is one of the most common elements of a GUI. :ref:`ButtonLabel` Helper class allowing to use either stock id or string labels. :ref:`CallLater` A convenience class for :class:`Timer`, that calls the given callable :ref:`CheckBox` A checkbox is a labelled box which by default is either on (checkmark is visible) or off (no checkmark). :ref:`CheckListBox` A :ref:`CheckListBox` is like a :ref:`ListBox`, but allows items to be checked or unchecked. :ref:`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. :ref:`Choice` A choice item is used to select one of a list of strings. :ref:`ClientDC` A :ref:`ClientDC` must be constructed if an application wishes to paint on the client area of a window from outside an EVT_PAINT() handler. :ref:`Clipboard` A class for manipulating the clipboard. :ref:`ClipboardTextEvent` This class represents the events generated by a control (typically a :ref:`TextCtrl` but other windows can generate these events as well) when its content gets copied or cut to, or pasted from the clipboard. :ref:`CloseEvent` This event class contains information about window and session close events. :ref:`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. :ref:`CollapsiblePaneEvent` This event class is used for the events generated by :ref:`CollapsiblePane`. :ref:`Colour` A colour is an object representing a combination of Red, Green, and Blue (``RGB``) intensity values, and is used to determine drawing colours. :ref:`ColourData` This class holds a variety of information related to colour dialogs. :ref:`ColourDatabase` wxWidgets maintains a database of standard ``RGB`` colours for a predefined set of named colours. :ref:`ColourDialog` This class represents the colour chooser dialog. :ref:`ColourPickerCtrl` This control allows the user to select a colour. :ref:`ColourPickerEvent` This event class is used for the events generated by :ref:`ColourPickerCtrl`. :ref:`ComboBox` A combobox is like a combination of an edit control and a listbox. :ref:`CommandEvent` This event class contains information about command events, which originate from a variety of simple controls. :ref:`ConfigBase` :ref:`ConfigBase` defines the basic interface of all config classes. :ref:`ConfigPathChanger` A handy little class which changes the current path in a Config object and restores it in dtor. :ref:`ContextHelp` This class changes the cursor to a query and puts the application into a 'context-sensitive help mode'. :ref:`ContextHelpButton` Instances of this class may be used to add a question mark button that when pressed, puts the application into context-help mode. :ref:`ContextMenuEvent` This class is used for context menu events, sent to give the application a chance to show a context (popup) menu for a :ref:`Window`. :ref:`Control` This is the base class for a control or "widget". :ref:`ControlWithItems` This is convenience class that derives from both :ref:`Control` and :ref:`ItemContainer`. :ref:`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. :ref:`CustomDataObject` :ref:`CustomDataObject` is a specialization of :ref:`DataObjectSimple` for some application-specific data in arbitrary (either custom or one of the standard ones). :ref:`DC` A :ref:`DC` is a `"device context"` onto which graphics and text can be drawn. :ref:`DCBrushChanger` :ref:`DCBrushChanger` is a small helper class for setting a brush on a :ref:`DC` and unsetting it automatically in the destructor, restoring the previous one. :ref:`DCClipper` :ref:`DCClipper` is a helper class for setting a clipping region on a :ref:`DC` during its lifetime. :ref:`DCFontChanger` :ref:`DCFontChanger` is a small helper class for setting a font on a :ref:`DC` and unsetting it automatically in the destructor, restoring the previous one. :ref:`DCOverlay` Connects an overlay with a drawing DC. :ref:`DCPenChanger` :ref:`DCPenChanger` is a small helper class for setting a pen on a :ref:`DC` and unsetting it automatically in the destructor, restoring the previous one. :ref:`DCTextColourChanger` :ref:`DCTextColourChanger` is a small helper class for setting a foreground text colour on a :ref:`DC` and unsetting it automatically in the destructor, restoring the previous one. :ref:`DataFormat` A :ref:`DataFormat` is an encapsulation of a platform-specific format handle which is used by the system for the clipboard and drag and drop operations. :ref:`DataObject` A :ref:`DataObject` represents data that can be copied to or from the clipboard, or dragged and dropped. :ref:`DataObjectComposite` :ref:`DataObjectComposite` is the simplest :ref:`DataObject` derivation which may be used to support multiple formats. :ref:`DataObjectSimple` This is the simplest possible implementation of the :ref:`DataObject` class. :ref:`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 60602431 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 -- we want to get Mar, 15, of course). :ref:`DateTime` :ref:`DateTime` class represents an absolute moment in time. :ref:`Dialog` A dialog box is a window with a title bar and sometimes a system menu, which can be moved around the screen. :ref:`DialogLayoutAdapter` This abstract class is the base for classes that help wxWidgets perform run-time layout adaptation of dialogs. :ref:`DirDialog` This class represents the directory chooser dialog. :ref:`DirFilterListCtrl` :ref:`DirPickerCtrl` This control allows the user to select a directory. :ref:`Display` Determines the sizes and locations of displays connected to the system. :ref:`DisplayChangedEvent` :ref:`DragImage` This class is used when you wish to drag an object on the screen, and a simple cursor is not enough. :ref:`DropFilesEvent` This class is used for drop files events, that is, when files have been dropped onto the window. :ref:`DropSource` This class represents a source for a drag and drop operation. :ref:`DropTarget` This class represents a target for a drag and drop operation. :ref:`EraseEvent` An erase event is sent when a window's background needs to be repainted. :ref:`Event` An event is a structure holding information about an event passed to a callback or member function. :ref:`EventBlocker` This class is a special event handler which allows to discard any event (or a set of event types) directed to a specific window. :ref:`EventFilter` A global event filter for pre-processing all the events generated in the program. :ref:`EventLoopActivator` Makes an event loop temporarily active. :ref:`EventLoopBase` Base class for all event loop implementations. :ref:`EvtHandler` A class that can handle events from the windowing system. :ref:`FSFile` This class represents a single file opened by :ref:`FileSystem`. :ref:`FileConfig` :ref:`FileConfig` implements :ref:`ConfigBase` interface for storing and retrieving configuration information using plain text files. :ref:`FileCtrl` This control allows the user to select a file. :ref:`FileCtrlEvent` A file control event holds information about events associated with :ref:`FileCtrl` objects. :ref:`FileDataObject` :ref:`FileDataObject` is a specialization of :ref:`DataObject` for file names. :ref:`FileDialog` This class represents the file chooser dialog. :ref:`FileDirPickerEvent` This event class is used for the events generated by :ref:`FilePickerCtrl` and by :ref:`DirPickerCtrl`. :ref:`FileDropTarget` This is a drop target which accepts files (dragged from File Manager or Explorer). :ref:`FilePickerCtrl` This control allows the user to select a file. :ref:`FileSystem` This class provides an interface for opening files on different file systems. :ref:`FileSystemHandler` Classes derived from :ref:`FileSystemHandler` are used to access virtual file systems. :ref:`FileTranslationsLoader` Standard :ref:`TranslationsLoader` implementation. :ref:`FileType` This class holds information about a given `file` type. :ref:`FileTypeInfo` Container of information about :ref:`FileType`. :ref:`FilterFSHandler` Filter file system handler. :ref:`FindDialogEvent` :ref:`FindReplaceDialog` events. :ref:`FindReplaceData` :ref:`FindReplaceData` holds the data for :ref:`FindReplaceDialog`. :ref:`FindReplaceDialog` :ref:`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). :ref:`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 :ref:`GridSizer`. :ref:`FocusEvent` A focus event is sent when a window's focus changes. :ref:`Font` A font is an object which determines the appearance of text. :ref:`FontList` A font list is a list containing all fonts which have been created. :ref:`FontMetrics` Simple collection of various font metrics. :ref:`FontPickerCtrl` This control allows the user to select a font. :ref:`FontPickerEvent` This event class is used for the events generated by :ref:`FontPickerCtrl`. :ref:`Frame` A frame is a window whose size and position can (usually) be changed by the user. :ref:`GBPosition` This class represents the position of an item in a virtual grid of rows and columns managed by a :ref:`GridBagSizer`. :ref:`GBSizerItem` The :ref:`GBSizerItem` class is used by the :ref:`GridBagSizer` for tracking the items in the sizer. :ref:`GBSpan` This class is used to hold the row and column spanning attributes of items in a :ref:`GridBagSizer`. :ref:`GCDC` :ref:`GCDC` is a device context that draws on a :ref:`GraphicsContext`. :ref:`GDIObject` This class allows platforms to implement functionality to optimise GDI objects, such as :ref:`Pen`, :ref:`Brush` and :ref:`Font`. :ref:`Gauge` A gauge is a horizontal or vertical bar which shows a quantity (often time). :ref:`GenericDirCtrl` This control can be used to place a directory listing (with optional files) on an arbitrary window. :ref:`GenericDragImage` This class is used when you wish to drag an object on the screen, and a simple cursor is not enough. :ref:`GenericProgressDialog` This class represents a dialog that shows a short message and a progress bar. :ref:`GraphicsBitmap` Represents a bitmap. :ref:`GraphicsBrush` A :ref:`GraphicsBrush` is a native representation of a brush. :ref:`GraphicsContext` A :ref:`GraphicsContext` instance is the object that is drawn upon. :ref:`GraphicsFont` A :ref:`GraphicsFont` is a native representation of a font. :ref:`GraphicsGradientStop` Represents a single gradient stop in a collection of gradient stops as represented by :ref:`GraphicsGradientStops`. :ref:`GraphicsGradientStops` Represents a collection of GraphicGradientStop values for use with CreateLinearGradientBrush and CreateRadialGradientBrush. :ref:`GraphicsMatrix` A :ref:`GraphicsMatrix` is a native representation of an affine matrix. :ref:`GraphicsObject` This class is the superclass of native graphics objects like pens etc. :ref:`GraphicsPath` A :ref:`GraphicsPath` is a native representation of a geometric path. :ref:`GraphicsPen` A :ref:`GraphicsPen` is a native representation of a pen. :ref:`GraphicsRenderer` A :ref:`GraphicsRenderer` is the instance corresponding to the rendering engine used. :ref:`GridBagSizer` A :ref:`Sizer` that can lay out items in a virtual grid like a :ref:`FlexGridSizer` but in this case explicit positioning of the items is allowed using :ref:`GBPosition`, and items can optionally span more than one row and/or column using :ref:`GBSpan`. :ref:`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. :ref:`HSVValue` A simple class which stores hue, saturation and value as doubles in the range 0.0-1.0. :ref:`HScrolledWindow` In the name of this class, "H" stands for "horizontal" because it can be used for scrolling columns of variable widths. :ref:`HVScrolledWindow` This window inherits all functionality of both vertical and horizontal, variable scrolled windows. :ref:`HeaderColumn` Represents a column header in controls displaying tabular data such as :ref:`dataview.DataViewCtrl` or `Grid`. :ref:`HeaderColumnSimple` Simple container for the information about the column. :ref:`HelpControllerBase` This is the abstract base class a family of classes by which applications may invoke a help viewer to provide on-line help. :ref:`HelpControllerHelpProvider` :ref:`HelpControllerHelpProvider` is an implementation of :ref:`HelpProvider` which supports both context identifiers and plain text help strings. :ref:`HelpEvent` A help event is sent when the user has requested context-sensitive help. :ref:`HelpProvider` :ref:`HelpProvider` is an abstract class used by a program implementing context-sensitive help to show the help text for the given window. :ref:`Icon` An icon is a small rectangular bitmap usually used for denoting a minimized application. :ref:`IconBundle` This class contains multiple copies of an icon in different sizes. :ref:`IconLocation` :ref:`IconLocation` is a tiny class describing the location of an (external, i.e. :ref:`IconizeEvent` An event being sent when the frame is iconized (minimized) or restored. :ref:`IdManager` :ref:`IdManager` is responsible for allocating and releasing window IDs. :ref:`IdleEvent` This class is used for idle events, which are generated when the system becomes idle. :ref:`Image` This class encapsulates a platform-independent image. :ref:`ImageHandler` This is the base class for implementing image file loading/saving, and image creation from data. :ref:`ImageHistogram` :ref:`ImageList` A :ref:`ImageList` contains a list of images, which are stored in an unspecified form. :ref:`IndividualLayoutConstraint` :ref:`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. :ref:`InitDialogEvent` A :ref:`InitDialogEvent` is sent as a dialog or panel is being initialised. :ref:`InputStream` :ref:`InputStream` is an abstract base class which may not be used directly. :ref:`InternetFSHandler` A file system handler for accessing files from internet servers. :ref:`ItemContainer` This class is an abstract base class for some wxWidgets controls which contain several items such as :ref:`ListBox`, :ref:`CheckListBox`, :ref:`ComboBox` or :ref:`Choice`. :ref:`ItemContainerImmutable` :ref:`ItemContainer` defines an interface which is implemented by all controls which have string subitems each of which may be selected. :ref:`JoystickEvent` This event class contains information about joystick events, particularly events received by windows. :ref:`KeyEvent` This event class contains information about key press and release events. :ref:`KeyboardState` Provides methods for testing the state of the keyboard modifier keys. :ref:`LanguageInfo` Encapsulates a :meth:`~LanguageInfo.Language` identifier together with OS-specific information related to that language. :ref:`LayoutConstraints` :ref:`LinuxDistributionInfo` A structure containing informations about a Linux distribution as returned by the ``lsb_release`` utility. :ref:`ListBox` A listbox is used to select one or more of a list of strings. :ref:`ListCtrl` A list control presents lists in a number of formats: list view, report view, icon view and small icon view. :ref:`ListEvent` A list event holds information about events associated with :ref:`ListCtrl` objects. :ref:`ListItem` This class stores information about a :ref:`ListCtrl` item or column. :ref:`ListItemAttr` Represents the attributes (color, font, . :ref:`ListView` This class currently simply presents a simpler to use interface for the :ref:`ListCtrl` -- it can be thought of as a `façade` for that complicated class. :ref:`Locale` :ref:`Locale` class encapsulates all language-dependent settings and is a generalization of the C locale concept. :ref:`Log` :ref:`Log` class defines the interface for the `log targets` used by wxWidgets logging functions as explained in the :ref:`Log Classes Overview `. :ref:`LogBuffer` :ref:`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). :ref:`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 :meth:`Log.SetActiveTarget` does. :ref:`LogFormatter` :ref:`LogFormatter` class is used to format the log messages. :ref:`LogGui` This is the default log target for the GUI wxWidgets applications. :ref:`LogInterposer` A special version of :ref:`LogChain` which uses itself as the new log target. :ref:`LogInterposerTemp` A special version of :ref:`LogChain` which uses itself as the new log target. :ref:`LogNull` This class allows you to temporarily suspend logging. :ref:`LogRecordInfo` Information about a log record (unit of the log output). :ref:`LogStderr` This class can be used to redirect the log messages to a C file stream (not to be confused with ``C++`` streams). :ref:`LogTextCtrl` Using these target all the log messages can be redirected to a text control. :ref:`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. :ref:`MDIChildFrame` An MDI child frame is a frame that can only exist inside a :ref:`MDIClientWindow`, which is itself a child of :ref:`MDIParentFrame`. :ref:`MDIClientWindow` An MDI client window is a child of :ref:`MDIParentFrame`, and manages zero or more :ref:`MDIChildFrame` objects. :ref:`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. :ref:`Mask` This class encapsulates a monochrome mask bitmap, where the masked area is black and the unmasked area is white. :ref:`Matrix2D` A simple container for 2x2 matrix. :ref:`MaximizeEvent` An event being sent when a top level window is maximized. :ref:`MemoryDC` A memory device context provides a means to draw graphics onto a bitmap. :ref:`MemoryFSHandler` This :ref:`FileSystem` handler can store arbitrary data in memory stream and make them accessible via an ``URL``. :ref:`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). :ref:`MenuBar` A menu bar is a series of menus accessible from the top of a frame. :ref:`MenuEvent` This class is used for a variety of menu-related events. :ref:`MenuItem` A menu item represents an item in a menu. :ref:`MessageDialog` This class represents a dialog that shows a single or multi-line message, with a choice of ``OK``, Yes, No and Cancel buttons. :ref:`MessageParameters` Class representing message parameters. :ref:`MimeTypesManager` This class allows the application to retrieve informations about all known ``MIME`` types from a system-specific location and the filename extensions to the ``MIME`` types and vice versa. :ref:`MirrorDC` :ref:`MirrorDC` is a simple wrapper class which is always associated with a real :ref:`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. :ref:`MouseCaptureChangedEvent` An mouse capture changed event is sent to a window that loses its mouse capture. :ref:`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). :ref:`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. :ref:`MouseState` Represents the mouse state. :ref:`MoveEvent` A move event holds information about :ref:`TopLevelWindow` move change events. :ref:`MultiChoiceDialog` This class represents a dialog that shows a list of strings, and allows the user to select one or more. :ref:`NativeFontInfo` :ref:`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 :meth:`~NativeFontInfo.ToString` and restore them using :meth:`~NativeFontInfo.FromString`) :ref:`NavigationKeyEvent` This event class contains information about navigation events, generated by navigation keys such as tab and page down. :ref:`NonOwnedWindow` Common base class for all non-child windows. :ref:`Notebook` This class represents a notebook control, which manages multiple windows with associated tabs. :ref:`NotifyEvent` This class is not used by the event handlers by itself, but is a base class for other event classes (such as :ref:`BookCtrlEvent`). :ref:`Object` This is the root class of many of the wxWidgets classes. :ref:`OutputStream` :ref:`OutputStream` is an abstract base class which may not be used directly. :ref:`Overlay` Creates an overlay over an existing window, allowing for manipulations like rubberbanding, etc. :ref:`PageSetupDialog` This class represents the page setup common dialog. :ref:`PageSetupDialogData` This class holds a variety of information related to :ref:`PageSetupDialog`. :ref:`PaintDC` A :ref:`PaintDC` must be constructed if an application wishes to paint on the client area of a window from within an EVT_PAINT() event handler. :ref:`PaintEvent` A paint event is sent when a window's contents needs to be repainted. :ref:`PaletteChangedEvent` :ref:`Panel` A panel is a window on which controls are placed. :ref:`Pen` A pen is a drawing tool for drawing outlines. :ref:`PenList` There is only one instance of this class: ``ThePenList`` :ref:`PickerBase` Base abstract class for all pickers which support an auxiliary text control. :ref:`PlatformInfo` This class holds informations about the operating system, the toolkit and the basic architecture of the machine where the application is currently running. :ref:`Point` A :ref:`Point` is a useful data structure for graphics operations. :ref:`Point2DDouble` :ref:`PopupTransientWindow` A :ref:`PopupWindow` which disappears automatically when the user clicks mouse outside it or if it loses focus in any other way. :ref:`PopupWindow` A special kind of top level window used for popup menus, combobox popups and such. :ref:`Position` This class represents the position of an item in any kind of grid of rows and columns such as :ref:`GridBagSizer`, or :ref:`HVScrolledWindow`. :ref:`PostScriptDC` This defines the wxWidgets Encapsulated PostScript device context, which can write PostScript files on any platform. :ref:`PowerEvent` The power events are generated when the system power state changes, e.g. :ref:`PreviewCanvas` A preview canvas is the default canvas used by the print preview system to display the preview. :ref:`PreviewControlBar` This is the default implementation of the preview control bar, a panel with buttons and a zoom control. :ref:`PreviewFrame` This class provides the default method of managing the print preview interface. :ref:`PrintData` This class holds a variety of information related to printers and printer device contexts. :ref:`PrintDialog` This class represents the print and print setup common dialogs. :ref:`PrintDialogData` This class holds information related to the visual characteristics of :ref:`PrintDialog`. :ref:`PrintPreview` Objects of this class manage the print preview process. :ref:`Printer` This class represents the Windows or PostScript printer, and is the vehicle through which printing may be launched by an application. :ref:`PrinterDC` A printer device context is specific to MSW and Mac, and allows access to any printer with a Windows or Macintosh driver. :ref:`Printout` This class encapsulates the functionality of printing out an application document. :ref:`Process` The objects of this class are used in conjunction with the :func:`Execute` function. :ref:`ProcessEvent` A process event is sent to the :ref:`EvtHandler` specified to :ref:`Process` when a process is terminated. :ref:`ProgressDialog` If supported by the platform this class will provide the platform's native progress dialog, else it will simply be the `` :ref:`GenericProgressDialog` `` . :ref:`PropagateOnce` Helper class to temporarily lower propagation level. :ref:`PropagationDisabler` Helper class to temporarily change an event to not propagate. :ref:`PyApp` The :ref:`App` class represents the application itself when ``USE_GUI=1`` . :ref:`PyEventBinder` Instances of this class are used to bind specific events to event handlers. :ref:`PyOnDemandOutputWindow` A class that can be used for redirecting Python's stdout and :ref:`PySimpleApp` This class is deprecated. Please use wx.App instead. :ref:`PySingleChoiceDialog` This class represents a dialog that shows a list of strings, and allows the user to select one. :ref:`QueryNewPaletteEvent` :ref:`RGBValue` A simple class which stores red, green and blue values as 8 bit integers in the range of ``0-255``. :ref:`RadioBox` A radio box item is used to select one of number of mutually exclusive choices. :ref:`RadioButton` A radio button item is a button which usually denotes one of several mutually exclusive options. :ref:`RealPoint` A :ref:`RealPoint` is a useful data structure for graphics operations. :ref:`Rect` A class for manipulating rectangles. :ref:`Rect2DDouble` :ref:`RefCounter` This class is used to manage reference-counting providing a simple interface and a counter. :ref:`Region` A :ref:`Region` represents a simple or complex region on a device context or window. :ref:`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. :ref:`SVGFileDC` A :ref:`SVGFileDC` is a device context onto which graphics and text can be drawn, and the output produced as a vector file, in ``SVG`` format (see the ``W3C`` ``SVG`` Specifications <`http://www.w3.org/TR/2001/REC-SVG-20010904/ `_>). :ref:`ScreenDC` A :ref:`ScreenDC` can be used to paint on the screen. :ref:`ScrollBar` A :ref:`ScrollBar` is a control that represents a horizontal or vertical scrollbar. :ref:`ScrollEvent` A scroll event holds information about events sent from stand-alone scrollbars (see :ref:`ScrollBar`) and sliders (see :ref:`Slider`). :ref:`ScrollWinEvent` A scroll event holds information about events sent from scrolling windows. :ref:`Scrolled` The :ref:`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. :ref:`SearchCtrl` A search control is a composite control with a search button, a text control, and a cancel button. :ref:`SetCursorEvent` A :ref:`SetCursorEvent` is generated from :ref:`Window` when the mouse cursor is about to be set as a result of mouse motion. :ref:`SettableHeaderColumn` Adds methods to set the column attributes to :ref:`HeaderColumn`. :ref:`ShowEvent` An event being sent when the window is shown or hidden. :ref:`SimpleHelpProvider` :ref:`SimpleHelpProvider` is an implementation of :ref:`HelpProvider` which supports only plain text help strings, and shows the string associated with the control (if any) in a tooltip. :ref:`SingleInstanceChecker` :ref:`SingleInstanceChecker` class allows to check that only a single instance of a program is running. :ref:`Size` A :ref:`Size` is a useful data structure for graphics operations. :ref:`SizeEvent` A size event holds information about size change events of :ref:`Window`. :ref:`Sizer` :ref:`Sizer` is the abstract base class used for laying out subwindows in a window. :ref:`SizerFlags` Container for sizer items flags providing readable names for them. :ref:`SizerItem` The :ref:`SizerItem` class is used to track the position, size and other attributes of each item managed by a :ref:`Sizer`. :ref:`Slider` A slider is a control with a handle which can be pulled back and forth to change the value. :ref:`SpinButton` A :ref:`SpinButton` has two small up and down (or left and right) arrow buttons. :ref:`SpinCtrl` :ref:`SpinCtrl` combines :ref:`TextCtrl` and :ref:`SpinButton` in one control. :ref:`SpinCtrlDouble` :ref:`SpinCtrlDouble` combines :ref:`TextCtrl` and :ref:`SpinButton` in one control and displays a real number. :ref:`SpinDoubleEvent` This event class is used for the events generated by :ref:`SpinCtrlDouble`. :ref:`SpinEvent` This event class is used for the events generated by :ref:`SpinButton` and :ref:`SpinCtrl`. :ref:`SplitterEvent` This class represents the events generated by a splitter control. :ref:`SplitterWindow` This class manages up to two subwindows. :ref:`StandardPaths` :ref:`StandardPaths` returns the standard locations in the file system and should be used by applications to find their data files in a portable way. :ref:`StaticBitmap` A static bitmap control displays a bitmap. :ref:`StaticBox` A static box is a rectangle drawn around other windows to denote a logical grouping of items. :ref:`StaticBoxSizer` :ref:`StaticBoxSizer` is a sizer derived from :ref:`BoxSizer` but adds a static box around the sizer. :ref:`StaticLine` A static line is just a line which may be used in a dialog to separate the groups of controls. :ref:`StaticText` A static text control displays one or more lines of read-only text. :ref:`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. :ref:`StatusBarPane` A status bar pane data container used by :ref:`StatusBar`. :ref:`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). :ref:`StreamBase` This class is the base class of most stream related classes in wxWidgets. :ref:`SysColourChangedEvent` This class is used for system colour change events, which are generated when the user changes the colour settings using the control panel. :ref:`SystemOptions` :ref:`SystemOptions` stores option/value pairs that wxWidgets itself or applications can use to alter behaviour at run-time. :ref:`SystemSettings` :ref:`SystemSettings` allows the application to ask for details about the system. :ref:`TextAttr` :ref:`TextAttr` represents the character and paragraph attributes, or style, for a range of text in a :ref:`TextCtrl` or `RichTextCtrl`. :ref:`TextCompleter` Base class for custom text completer objects. :ref:`TextCompleterSimple` A simpler base class for custom completer objects. :ref:`TextCtrl` A text control allows text to be displayed and edited. :ref:`TextDataObject` :ref:`TextDataObject` is a specialization of :ref:`DataObjectSimple` for text data. :ref:`TextDropTarget` A predefined drop target for dealing with text data. :ref:`TextEntry` Common base class for single line text entry fields. :ref:`TimeSpan` :ref:`TimeSpan` class represents a time interval. :ref:`TimeZone` Class representing a time zone. :ref:`Timer` The :ref:`Timer` class allows you to execute code at specified intervals. :ref:`TimerEvent` :ref:`TimerEvent` object is passed to the event handler of timer events (see :meth:`Timer.SetOwner` ). :ref:`TimerRunner` Starts the timer in its constructor, stops in the dtor. :ref:`TipWindow` Shows simple text in a popup tip window on creation. :ref:`Tm` Contains broken down date-time representation. :ref:`ToggleButton` :ref:`ToggleButton` is a button that stays pressed when clicked by the user. :ref:`ToolBar` A toolbar is a bar of buttons and/or other controls usually placed below the menu bar in a :ref:`Frame`. :ref:`ToolBarToolBase` A toolbar tool represents one item on the toolbar. :ref:`ToolTip` This class holds information about a tooltip associated with a window (see :meth:`Window.SetToolTip` ). :ref:`TopLevelWindow` :ref:`TopLevelWindow` is a common base class for :ref:`Dialog` and :ref:`Frame`. :ref:`Trackable` Add-on base class for a trackable object. :ref:`Translations` This class allows to get translations for strings. :ref:`TranslationsLoader` Abstraction of translations discovery and loading. :ref:`TreeCtrl` A tree control presents information as a hierarchy, with items that may be expanded to show further items. :ref:`TreeEvent` A tree event holds information about events associated with :ref:`TreeCtrl` objects. :ref:`TreeItemId` An opaque reference to a tree item. :ref:`UIActionSimulator` :ref:`UIActionSimulator` is a class used to simulate user interface actions such as a mouse click or a key press. :ref:`URLDataObject` :ref:`URLDataObject` is a :ref:`DataObject` containing an ``URL`` and can be used e.g. :ref:`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. :ref:`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 -- only those which are shown on the screen need to be measured; or even "vertical", because this class only supports scrolling vertically. :ref:`Validator` :ref:`Validator` is the base class for a family of validator classes that mediate between a class of control, and application data. :ref:`VarHScrollHelper` This class provides functions wrapping the :ref:`VarScrollHelperBase` class, targeted for horizontal-specific scrolling. :ref:`VarHVScrollHelper` This class provides functions wrapping the :ref:`VarHScrollHelper` and :ref:`VarVScrollHelper` classes, targeted for scrolling a window in both axis. :ref:`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. :ref:`VarVScrollHelper` This class provides functions wrapping the :ref:`VarScrollHelperBase` class, targeted for vertical-specific scrolling. :ref:`VersionInfo` :ref:`VersionInfo` contains version information. :ref:`VideoMode` Determines the sizes and locations of displays connected to the system. :ref:`VisualAttributes` Struct containing all the visual attributes of a control. :ref:`Window` :ref:`Window` is the base class for all windows and represents any visible object on screen. :ref:`WindowBase` :ref:`WindowCreateEvent` This event is sent just after the actual window associated with a :ref:`Window` object has been created. :ref:`WindowDC` A :ref:`WindowDC` must be constructed if an application wishes to paint on the whole area of a window (client and decorations). :ref:`WindowDestroyEvent` This event is sent as early as possible during the window destruction process. :ref:`WindowDisabler` This class disables all windows of the application (may be with the exception of one of them) in its constructor and enables them back in its destructor. :ref:`WindowModalDialogEvent` :ref:`WithImages` A mixin class to be used with other classes that use a :ref:`ImageList`. :ref:`WrapSizer` A wrap sizer lays out its items in a single line, like a box sizer -- as long as there is space available in that direction. ================================================================================ ================================================================================ .. toctree:: :maxdepth: 1 :hidden: AcceleratorEntry AcceleratorEntryFlags.enumeration AcceleratorTable ActivateEvent AffineMatrix2D AffineMatrix2DBase Alignment.enumeration AntialiasMode.enumeration AnyButton App AppAssertMode.enumeration AppConsole AppTraits Architecture.enumeration ArchiveFSHandler ArtProvider AutoBufferedPaintDC BackgroundStyle.enumeration BatteryState.enumeration Bitmap BitmapBufferFormat.enumeration BitmapButton BitmapDataObject BitmapToggleButton BitmapType.enumeration BookCtrlBase BookCtrlEvent Border.enumeration BoxSizer Brush BrushList BrushStyle.enumeration BufferedDC BufferedPaintDC BusyCursor Button ButtonLabel Calendar.enumeration CallLater CheckBox CheckBoxState.enumeration CheckListBox ChildFocusEvent Choice ClientDC Clipboard ClipboardTextEvent CloseEvent CollapsiblePane CollapsiblePaneEvent Colour ColourData ColourDatabase ColourDialog ColourPickerCtrl ColourPickerEvent ComboBox CommandEvent CompositionMode.enumeration ConfigBase ConfigPathChanger ContextHelp ContextHelpButton ContextMenuEvent Control ControlWithItems Country.enumeration Cursor CustomDataObject DC DCBrushChanger DCClipper DCFontChanger DCOverlay DCPenChanger DCTextColourChanger DataFormat DataFormatId.enumeration DataObject DataObjectComposite DataObjectSimple DateSpan DateTime Dialog DialogLayoutAdaptationMode.enumeration DialogLayoutAdapter DirDialog DirFilterListCtrl DirPickerCtrl Direction.enumeration Display DisplayChangedEvent DragImage DragResult.enumeration DropFilesEvent DropSource DropTarget DuplexMode.enumeration Edge.enumeration EllipsizeFlags.enumeration EllipsizeMode.enumeration Endianness.enumeration EntryType.enumeration EraseEvent Event EventBlocker EventCategory.enumeration EventFilter EventLoopActivator EventLoopBase EventPropagation.enumeration EvtHandler FSFile FileConfig FileCtrl FileCtrlEvent FileDataObject FileDialog FileDirPickerEvent FileDropTarget FilePickerCtrl FileSystem FileSystemHandler FileSystemOpenFlags.enumeration FileTranslationsLoader FileType FileTypeInfo FilterFSHandler FindDialogEvent FindReplaceData FindReplaceDialog FindReplaceDialogStyles.enumeration FindReplaceFlags.enumeration FlexGridSizer FlexSizerGrowMode.enumeration FloodFillStyle.enumeration FocusEvent Font FontEncoding.enumeration FontFamily.enumeration FontFlag.enumeration FontList FontMetrics FontPickerCtrl FontPickerEvent FontStyle.enumeration FontSymbolicSize.enumeration FontWeight.enumeration Frame GBPosition GBSizerItem GBSpan GCDC GDIObject Gauge GenericDirCtrl GenericDragImage GenericProgressDialog GeometryCentre.enumeration GraphicsBitmap GraphicsBrush GraphicsContext GraphicsFont GraphicsGradientStop GraphicsGradientStops GraphicsMatrix GraphicsObject GraphicsPath GraphicsPen GraphicsRenderer GregorianAdoption.enumeration GridBagSizer GridSizer HSVValue HScrolledWindow HVScrolledWindow HeaderColumn HeaderColumnSimple HelpControllerBase HelpControllerHelpProvider HelpEvent HelpProvider HelpSearchMode.enumeration HitTest.enumeration Icon IconBundle IconLocation IconizeEvent IdManager IdleEvent IdleMode.enumeration Image ImageHandler ImageHistogram ImageList ImagePNGType.enumeration ImageResizeQuality.enumeration ImageResolution.enumeration IndividualLayoutConstraint InfoBar InitDialogEvent InputStream InternetFSHandler InterpolationQuality.enumeration ItemContainer ItemContainerImmutable ItemKind.enumeration JoystickEvent KeyCategoryFlags.enumeration KeyCode.enumeration KeyEvent KeyModifier.enumeration KeyboardState KillError.enumeration KillFlags.enumeration Language.enumeration LanguageInfo LayoutConstraints LayoutDirection.enumeration LinuxDistributionInfo ListBox ListColumnFormat.enumeration ListCtrl ListEvent ListItem ListItemAttr ListView Locale LocaleCategory.enumeration LocaleInfo.enumeration Log LogBuffer LogChain LogFormatter LogGui LogInterposer LogInterposerTemp LogLevelValues.enumeration LogNull LogRecordInfo LogStderr LogTextCtrl LogWindow MDIChildFrame MDIClientWindow MDIParentFrame MappingMode.enumeration Mask Matrix2D MaximizeEvent MemoryDC MemoryFSHandler Menu MenuBar MenuEvent MenuItem MessageDialog MessageParameters MimeTypesManager MirrorDC Month.enumeration MouseButton.enumeration MouseCaptureChangedEvent MouseCaptureLostEvent MouseEvent MouseState MouseWheelAxis.enumeration MoveEvent MultiChoiceDialog NameFlags.enumeration NativeFontInfo NavigationKeyEvent NavigationKeyEventFlags.enumeration NonOwnedWindow Notebook NotifyEvent Object OperatingSystemId.enumeration Orientation.enumeration Origin.enumeration OutCode.enumeration OutputStream Overlay PageSetupDialog PageSetupDialogData PaintDC PaintEvent PaletteChangedEvent Panel PaperSize.enumeration Pen PenCap.enumeration PenJoin.enumeration PenList PenStyle.enumeration PickerBase PlatformInfo Point Point2DDouble PolygonFillMode.enumeration PopupTransientWindow PopupWindow PortId.enumeration Position PostScriptDC PowerEvent PowerType.enumeration PreviewCanvas PreviewControlBar PreviewFrame PreviewFrameModalityKind.enumeration PrintBin.enumeration PrintData PrintDialog PrintDialogData PrintMode.enumeration PrintOrientation.enumeration PrintPreview Printer PrinterDC PrinterError.enumeration Printout Process ProcessEvent ProgressDialog PropagateOnce PropagationDisabler PyApp PyEventBinder PyOnDemandOutputWindow PySimpleApp PySingleChoiceDialog QueryNewPaletteEvent RGBValue RadioBox RadioButton RasterOperationMode.enumeration RealPoint Rect Rect2DDouble RefCounter Region RegionContain.enumeration RegionIterator Relationship.enumeration ResourceCat.enumeration SVGFileDC ScreenDC ScrollBar ScrollEvent ScrollWinEvent ScrollbarVisibility.enumeration Scrolled SearchCtrl SeekMode.enumeration SetCursorEvent SettableHeaderColumn ShowEffect.enumeration ShowEvent ShutdownFlags.enumeration Signal.enumeration SimpleHelpProvider SingleInstanceChecker Size SizeEvent Sizer SizerFlagBits.enumeration SizerFlags SizerItem Slider SpinButton SpinCtrl SpinCtrlDouble SpinDoubleEvent SpinEvent SplitMode.enumeration SplitterEvent SplitterWindow StandardID.enumeration StandardPaths StaticBitmap StaticBox StaticBoxSizer StaticLine StaticText StatusBar StatusBarPane StdDialogButtonSizer StockCursor.enumeration StreamBase StreamError.enumeration Stretch.enumeration SysColourChangedEvent SystemColour.enumeration SystemFeature.enumeration SystemFont.enumeration SystemMetric.enumeration SystemOptions SystemScreenType.enumeration SystemSettings TZ.enumeration TextAttr TextAttrAlignment.enumeration TextAttrBulletStyle.enumeration TextAttrEffects.enumeration TextAttrFlags.enumeration TextAttrLineSpacing.enumeration TextCompleter TextCompleterSimple TextCtrl TextCtrlHitTestResult.enumeration TextDataObject TextDropTarget TextEntry TimeSpan TimeZone Timer TimerEvent TimerRunner TipWindow Tm ToggleButton ToolBar ToolBarToolBase ToolBarToolStyle.enumeration ToolTip TopLevelWindow Trackable Translations TranslationsLoader TreeCtrl TreeEvent TreeItemIcon.enumeration TreeItemId UIActionSimulator URLDataObject UpdateUI.enumeration UpdateUIEvent UpdateUIMode.enumeration VScrolledWindow Validator VarHScrollHelper VarHVScrollHelper VarScrollHelperBase VarVScrollHelper VersionInfo VideoMode VisualAttributes WeekDay.enumeration WeekFlags.enumeration Window WindowBase WindowCreateEvent WindowDC WindowDestroyEvent WindowDisabler WindowModalDialogEvent WindowVariant.enumeration WithImages WrapSizer Year.enumeration