1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Classes-by-category page of the Doxygen manual
4 // Author: wxWidgets team
5 // RCS-ID: $Id: cat_classes.h 52468 2008-03-13 16:30:38Z FM $
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
11 @page page_class_cat Summarized Class List by Category
13 This page contains a summarized listing of classes, please see the
14 @ref group_class page for a full listing.
18 @li @ref page_class_cat_basicwnd
19 @li @ref page_class_cat_winlayout
20 @li @ref page_class_cat_managedwnd
21 @li @ref page_class_cat_menus
22 @li @ref page_class_cat_ctrl
23 @li @ref page_class_cat_pickers
24 @li @ref page_class_cat_miscwnd
25 @li @ref page_class_cat_aui
26 @li @ref page_class_cat_cmndlg
27 @li @ref page_class_cat_html
28 @li @ref page_class_cat_richtext
29 @li @ref page_class_cat_stc
31 @li @ref page_class_cat_dc
32 @li @ref page_class_cat_gdi
33 @li @ref page_class_cat_gc
34 @li @ref page_class_cat_image
35 @li @ref page_class_cat_events
36 @li @ref page_class_cat_validator
37 @li @ref page_class_cat_appmanagement
38 @li @ref page_class_cat_printing
39 @li @ref page_class_cat_dvf
40 @li @ref page_class_cat_dnd
41 @li @ref page_class_cat_vfs
43 @li @ref page_class_cat_rtti
44 @li @ref page_class_cat_debugging
45 @li @ref page_class_cat_logging
46 @li @ref page_class_cat_threading
47 @li @ref page_class_cat_data
48 @li @ref page_class_cat_containers
49 @li @ref page_class_cat_smartpointers
50 @li @ref page_class_cat_file
51 @li @ref page_class_cat_streams
52 @li @ref page_class_cat_xml
53 @li @ref page_class_cat_archive
55 @li @ref page_class_cat_xrc
56 @li @ref page_class_cat_net
57 @li @ref page_class_cat_ipc
58 @li @ref page_class_cat_help
59 @li @ref page_class_cat_media
60 @li @ref page_class_cat_gl
61 @li @ref page_class_cat_misc
69 @section page_class_cat_basicwnd Basic Windows
71 The following are the most important window classes
73 @li wxWindow: base class for all windows and controls
74 @li wxControl: base class (mostly) for native controls/widgets
75 @li wxPanel: window which can smartly manage child windows
76 @li ::wxScrolledWindow: Window with automatically managed scrollbars (see
78 @li wxTopLevelWindow: Any top level window, dialog or frame
82 @section page_class_cat_winlayout Window Layout
84 There are two different systems for laying out windows (and dialogs in
85 particular). One is based upon so-called sizers and it requires less typing,
86 thinking and calculating and will in almost all cases produce dialogs looking
87 equally well on all platforms, the other is based on so-called constraints and
88 is deprecated, though still available.
90 Related Overviews: @ref overview_sizer, @ref overview_constraints
92 These are the classes relevant to sizer-based layout:
94 @li wxSizer: Abstract base class
95 @li wxGridSizer: A sizer for laying out windows in a grid with all fields
97 @li wxFlexGridSizer: A sizer for laying out windows in a flexible grid
98 @li wxGridBagSizer: Another grid sizer that lets you specify the cell an item
99 is in, and items can span rows and/or columns.
100 @li wxBoxSizer: A sizer for laying out windows in a row or column
101 @li wxStaticBoxSizer: Same as wxBoxSizer, but with a surrounding static box
102 @li wxWrapSizer: A sizer which wraps its child controls as size permits
104 These are the classes relevant to constraints-based window layout:
106 @li wxIndividualLayoutConstraint: Represents a single constraint dimension
107 @li wxLayoutConstraints: Represents the constraints for a window class
109 Other layout classes:
111 @li wxLayoutAlgorithm: An alternative window layout facility
115 @section page_class_cat_managedwnd Managed Windows
117 There are several types of window that are directly controlled by the window
118 manager (such as MS Windows, or the Motif Window Manager). Frames and dialogs
119 are similar in wxWidgets, but only dialogs may be modal.
121 Related Overviews: @ref overview_cmndlg
123 @li wxDialog: Dialog box
124 @li wxFrame: Normal frame
125 @li wxMDIChildFrame: MDI child frame
126 @li wxMDIParentFrame: MDI parent frame
127 @li wxMiniFrame: A frame with a small title bar
128 @li wxPopupWindow: A toplevel window without decorations, e.g. for a combobox pop-up
129 @li wxPropertySheetDialog: Property sheet dialog
130 @li wxSplashScreen: Splash screen class
131 @li wxTipWindow: Shows text in a small window
132 @li wxWizard: A wizard dialog
136 @section page_class_cat_menus Menus
138 @li wxMenu: Displays a series of menu items for selection
139 @li wxMenuBar: Contains a series of menus for use with a frame
140 @li wxMenuItem: Represents a single menu item
144 @section page_class_cat_ctrl Controls
146 Typically, these are small windows which provide interaction with the user.
147 Controls that are not static can have wxValidator associated with them.
149 @li wxAnimationCtrl: A control to display an animation
150 @li wxControl: The base class for controls
151 @li wxButton: Push button control, displaying text
152 @li wxBitmapButton: Push button control, displaying a bitmap
153 @li wxBitmapComboBox: A combobox with bitmaps next to text items
154 @li wxToggleButton: A button which stays pressed when clicked by user.
155 @li wxBitmapToggleButton: A toggle button with bitmaps.
156 @li wxCalendarCtrl: Control showing an entire calendar month
157 @li wxCheckBox: Checkbox control
158 @li wxCheckListBox: A listbox with a checkbox to the left of each item
159 @li wxChoice: Choice control (a combobox without the editable area)
160 @li wxCollapsiblePane: A panel which can be shown/hidden by the user
161 @li wxComboBox: A choice with an editable area
162 @li wxComboCtrl: A combobox with application defined popup
163 @li wxDataViewCtrl: A control to tabular or tree like data
164 @li wxDataViewTreeCtrl: A specialized wxDataViewCtrl with wxTreeCtrl-like API
165 @li wxGauge: A control to represent a varying quantity, such as time remaining
166 @li wxGenericDirCtrl: A control for displaying a directory tree
167 @li wxHtmlListBox: An abstract class for creating listboxes showing HTML
169 @li wxSimpleHtmlListBox: A listbox showing HTML content
170 @li wxStaticBox: A static, or group box for visually grouping related controls
171 @li wxListBox: A list of strings for single or multiple selection
172 @li wxListCtrl: A control for displaying lists of strings and/or icons, plus a
173 multicolumn report view
174 @li wxListView: A simpler interface (façade) for wxListCtrl in report
176 @li wxOwnerDrawnComboBox: A combobox with owner-drawn list items
177 @li wxRichTextCtrl: Generic rich text editing control
178 @li wxTextCtrl: Single or multiline text editing control
179 @li wxTreeCtrl: Tree (hierarchy) control
180 @li wxScrollBar: Scrollbar control
181 @li wxSpinButton: A spin or `up-down' control
182 @li wxSpinCtrl: A spin control - i.e. spin button and text control
183 @li wxStaticText: One or more lines of non-editable text
184 @li wxHyperlinkCtrl: A static text which opens an URL when clicked
185 @li wxStaticBitmap: A control to display a bitmap
186 @li wxRadioBox: A group of radio buttons
187 @li wxRadioButton: A round button to be used with others in a mutually
189 @li wxSlider: A slider that can be dragged by the user
190 @li wxVListBox: A listbox supporting variable height rows
194 @section page_class_cat_pickers Picker Controls
196 A picker control is a control whose appearance and behaviour is highly
199 @li wxColourPickerCtrl: A control which allows the user to choose a colour
200 @li wxDirPickerCtrl: A control which allows the user to choose a directory
201 @li wxFilePickerCtrl: A control which allows the user to choose a file
202 @li wxFontPickerCtrl: A control which allows the user to choose a font
203 @li wxDatePickerCtrl: Small date picker control
207 @section page_class_cat_miscwnd Miscellaneous Windows
209 The following are a variety of classes that are derived from wxWindow.
211 @li wxPanel: A window whose colour changes according to current user settings
212 @li ::wxScrolledWindow: Window with automatically managed scrollbars (see
214 @li wxHScrolledWindow: As ::wxScrolledWindow but supports columns of variable
216 @li wxVScrolledWindow: As ::wxScrolledWindow but supports rows of variable
218 @li wxHVScrolledWindow: As ::wxScrolledWindow but supports scroll units of
220 @li wxGrid: A grid (table) window
221 @li wxSplitterWindow: Window which can be split vertically or horizontally
222 @li wxStatusBar: Implements the status bar on a frame
223 @li wxToolBar: Toolbar class
224 @li wxNotebook: Notebook class
225 @li wxListbook: Similar to notebook but using list control
226 @li wxChoicebook: Similar to notebook but using choice control
227 @li wxTreebook: Similar to notebook but using tree control
228 @li wxSashWindow: Window with four optional sashes that can be dragged
229 @li wxSashLayoutWindow: Window that can be involved in an IDE-like layout
231 @li wxWizardPage: A base class for the page in wizard dialog.
232 @li wxWizardPageSimple: A page in wizard dialog.
236 @section page_class_cat_aui Window Docking (wxAUI)
238 wxAUI is a set classes for writing a customizable application interface
239 with built-in docking, floatable panes and a flexible MDI-like interface.
241 Related Overviews: @ref overview_aui
243 @li wxAuiManager: The central class for managing the interface
244 @li wxAuiNotebook: A replacement notebook class with extra features
245 @li wxAuiPaneInfo: Describes a single pane
246 @li wxAuiDockArt: Art and metrics provider for customizing the docking user
248 @li wxAuiTabArt: Art and metrics provider for customizing the notebook user
253 @section page_class_cat_cmndlg Common Dialogs
255 Common dialogs are ready-made dialog classes which are frequently used in an
258 Related Overviews: @ref overview_cmndlg
260 @li wxDialog: Base class for common dialogs
261 @li wxColourDialog: Colour chooser dialog
262 @li wxDirDialog: Directory selector dialog
263 @li wxFileDialog: File selector dialog
264 @li wxFindReplaceDialog: Text search/replace dialog
265 @li wxMultiChoiceDialog: Dialog to get one or more selections from a list
266 @li wxSingleChoiceDialog: Dialog to get a single selection from a list and
268 @li wxTextEntryDialog: Dialog to get a single line of text from the user
269 @li wxPasswordEntryDialog: Dialog to get a password from the user
270 @li wxFontDialog: Font chooser dialog
271 @li wxPageSetupDialog: Standard page setup dialog
272 @li wxPrintDialog: Standard print dialog
273 @li wxProgressDialog: Progress indication dialog
274 @li wxMessageDialog: Simple message box dialog
275 @li wxSymbolPickerDialog: Symbol selector dialog
276 @li wxRichTextFormattingDialog: A dialog for formatting the content of a
278 @li wxWizard: A wizard dialog.
282 @section page_class_cat_html HTML
284 wxWidgets provides a set of classes to display text in HTML format. These
285 classes include a help system based on the HTML widget.
287 @li wxHtmlHelpController: HTML help controller class
288 @li wxHtmlWindow: HTML window class
289 @li wxHtmlEasyPrinting: Simple class for printing HTML
290 @li wxHtmlPrintout: Generic HTML wxPrintout class
291 @li wxHtmlParser: Generic HTML parser class
292 @li wxHtmlTagHandler: HTML tag handler, pluginable into wxHtmlParser
293 @li wxHtmlWinParser: HTML parser class for wxHtmlWindow
294 @li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser
298 @section page_class_cat_richtext Rich Text
300 wxWidgets provides a set of generic classes to edit and print simple rich text
301 with character and paragraph formatting.
303 @li wxTextAttr: Attributes specifying text styling.
304 @li wxRichTextCtrl: A rich text control.
305 @li wxRichTextBuffer: The content of a rich text control.
306 @li wxRichTextCharacterStyleDefinition: Definition of character styling.
307 @li wxRichTextParagraphStyleDefinition: Definition of paragraph styling.
308 @li wxRichTextListStyleDefinition: Definition of list styling.
309 @li wxRichTextStyleSheet: A set of style definitions.
310 @li wxRichTextStyleComboCtrl: A drop-down control for applying styles.
311 @li wxRichTextStyleListBox: A listbox for applying styles.
312 @li wxRichTextStyleOrganiserDialog: A dialog that can be used for managing or
314 @li wxRichTextEvent: A rich text event.
315 @li wxRichTextRange: Specification for ranges in a rich text control or buffer.
316 @li wxRichTextFileHandler: File handler base class.
317 @li wxRichTextHTMLHandler: A handler for converting rich text to HTML.
318 @li wxRichTextXMLHandler: A handler for loading and saving rich text XML.
319 @li wxRichTextFormattingDialog: A dialog for rich text formatting.
320 @li wxRichTextPrinting: A class for easy printing of rich text buffers.
321 @li wxRichTextPrintout: A class used by wxRichTextPrinting.
322 @li wxRichTextHeaderFooterData: Header and footer data specification.
326 @section page_class_cat_stc Scintilla Text Editor
328 wxWidgets also provides a wrapper around the Scintilla text editor control,
329 which is a control for plain-text editing with support for highlighting, smart
332 @li wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code
337 @section page_class_cat_dc Device Contexts
339 Device contexts are surfaces that may be drawn on, and provide an abstraction
340 that allows parameterisation of your drawing code by passing different device
343 Related Overviews: @ref overview_dc
345 @li wxAutoBufferedPaintDC: A helper device context for double buffered drawing
347 @li wxBufferedDC: A helper device context for double buffered drawing.
348 @li wxBufferedPaintDC: A helper device context for double buffered drawing
350 @li wxClientDC: A device context to access the client area outside
352 @li wxPaintDC: A device context to access the client area inside @b OnPaint()
354 @li wxWindowDC: A device context to access the non-client area
355 @li wxScreenDC: A device context to access the entire screen
356 @li wxDC: The device context base class
357 @li wxMemoryDC: A device context for drawing into bitmaps
358 @li wxMetafileDC: A device context for drawing into metafiles
359 @li wxMirrorDC: A proxy device context allowing for simple mirroring.
360 @li wxPostScriptDC: A device context for drawing into PostScript files
361 @li wxPrinterDC: A device context for drawing to printers
365 @section page_class_cat_gc Graphics Context classes
367 These classes are related to drawing using a new vector based drawing API and
368 are based on the modern drawing backend GDI+, CoreGraphics and Cairo.
370 @li wxGraphicsRenderer: Represents a drawing engine.
371 @li wxGraphicsContext: Represents a graphics context currently being drawn on.
372 @li wxGraphicsBrush: Brush for drawing into a wxGraphicsContext
373 @li wxGraphicsPen: Pen for drawing into a wxGraphicsContext
374 @li wxGraphicsFont: Font for drawing text on a wxGraphicsContext
375 @li wxGraphicsMatrix: Represents an affine matrix for drawing transformation
379 @section page_class_cat_gdi Graphics Device Interface
381 These classes are related to drawing on device contexts and windows.
383 @li wxColour: Represents the red, blue and green elements of a colour
384 @li wxDCClipper: Wraps the operations of setting and destroying the clipping
386 @li wxBrush: Used for filling areas on a device context
387 @li wxBrushList: The list of previously-created brushes
388 @li wxFont: Represents fonts
389 @li wxFontList: The list of previously-created fonts
390 @li wxPen: Used for drawing lines on a device context
391 @li wxPenList: The list of previously-created pens
392 @li wxPalette: Represents a table of indices into RGB values
393 @li wxRegion: Represents a simple or complex region on a window or device
395 @li wxRendererNative: Abstracts high-level drawing primitives
399 @section page_class_cat_image Image and bitmap classes
401 These classes represent images and bitmap in various formats and ways
402 to access and create them.
404 Related Overviews: @ref overview_bitmap
406 @li wxAnimation: Represents an animation
407 @li wxBitmap: Represents a platform dependent bitmap
408 @li wxBitmapHandler: Class for loading a saving a wxBitmap in a specific format
409 @li wxCursor: A small, transparent bitmap representing the cursor
410 @li wxIcon: A small, transparent bitmap for assigning to frames and drawing on
412 @li wxImage: A platform-independent image class
413 @li wxImageHandler: Class for loading a saving a wxImage in a specific format
414 @li wxImageList: A list of images, used with some controls
415 @li wxMask: Represents a mask to be used with a bitmap for transparent drawing
416 @li wxMemoryDC: A device context for drawing into bitmaps
417 @li wxPixelData: Class template for direct access to wxBitmap's and wxImage's internal data
421 @section page_class_cat_events Events
423 An event object contains information about a specific event. Event handlers
424 (usually member functions) have a single, event argument.
426 Related Overviews: @ref overview_eventhandling
428 @li wxActivateEvent: A window or application activation event
429 @li wxCalendarEvent: Used with wxCalendarCtrl
430 @li wxCalculateLayoutEvent: Used to calculate window layout
431 @li wxChildFocusEvent: A child window focus event
432 @li wxClipboardTextEvent: A clipboard copy/cut/paste treebook event event
433 @li wxCloseEvent: A close window or end session event
434 @li wxCommandEvent: An event from a variety of standard controls
435 @li wxContextMenuEvent: An event generated when the user issues a context menu
437 @li wxDateEvent: Used with wxDatePickerCtrl
438 @li wxDialUpEvent: Event send by wxDialUpManager
439 @li wxDropFilesEvent: A drop files event
440 @li wxEraseEvent: An erase background event
441 @li wxEvent: The event base class
442 @li wxFindDialogEvent: Event sent by wxFindReplaceDialog
443 @li wxFocusEvent: A window focus event
444 @li wxKeyEvent: A keypress event
445 @li wxIconizeEvent: An iconize/restore event
446 @li wxIdleEvent: An idle event
447 @li wxInitDialogEvent: A dialog initialisation event
448 @li wxJoystickEvent: A joystick event
449 @li wxListEvent: A list control event
450 @li wxMaximizeEvent: A maximize event
451 @li wxMenuEvent: A menu event
452 @li wxMouseCaptureChangedEvent: A mouse capture changed event
453 @li wxMouseCaptureLostEvent: A mouse capture lost event
454 @li wxMouseEvent: A mouse event
455 @li wxMoveEvent: A move event
456 @li wxNavigationKeyEvent: An event set by navigation keys such as tab
457 @li wxNotebookEvent: A notebook control event
458 @li wxNotifyEvent: A notification event, which can be vetoed
459 @li wxPaintEvent: A paint event
460 @li wxProcessEvent: A process ending event
461 @li wxQueryLayoutInfoEvent: Used to query layout information
462 @li wxRichTextEvent: A rich text editing event
463 @li wxScrollEvent: A scroll event from sliders, stand-alone scrollbars and spin
465 @li wxScrollWinEvent: A scroll event from scrolled windows
466 @li wxSizeEvent: A size event
467 @li wxSocketEvent: A socket event
468 @li wxSpinEvent: An event from wxSpinButton
469 @li wxSplitterEvent: An event from wxSplitterWindow
470 @li wxSysColourChangedEvent: A system colour change event
471 @li wxTimerEvent: A timer expiration event
472 @li wxTreebookEvent: A treebook control event
473 @li wxTreeEvent: A tree control event
474 @li wxUpdateUIEvent: A user interface update event
475 @li wxWindowCreateEvent: A window creation event
476 @li wxWindowDestroyEvent: A window destruction event
477 @li wxWizardEvent: A wizard event
481 @section page_class_cat_validator Validators
483 These are the window validators, used for filtering and validating user input.
485 Related Overviews: @ref overview_validator
487 @li wxValidator: Base validator class
488 @li wxTextValidator: Text control validator class
489 @li wxGenericValidator: Generic control validator class
493 @section page_class_cat_appmanagement Application and Process Management
495 @li wxApp: Application class
496 @li wxCmdLineParser: Command line parser class
497 @li wxDllLoader: Class to work with shared libraries.
498 @li wxProcess: Process class
502 @section page_class_cat_printing Printing Framework
504 A printing and previewing framework is implemented to make it relatively
505 straightforward to provide document printing facilities.
507 Related Overviews: @ref overview_printing
509 @li wxPreviewFrame: Frame for displaying a print preview
510 @li wxPreviewCanvas: Canvas for displaying a print preview
511 @li wxPreviewControlBar: Standard control bar for a print preview
512 @li wxPrintDialog: Standard print dialog
513 @li wxPageSetupDialog: Standard page setup dialog
514 @li wxPrinter: Class representing the printer
515 @li wxPrinterDC: Printer device context
516 @li wxPrintout: Class representing a particular printout
517 @li wxPrintPreview: Class representing a print preview
518 @li wxPrintData: Represents information about the document being printed
519 @li wxPrintDialogData: Represents information about the print dialog
520 @li wxPageSetupDialogData: Represents information about the page setup dialog
524 @section page_class_cat_dvf Document/View Framework
526 wxWidgets supports a document/view framework which provides housekeeping for a
527 document-centric application.
529 Related Overviews: @ref overview_docview
531 @li wxCommand: Base class for undo/redo actions
532 @li wxCommandProcessor: Maintains the undo/redo stack
533 @li wxDocument: Represents a document
534 @li wxView: Represents a view
535 @li wxDocTemplate: Manages the relationship between a document class and a
537 @li wxDocManager: Manages the documents and views in an application
538 @li wxDocChildFrame: A child frame for showing a document view
539 @li wxDocParentFrame: A parent frame to contain views
540 @li wxDocMDIChildFrame: An MDI child frame for showing a document view
541 @li wxDocMDIParentFrame: An MDI parent frame to contain views
542 @li wxFileHistory: Maintains a list of the most recently visited files
546 @section page_class_cat_dnd Clipboard and Drag & Drop
548 Related Overviews: @ref overview_dnd
550 @li wxDataObject: Data object class
551 @li wxDataFormat: Represents a data format
552 @li wxTextDataObject: Text data object class
553 @li wxFileDataObject: File data object class
554 @li wxBitmapDataObject: Bitmap data object class
555 @li wxURLDataObject: URL data object class
556 @li wxCustomDataObject: Custom data object class
557 @li wxClipboard: Clipboard class
558 @li wxDropTarget: Drop target class
559 @li wxFileDropTarget: File drop target class
560 @li wxTextDropTarget: Text drop target class
561 @li wxDropSource: Drop source class
565 @section page_class_cat_vfs Virtual File System
567 wxWidgets provides a set of classes that implement an extensible virtual file
568 system, used internally by the HTML classes.
570 @li wxFSFile: Represents a file in the virtual file system
571 @li wxFileSystem: Main interface for the virtual file system
572 @li wxFileSystemHandler: Class used to announce file system type
576 @section page_class_cat_rtti Runtime Type Information (RTTI)
578 wxWidgets supports runtime manipulation of class information, and dynamic
579 creation of objects given class names.
581 Related Overviews: @ref overview_rtti
583 @see @ref group_funcmacro_rtti "RTTI Functions and Macros"
585 @li wxClassInfo: Holds runtime class information
586 @li wxObject: Root class for classes with runtime information
590 @section page_class_cat_debugging Debugging
592 wxWidgets supports some aspects of debugging an application through classes,
593 functions and macros.
595 Related Overviews: @ref overview_debugging
597 @see @ref group_funcmacro_debug "Debugging Functions and Macros"
599 @li wxDebugContext: Provides memory-checking facilities
600 @li wxDebugReport: Base class for creating debug reports in case of a program
602 @li wxDebugReportCompress: Class for creating compressed debug reports.
603 @li wxDebugReportUpload: Class for uploading compressed debug reports via HTTP.
604 @li wxDebugReportPreview: Abstract base class for previewing the contents of a
606 @li wxDebugReportPreviewStd: Standard implementation of wxDebugReportPreview.
610 @section page_class_cat_logging Logging
612 wxWidgets provides several classes and functions for message logging.
614 Related Overviews: @ref overview_log
616 @see @ref group_funcmacro_log "Logging Functions and Macros"
618 @li wxLog: The base log class
619 @li wxLogStderr: Log messages to a C STDIO stream
620 @li wxLogStream: Log messages to a C++ iostream
621 @li wxLogTextCtrl: Log messages to a wxTextCtrl
622 @li wxLogWindow: Log messages to a log frame
623 @li wxLogGui: Default log target for GUI programs
624 @li wxLogNull: Temporarily suppress message logging
625 @li wxLogChain: Allows to chain two log targets
626 @li wxLogInterposer: Allows to filter the log messages
627 @li wxLogInterposerTemp: Allows to filter the log messages
628 @li wxStreamToTextRedirector: Allows to redirect output sent to @c cout to a wxTextCtrl
632 @section page_class_cat_threading Threading
634 wxWidgets provides a set of classes to make use of the native thread
635 capabilities of the various platforms.
637 Related Overviews: @ref overview_thread
639 @li wxThread: Thread class
640 @li wxThreadHelper: Manages background threads easily
641 @li wxMutex: Mutex class
642 @li wxMutexLocker: Mutex locker utility class
643 @li wxCriticalSection: Critical section class
644 @li wxCriticalSectionLocker: Critical section locker utility class
645 @li wxCondition: Condition class
646 @li wxSemaphore: Semaphore class
650 @section page_class_cat_data Data Structures
652 These are the data structure classes supported by wxWidgets.
654 @li wxCmdLineParser: Command line parser class
655 @li wxDateSpan: A logical time interval.
656 @li wxDateTime: A class for date/time manipulations
657 @li wxLongLong: A portable 64 bit integer type
658 @li wxObject: The root class for most wxWidgets classes
659 @li wxPathList: A class to help search multiple paths
660 @li wxPoint: Representation of a point
661 @li wxRect: A class representing a rectangle
662 @li wxRegEx: Regular expression support
663 @li wxRegion: A class representing a region
664 @li wxString: A string class
665 @li wxStringTokenizer: A class for interpreting a string as a list of tokens or
667 @li wxRealPoint: Representation of a point using floating point numbers
668 @li wxSize: Representation of a size
669 @li wxTimeSpan: A time interval.
670 @li wxURI: Represents a Uniform Resource Identifier
671 @li wxVariant: A class for storing arbitrary types that may change at run-time
675 @section page_class_cat_containers Containers
677 These are classes, templates and class macros are used by wxWidgets. Most of
678 these classes provide a subset or almost complete STL API.
680 Related Overviews: @ref overview_container
682 @li wxArray<T>: A type-safe dynamic array implementation (macro based)
683 @li wxArrayString: An efficient container for storing wxString objects
684 @li wxHashMap<T>: A type-safe hash map implementation (macro based)
685 @li wxHashSet<T>: A type-safe hash set implementation(macro based)
686 @li wxHashTable: A simple hash table implementation (deprecated, use wxHashMap)
687 @li wxList<T>: A type-safe linked list implementation (macro based)
688 @li wxVector<T>: Template base vector implementation identical to std::vector
692 @section page_class_cat_smartpointers Smart Pointers
694 wxWidgets provides a few smart pointer class templates.
696 @li wxObjectDataPtr<T>: A shared pointer (using intrusive reference counting)
697 @li wxScopedPtr<T>: A scoped pointer
698 @li wxSharedPtr<T>: A shared pointer (using non-intrusive reference counting)
699 @li wxWeakRef<T>: A weak reference
703 @section page_class_cat_file File Handling
705 wxWidgets has several small classes to work with disk files and directories.
707 Related Overviews: @ref overview_file
709 @li wxFileName: Operations with the file name and attributes
710 @li wxDir: Class for enumerating files/subdirectories.
711 @li wxDirTraverser: Class used together with wxDir for recursively enumerating
712 the files/subdirectories
713 @li wxFile: Low-level file input/output class.
714 @li wxFFile: Another low-level file input/output class.
715 @li wxTempFile: Class to safely replace an existing file
716 @li wxTextFile: Class for working with text files as with arrays of lines
717 @li wxStandardPaths: Paths for standard directories
718 @li wxPathList: A class to help search multiple paths
722 @section page_class_cat_streams Streams
724 wxWidgets has its own set of stream classes, as an alternative to often buggy
725 standard stream libraries, and to provide enhanced functionality.
727 @li wxStreamBase: Stream base class
728 @li wxStreamBuffer: Stream buffer class
729 @li wxInputStream: Input stream class
730 @li wxOutputStream: Output stream class
731 @li wxCountingOutputStream: Stream class for querying what size a stream would
733 @li wxFilterInputStream: Filtered input stream class
734 @li wxFilterOutputStream: Filtered output stream class
735 @li wxBufferedInputStream: Buffered input stream class
736 @li wxBufferedOutputStream: Buffered output stream class
737 @li wxMemoryInputStream: Memory input stream class
738 @li wxMemoryOutputStream: Memory output stream class
739 @li wxDataInputStream: Platform-independent binary data input stream class
740 @li wxDataOutputStream: Platform-independent binary data output stream class
741 @li wxTextInputStream: Platform-independent text data input stream class
742 @li wxTextOutputStream: Platform-independent text data output stream class
743 @li wxFileInputStream: File input stream class
744 @li wxFileOutputStream: File output stream class
745 @li wxFFileInputStream: Another file input stream class
746 @li wxFFileOutputStream: Another file output stream class
747 @li wxTempFileOutputStream: Stream to safely replace an existing file
748 @li wxStringInputStream: String input stream class
749 @li wxStringOutputStream: String output stream class
750 @li wxZlibInputStream: Zlib and gzip (compression) input stream class
751 @li wxZlibOutputStream: Zlib and gzip (compression) output stream class
752 @li wxZipInputStream: Input stream for reading from ZIP archives
753 @li wxZipOutputStream: Output stream for writing from ZIP archives
754 @li wxTarInputStream: Input stream for reading from tar archives
755 @li wxTarOutputStream: Output stream for writing from tar archives
756 @li wxSocketInputStream: Socket input stream class
757 @li wxSocketOutputStream: Socket output stream class
761 @section page_class_cat_xml XML
763 @li wxXmlDocument: A class to parse XML files
764 @li wxXmlNode: A class which represents XML nodes
765 @li wxXmlAttribute: A class which represent an XML attribute
769 @section page_class_cat_archive Archive
771 @li wxArchiveInputStream
772 @li wxArchiveOutputStream
777 @section page_class_cat_xrc XML Based Resource System (XRC)
779 Resources allow your application to create controls and other user interface
780 elements from specifications stored in an XML format.
782 Related Overviews: @ref overview_xrc
784 @li wxXmlResource: The main class for working with resources
785 @li wxXmlResourceHandler: The base class for XML resource handlers
789 @section page_class_cat_net Networking
791 wxWidgets provides its own classes for socket based networking.
793 @li wxDialUpManager: Provides functions to check the status of network
794 connection and to establish one
795 @li wxIPV4address: Represents an Internet address
796 @li wxIPaddress: Represents an Internet address
797 @li wxSocketBase: Represents a socket base object
798 @li wxSocketClient: Represents a socket client
799 @li wxSocketServer: Represents a socket server
800 @li wxSocketEvent: A socket event
801 @li wxFTP: FTP protocol class
802 @li wxHTTP: HTTP protocol class
803 @li wxURL: Represents a Universal Resource Locator
807 @section page_class_cat_ipc Interprocess Communication
809 wxWidgets provides simple interprocess communications facilities based on
810 Windows DDE, but available on most platforms using TCP.
812 Related Overviews: @ref overview_ipc
814 @li wxClient, wxDDEClient: Represents a client
815 @li wxConnection, wxDDEConnection: Represents the connection between a client
817 @li wxServer, wxDDEServer: Represents a server
821 @section page_class_cat_help Help
823 @li wxHelpController: Family of classes for controlling help windows
824 @li wxHtmlHelpController: HTML help controller class
825 @li wxContextHelp: Class to put application into context-sensitive help mode
826 @li wxContextHelpButton: Button class for putting application into
827 context-sensitive help mode
828 @li wxHelpProvider: Abstract class for context-sensitive help provision
829 @li wxSimpleHelpProvider: Class for simple context-sensitive help provision
830 @li wxHelpControllerHelpProvider: Class for context-sensitive help provision
831 via a help controller
832 @li wxToolTip: Class implementing tooltips
836 @section page_class_cat_media Multimedia
838 @li wxMediaCtrl: Display multimedia contents.
842 @section page_class_cat_gl OpenGL
844 @li wxGLCanvas: Canvas that you can render OpenGL calls to.
845 @li wxGLContext: Class to ease sharing of OpenGL data resources.
849 @section page_class_cat_misc Miscellaneous
851 @li wxCaret: A caret (cursor) object
852 @li wxConfigBase: Classes for reading/writing the configuration settings
853 @li wxTimer: Timer class
854 @li wxStopWatch: Stop watch class
855 @li wxMimeTypesManager: MIME-types manager class
856 @li wxSystemSettings: System settings class for obtaining various global
858 @li wxSystemOptions: System options class for run-time configuration
859 @li wxAcceleratorTable: Accelerator table
860 @li wxAutomationObject: OLE automation class
861 @li wxFontMapper: Font mapping, finding suitable font for given encoding
862 @li wxEncodingConverter: Encoding conversions
863 @li wxCalendarDateAttr: Used with wxCalendarCtrl
864 @li wxQuantize: Class to perform quantization, or colour reduction
865 @li wxSingleInstanceChecker: Check that only single program instance is running