// Name: cat_classes.h
// Purpose: Classes-by-category page of the Doxygen manual
// Author: wxWidgets team
-// RCS-ID: $Id: cat_classes.h 52468 2008-03-13 16:30:38Z FM $
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@page page_class_cat Summarized Class List by Category
+@tableofcontents
+
This page contains a summarized listing of classes, please see the
@ref group_class page for a full listing.
-@beginInvisibleTable
-<tr><td>
-@li @ref page_class_cat_basicwnd
-@li @ref page_class_cat_winlayout
-@li @ref page_class_cat_managedwnd
-@li @ref page_class_cat_menus
-@li @ref page_class_cat_ctrl
-@li @ref page_class_cat_pickers
-@li @ref page_class_cat_miscwnd
-@li @ref page_class_cat_aui
-@li @ref page_class_cat_cmndlg
-@li @ref page_class_cat_html
-@li @ref page_class_cat_richtext
-@li @ref page_class_cat_stc
-</td><td>
-@li @ref page_class_cat_dc
-@li @ref page_class_cat_gdi
-@li @ref page_class_cat_events
-@li @ref page_class_cat_validator
-@li @ref page_class_cat_appmanagement
-@li @ref page_class_cat_printing
-@li @ref page_class_cat_dvf
-@li @ref page_class_cat_dnd
-@li @ref page_class_cat_vfs
-</td><td>
-@li @ref page_class_cat_rtti
-@li @ref page_class_cat_debugging
-@li @ref page_class_cat_logging
-@li @ref page_class_cat_threading
-@li @ref page_class_cat_data
-@li @ref page_class_cat_containers
-@li @ref page_class_cat_smartpointers
-@li @ref page_class_cat_file
-@li @ref page_class_cat_streams
-@li @ref page_class_cat_xml
-@li @ref page_class_cat_archive
-</td><td>
-@li @ref page_class_cat_xrc
-@li @ref page_class_cat_net
-@li @ref page_class_cat_ipc
-@li @ref page_class_cat_help
-@li @ref page_class_cat_media
-@li @ref page_class_cat_gl
-@li @ref page_class_cat_misc
-</td></tr>
-@endTable
-
-
-<hr>
@section page_class_cat_basicwnd Basic Windows
equally well on all platforms, the other is based on so-called constraints and
is deprecated, though still available.
-Related Overviews: @ref overview_sizer, @ref overview_constraints
+Related Overviews: @ref overview_sizer
These are the classes relevant to sizer-based layout:
@li wxSizer: Abstract base class
+@li wxBoxSizer: A sizer for laying out windows in a row or column
@li wxGridSizer: A sizer for laying out windows in a grid with all fields
having the same size
@li wxFlexGridSizer: A sizer for laying out windows in a flexible grid
@li wxGridBagSizer: Another grid sizer that lets you specify the cell an item
is in, and items can span rows and/or columns.
-@li wxBoxSizer: A sizer for laying out windows in a row or column
@li wxStaticBoxSizer: Same as wxBoxSizer, but with a surrounding static box
@li wxWrapSizer: A sizer which wraps its child controls as size permits
-These are the classes relevant to constraints-based window layout:
-
-@li wxIndividualLayoutConstraint: Represents a single constraint dimension
-@li wxLayoutConstraints: Represents the constraints for a window class
-
Other layout classes:
@li wxLayoutAlgorithm: An alternative window layout facility
@li wxAnimationCtrl: A control to display an animation
@li wxControl: The base class for controls
-@li wxButton: Push button control, displaying text
@li wxBitmapButton: Push button control, displaying a bitmap
@li wxBitmapComboBox: A combobox with bitmaps next to text items
-@li wxToggleButton: A button which stays pressed when clicked by user.
@li wxBitmapToggleButton: A toggle button with bitmaps.
+@li wxButton: Push button control, displaying text
@li wxCalendarCtrl: Control showing an entire calendar month
@li wxCheckBox: Checkbox control
@li wxCheckListBox: A listbox with a checkbox to the left of each item
@li wxCollapsiblePane: A panel which can be shown/hidden by the user
@li wxComboBox: A choice with an editable area
@li wxComboCtrl: A combobox with application defined popup
-@li wxDataViewCtrl: A control to tabular or tree like data
-@li wxDataViewTreeCtrl: A specialized wxDataViewCtrl with wxTreeCtrl-like API
+@li wxDataViewCtrl: A control to display tabular or tree like data
+@li wxDataViewTreeCtrl: A specialized wxDataViewCtrl with a wxTreeCtrl-like API
+@li wxDataViewListCtrl: A specialized wxDataViewCtrl for displaying and editing simple tables.
+@li wxEditableListBox: A listbox with editable items.
+@li wxFileCtrl: A control for selecting a file. Useful for custom file dialogs.
@li wxGauge: A control to represent a varying quantity, such as time remaining
@li wxGenericDirCtrl: A control for displaying a directory tree
+@li wxGrid: A control to display spread-sheet like data in tabular form
+@li wxHeaderCtrl: a small control to display the top header of tabular data
@li wxHtmlListBox: An abstract class for creating listboxes showing HTML
content
-@li wxSimpleHtmlListBox: A listbox showing HTML content
-@li wxStaticBox: A static, or group box for visually grouping related controls
+@li wxHyperlinkCtrl: A static text which opens an URL when clicked
@li wxListBox: A list of strings for single or multiple selection
@li wxListCtrl: A control for displaying lists of strings and/or icons, plus a
multicolumn report view
@li wxListView: A simpler interface (façade) for wxListCtrl in report
mode
+@li wxNotebook: A notebook class
@li wxOwnerDrawnComboBox: A combobox with owner-drawn list items
+@li wxPropertyGrid: A complex control to display hierachical, editable information
+@li wxRadioBox: A group of radio buttons
+@li wxRadioButton: A round button to be used with others in a mutually
+ exclusive way
+@li wxRearrangeCtrl: A control allowing the user to rearrange a list of items.
@li wxRichTextCtrl: Generic rich text editing control
-@li wxTextCtrl: Single or multiline text editing control
-@li wxTreeCtrl: Tree (hierarchy) control
+@li wxSimpleHtmlListBox: A listbox showing HTML content
+@li wxStaticBox: A static, or group box for visually grouping related controls
@li wxScrollBar: Scrollbar control
+@li wxSearchCtrl: A text input control used to initiate a search
@li wxSpinButton: A spin or `up-down' control
-@li wxSpinCtrl: A spin control - i.e. spin button and text control
+@li wxSpinCtrl: A spin control - i.e. spin button and text control displaying
+ an integer
+@li wxSpinCtrlDouble: A spin control - i.e. spin button and text control displaying
+ a real number
@li wxStaticText: One or more lines of non-editable text
-@li wxHyperlinkCtrl: A static text which opens an URL when clicked
+@li wxTextCtrl: Single or multiline text editing control
+@li wxToggleButton: A button which stays pressed when clicked by user.
+@li wxTreeCtrl: Tree (hierarchy) control
+@li wxTreeListCtrl: Multi-column tree control with simple interface
@li wxStaticBitmap: A control to display a bitmap
-@li wxRadioBox: A group of radio buttons
-@li wxRadioButton: A round button to be used with others in a mutually
- exclusive way
+@li wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code
+ editing component for plain text editing.
@li wxSlider: A slider that can be dragged by the user
@li wxVListBox: A listbox supporting variable height rows
+@section page_class_cat_validator Validators
+
+These are the window validators, used for filtering and validating user input.
+
+Related Overviews: @ref overview_validator
+
+@li wxValidator: Base validator class
+@li wxTextValidator: Text control validator class
+@li wxGenericValidator: Generic control validator class
+@li wxIntegerValidator: Text control validator class for integer numbers
+@li wxFloatingPointValidator: Text control validator class for floating point numbers
+
+
+
@section page_class_cat_pickers Picker Controls
A picker control is a control whose appearance and behaviour is highly
The following are a variety of classes that are derived from wxWindow.
+@li wxCollapsiblePane: A panel which can be shown/hidden by the user
@li wxPanel: A window whose colour changes according to current user settings
@li ::wxScrolledWindow: Window with automatically managed scrollbars (see
wxScrolled)
@li wxHVScrolledWindow: As ::wxScrolledWindow but supports scroll units of
variable sizes.
@li wxGrid: A grid (table) window
+@li wxInfoBar: An information bar usually shown on top of the main window.
+@li wxRichToolTip: A customizable tooltip.
@li wxSplitterWindow: Window which can be split vertically or horizontally
@li wxStatusBar: Implements the status bar on a frame
@li wxToolBar: Toolbar class
@li wxSashWindow: Window with four optional sashes that can be dragged
@li wxSashLayoutWindow: Window that can be involved in an IDE-like layout
arrangement
+@li wxSimplebook: Another book control but one allowing only the program, not
+ the user, to change its current page.
@li wxWizardPage: A base class for the page in wizard dialog.
@li wxWizardPageSimple: A page in wizard dialog.
-
+@li wxCustomBackgroundWindow: A window allowing to set a custom bitmap.
@section page_class_cat_aui Window Docking (wxAUI)
@li wxDirDialog: Directory selector dialog
@li wxFileDialog: File selector dialog
@li wxFindReplaceDialog: Text search/replace dialog
-@li wxMultiChoiceDialog: Dialog to get one or more selections from a list
-@li wxSingleChoiceDialog: Dialog to get a single selection from a list and
- return the string
-@li wxTextEntryDialog: Dialog to get a single line of text from the user
-@li wxPasswordEntryDialog: Dialog to get a password from the user
@li wxFontDialog: Font chooser dialog
+@li wxMessageDialog: Simple message box dialog
+@li wxMultiChoiceDialog: Dialog to get one or more selections from a list
@li wxPageSetupDialog: Standard page setup dialog
+@li wxPasswordEntryDialog: Dialog to get a password from the user
@li wxPrintDialog: Standard print dialog
@li wxProgressDialog: Progress indication dialog
-@li wxMessageDialog: Simple message box dialog
-@li wxSymbolPickerDialog: Symbol selector dialog
+@li wxRearrangeDialog: Dialog allowing the user to rearrange a list of items.
@li wxRichTextFormattingDialog: A dialog for formatting the content of a
wxRichTextCtrl
+@li wxRichMessageDialog: Nicer message box dialog
+@li wxSingleChoiceDialog: Dialog to get a single selection from a list and
+ return the string
+@li wxSymbolPickerDialog: Symbol selector dialog
+@li wxTextEntryDialog: Dialog to get a single line of text from the user
@li wxWizard: A wizard dialog.
@li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser
-
-@section page_class_cat_richtext Rich Text
-
-wxWidgets provides a set of generic classes to edit and print simple rich text
-with character and paragraph formatting.
-
-@li wxTextAttr: Attributes specifying text styling.
-@li wxRichTextCtrl: A rich text control.
-@li wxRichTextBuffer: The content of a rich text control.
-@li wxRichTextCharacterStyleDefinition: Definition of character styling.
-@li wxRichTextParagraphStyleDefinition: Definition of paragraph styling.
-@li wxRichTextListStyleDefinition: Definition of list styling.
-@li wxRichTextStyleSheet: A set of style definitions.
-@li wxRichTextStyleComboCtrl: A drop-down control for applying styles.
-@li wxRichTextStyleListBox: A listbox for applying styles.
-@li wxRichTextStyleOrganiserDialog: A dialog that can be used for managing or
- browsing styles.
-@li wxRichTextEvent: A rich text event.
-@li wxRichTextRange: Specification for ranges in a rich text control or buffer.
-@li wxRichTextFileHandler: File handler base class.
-@li wxRichTextHTMLHandler: A handler for converting rich text to HTML.
-@li wxRichTextXMLHandler: A handler for loading and saving rich text XML.
-@li wxRichTextFormattingDialog: A dialog for rich text formatting.
-@li wxRichTextPrinting: A class for easy printing of rich text buffers.
-@li wxRichTextPrintout: A class used by wxRichTextPrinting.
-@li wxRichTextHeaderFooterData: Header and footer data specification.
-
-
-
-@section page_class_cat_stc Scintilla Text Editor
-
-wxWidgets also provides a wrapper around the Scintilla text editor control,
-which is a control for plain-text editing with support for highlighting, smart
-indentation, etc.
-
-@li wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code
- editing component.
-
-
-
@section page_class_cat_dc Device Contexts
Device contexts are surfaces that may be drawn on, and provide an abstraction
+@section page_class_cat_gc Graphics Context classes
+
+These classes are related to drawing using a new vector based drawing API and
+are based on the modern drawing backend GDI+, CoreGraphics and Cairo.
+
+@li wxGraphicsRenderer: Represents a drawing engine.
+@li wxGraphicsContext: Represents a graphics context currently being drawn on.
+@li wxGraphicsBrush: Brush for drawing into a wxGraphicsContext
+@li wxGraphicsPen: Pen for drawing into a wxGraphicsContext
+@li wxGraphicsFont: Font for drawing text on a wxGraphicsContext
+@li wxGraphicsMatrix: Represents an affine matrix for drawing transformation
+@li wxGraphicsPath: Represents a path for drawing
+
+
+
@section page_class_cat_gdi Graphics Device Interface
These classes are related to drawing on device contexts and windows.
-Related Overviews: @ref overview_bitmap
-
@li wxColour: Represents the red, blue and green elements of a colour
@li wxDCClipper: Wraps the operations of setting and destroying the clipping
region
-@li wxBitmap: Represents a bitmap
@li wxBrush: Used for filling areas on a device context
@li wxBrushList: The list of previously-created brushes
-@li wxCursor: A small, transparent bitmap representing the cursor
@li wxFont: Represents fonts
@li wxFontList: The list of previously-created fonts
-@li wxIcon: A small, transparent bitmap for assigning to frames and drawing on
- device contexts
-@li wxImage: A platform-independent image class
-@li wxImageList: A list of images, used with some controls
-@li wxMask: Represents a mask to be used with a bitmap for transparent drawing
@li wxPen: Used for drawing lines on a device context
@li wxPenList: The list of previously-created pens
@li wxPalette: Represents a table of indices into RGB values
@li wxRegion: Represents a simple or complex region on a window or device
context
-@li wxAnimation: Represents an animation
@li wxRendererNative: Abstracts high-level drawing primitives
+@section page_class_cat_image Image and bitmap classes
+
+These classes represent images and bitmap in various formats and ways
+to access and create them.
+
+Related Overviews: @ref overview_bitmap
+
+@li wxAnimation: Represents an animation
+@li wxBitmap: Represents a platform dependent bitmap
+@li wxBitmapHandler: Class for loading a saving a wxBitmap in a specific format
+@li wxCursor: A small, transparent bitmap representing the cursor
+@li wxIcon: A small, transparent bitmap for assigning to frames and drawing on
+ device contexts
+@li wxImage: A platform-independent image class
+@li wxImageHandler: Class for loading a saving a wxImage in a specific format
+@li wxImageList: A list of images, used with some controls
+@li wxMask: Represents a mask to be used with a bitmap for transparent drawing
+@li wxMemoryDC: A device context for drawing into bitmaps
+@li wxPixelData: Class template for direct access to wxBitmap's and wxImage's internal data
+
+
+
@section page_class_cat_events Events
An event object contains information about a specific event. Event handlers
(usually member functions) have a single, event argument.
-Related Overviews: @ref overview_eventhandling
+Related Overviews: @ref overview_events
@li wxActivateEvent: A window or application activation event
@li wxCalendarEvent: Used with wxCalendarCtrl
@li wxIdleEvent: An idle event
@li wxInitDialogEvent: A dialog initialisation event
@li wxJoystickEvent: A joystick event
+@li wxKeyboardState: State of the keyboard modifiers.
@li wxListEvent: A list control event
@li wxMaximizeEvent: A maximize event
@li wxMenuEvent: A menu event
@li wxMouseCaptureChangedEvent: A mouse capture changed event
@li wxMouseCaptureLostEvent: A mouse capture lost event
@li wxMouseEvent: A mouse event
+@li wxMouseState: State of the mouse
@li wxMoveEvent: A move event
@li wxNavigationKeyEvent: An event set by navigation keys such as tab
@li wxNotebookEvent: A notebook control event
-@section page_class_cat_validator Validators
-
-These are the window validators, used for filtering and validating user input.
-
-Related Overviews: @ref overview_validator
-
-@li wxValidator: Base validator class
-@li wxTextValidator: Text control validator class
-@li wxGenericValidator: Generic control validator class
-
-
-
@section page_class_cat_appmanagement Application and Process Management
@li wxApp: Application class
@li wxCmdLineParser: Command line parser class
-@li wxDllLoader: Class to work with shared libraries.
+@li wxDynamicLibrary: Class to work with shared libraries.
@li wxProcess: Process class
+@section page_class_cat_threading Threading
+
+wxWidgets provides a set of classes to make use of the native thread
+capabilities of the various platforms.
+
+Related Overviews: @ref overview_thread
+
+@li wxThread: Thread class
+@li wxThreadHelper: Manages background threads easily
+@li wxMutex: Mutex class
+@li wxMutexLocker: Mutex locker utility class
+@li wxCriticalSection: Critical section class
+@li wxCriticalSectionLocker: Critical section locker utility class
+@li wxCondition: Condition class
+@li wxSemaphore: Semaphore class
+
+
+
@section page_class_cat_rtti Runtime Type Information (RTTI)
wxWidgets supports runtime manipulation of class information, and dynamic
wxWidgets provides several classes and functions for message logging.
-Related Overviews: @ref overview_log
+Related overview: @ref overview_log
@see @ref group_funcmacro_log "Logging Functions and Macros"
-@section page_class_cat_threading Threading
-
-wxWidgets provides a set of classes to make use of the native thread
-capabilities of the various platforms.
-
-Related Overviews: @ref overview_thread
-
-@li wxThread: Thread class
-@li wxThreadHelper: Manages background threads easily
-@li wxMutex: Mutex class
-@li wxMutexLocker: Mutex locker utility class
-@li wxCriticalSection: Critical section class
-@li wxCriticalSectionLocker: Critical section locker utility class
-@li wxCondition: Condition class
-@li wxSemaphore: Semaphore class
-
-
-
@section page_class_cat_data Data Structures
These are the data structure classes supported by wxWidgets.
+@li wxAny: A class for storing arbitrary types that may change at run-time
@li wxCmdLineParser: Command line parser class
@li wxDateSpan: A logical time interval.
@li wxDateTime: A class for date/time manipulations
+@section page_class_cat_conv Text Conversion
+
+These classes define objects for performing conversions between different
+multibyte and Unicode encodings and wide character strings.
+
+@li wxMBConv: Base class for all converters, defines the API implemented by all
+ the other converter classes.
+@li wxMBConvUTF7: Converter for UTF-7
+@li wxMBConvUTF8: Converter for UTF-8
+@li wxMBConvUTF16: Converter for UTF-16
+@li wxMBConvUTF32: Converter for UTF-32
+@li wxCSConv: Converter for any system-supported encoding which can be
+ specified by name.
+
+Related Overviews: @ref overview_mbconv
+
+
@section page_class_cat_containers Containers
These are classes, templates and class macros are used by wxWidgets. Most of
wxWidgets has several small classes to work with disk files and directories.
-Related Overviews: @ref overview_file
+Related overview: @ref overview_file
@li wxFileName: Operations with the file name and attributes
@li wxDir: Class for enumerating files/subdirectories.
@li wxTextFile: Class for working with text files as with arrays of lines
@li wxStandardPaths: Paths for standard directories
@li wxPathList: A class to help search multiple paths
+@li wxFileSystemWatcher: Class providing notifications of file system changes
@section page_class_cat_streams Streams
-wxWidgets has its own set of stream classes, as an alternative to often buggy
-standard stream libraries, and to provide enhanced functionality.
+wxWidgets has its own set of stream classes as an alternative to the
+standard stream libraries and to provide enhanced functionality.
+
+Related overview: @ref overview_stream
@li wxStreamBase: Stream base class
@li wxStreamBuffer: Stream buffer class
Resources allow your application to create controls and other user interface
elements from specifications stored in an XML format.
-Related Overviews: @ref overview_xrc
+Related overview: @ref overview_xrc
@li wxXmlResource: The main class for working with resources
@li wxXmlResourceHandler: The base class for XML resource handlers
wxWidgets provides simple interprocess communications facilities based on
Windows DDE, but available on most platforms using TCP.
-Related Overviews: @ref overview_ipc
+Related overview: @ref overview_ipc
@li wxClient, wxDDEClient: Represents a client
@li wxConnection, wxDDEConnection: Represents the connection between a client
projects / wxWidgets.git / blobdiff