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
30 @li @ref page_class_cat_dc
31 @li @ref page_class_cat_gdi
32 @li @ref page_class_cat_gc
33 @li @ref page_class_cat_image
34 @li @ref page_class_cat_events
35 @li @ref page_class_cat_validator
36 @li @ref page_class_cat_appmanagement
37 @li @ref page_class_cat_printing
38 @li @ref page_class_cat_dvf
39 @li @ref page_class_cat_dnd
40 @li @ref page_class_cat_vfs
42 @li @ref page_class_cat_rtti
43 @li @ref page_class_cat_debugging
44 @li @ref page_class_cat_logging
45 @li @ref page_class_cat_threading
46 @li @ref page_class_cat_data
47 @li @ref page_class_cat_containers
48 @li @ref page_class_cat_smartpointers
49 @li @ref page_class_cat_file
50 @li @ref page_class_cat_streams
51 @li @ref page_class_cat_xml
52 @li @ref page_class_cat_archive
54 @li @ref page_class_cat_xrc
55 @li @ref page_class_cat_net
56 @li @ref page_class_cat_ipc
57 @li @ref page_class_cat_help
58 @li @ref page_class_cat_media
59 @li @ref page_class_cat_gl
60 @li @ref page_class_cat_misc
68 @section page_class_cat_basicwnd Basic Windows
70 The following are the most important window classes
72 @li wxWindow: base class for all windows and controls
73 @li wxControl: base class (mostly) for native controls/widgets
74 @li wxPanel: window which can smartly manage child windows
75 @li ::wxScrolledWindow: Window with automatically managed scrollbars (see
77 @li wxTopLevelWindow: Any top level window, dialog or frame
81 @section page_class_cat_winlayout Window Layout
83 There are two different systems for laying out windows (and dialogs in
84 particular). One is based upon so-called sizers and it requires less typing,
85 thinking and calculating and will in almost all cases produce dialogs looking
86 equally well on all platforms, the other is based on so-called constraints and
87 is deprecated, though still available.
89 Related Overviews: @ref overview_sizer, @ref overview_constraints
91 These are the classes relevant to sizer-based layout:
93 @li wxSizer: Abstract base class
94 @li wxGridSizer: A sizer for laying out windows in a grid with all fields
96 @li wxFlexGridSizer: A sizer for laying out windows in a flexible grid
97 @li wxGridBagSizer: Another grid sizer that lets you specify the cell an item
98 is in, and items can span rows and/or columns.
99 @li wxBoxSizer: A sizer for laying out windows in a row or column
100 @li wxStaticBoxSizer: Same as wxBoxSizer, but with a surrounding static box
101 @li wxWrapSizer: A sizer which wraps its child controls as size permits
103 These are the classes relevant to constraints-based window layout:
105 @li wxIndividualLayoutConstraint: Represents a single constraint dimension
106 @li wxLayoutConstraints: Represents the constraints for a window class
108 Other layout classes:
110 @li wxLayoutAlgorithm: An alternative window layout facility
114 @section page_class_cat_managedwnd Managed Windows
116 There are several types of window that are directly controlled by the window
117 manager (such as MS Windows, or the Motif Window Manager). Frames and dialogs
118 are similar in wxWidgets, but only dialogs may be modal.
120 Related Overviews: @ref overview_cmndlg
122 @li wxDialog: Dialog box
123 @li wxFrame: Normal frame
124 @li wxMDIChildFrame: MDI child frame
125 @li wxMDIParentFrame: MDI parent frame
126 @li wxMiniFrame: A frame with a small title bar
127 @li wxPopupWindow: A toplevel window without decorations, e.g. for a combobox pop-up
128 @li wxPropertySheetDialog: Property sheet dialog
129 @li wxSplashScreen: Splash screen class
130 @li wxTipWindow: Shows text in a small window
131 @li wxWizard: A wizard dialog
135 @section page_class_cat_menus Menus
137 @li wxMenu: Displays a series of menu items for selection
138 @li wxMenuBar: Contains a series of menus for use with a frame
139 @li wxMenuItem: Represents a single menu item
143 @section page_class_cat_ctrl Controls
145 Typically, these are small windows which provide interaction with the user.
146 Controls that are not static can have wxValidator associated with them.
148 @li wxAnimationCtrl: A control to display an animation
149 @li wxControl: The base class for controls
150 @li wxButton: Push button control, displaying text
151 @li wxBitmapButton: Push button control, displaying a bitmap
152 @li wxBitmapComboBox: A combobox with bitmaps next to text items
153 @li wxToggleButton: A button which stays pressed when clicked by user.
154 @li wxBitmapToggleButton: A toggle button with bitmaps.
155 @li wxCalendarCtrl: Control showing an entire calendar month
156 @li wxCheckBox: Checkbox control
157 @li wxCheckListBox: A listbox with a checkbox to the left of each item
158 @li wxChoice: Choice control (a combobox without the editable area)
159 @li wxCollapsiblePane: A panel which can be shown/hidden by the user
160 @li wxComboBox: A choice with an editable area
161 @li wxComboCtrl: A combobox with application defined popup
162 @li wxDataViewCtrl: A control to tabular or tree like data
163 @li wxDataViewTreeCtrl: A specialized wxDataViewCtrl with wxTreeCtrl-like API
164 @li wxGauge: A control to represent a varying quantity, such as time remaining
165 @li wxGenericDirCtrl: A control for displaying a directory tree
166 @li wxHtmlListBox: An abstract class for creating listboxes showing HTML
168 @li wxSimpleHtmlListBox: A listbox showing HTML content
169 @li wxStaticBox: A static, or group box for visually grouping related controls
170 @li wxListBox: A list of strings for single or multiple selection
171 @li wxListCtrl: A control for displaying lists of strings and/or icons, plus a
172 multicolumn report view
173 @li wxListView: A simpler interface (façade) for wxListCtrl in report
175 @li wxOwnerDrawnComboBox: A combobox with owner-drawn list items
176 @li wxRichTextCtrl: Generic rich text editing control
177 @li wxTextCtrl: Single or multiline text editing control
178 @li wxTreeCtrl: Tree (hierarchy) control
179 @li wxScrollBar: Scrollbar control
180 @li wxSpinButton: A spin or `up-down' control
181 @li wxSpinCtrl: A spin control - i.e. spin button and text control
182 @li wxStaticText: One or more lines of non-editable text
183 @li wxHyperlinkCtrl: A static text which opens an URL when clicked
184 @li wxStaticBitmap: A control to display a bitmap
185 @li wxRadioBox: A group of radio buttons
186 @li wxRadioButton: A round button to be used with others in a mutually
188 @li wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code
189 editing component for plain text editing.
190 @li wxSlider: A slider that can be dragged by the user
191 @li wxVListBox: A listbox supporting variable height rows
195 @section page_class_cat_pickers Picker Controls
197 A picker control is a control whose appearance and behaviour is highly
200 @li wxColourPickerCtrl: A control which allows the user to choose a colour
201 @li wxDirPickerCtrl: A control which allows the user to choose a directory
202 @li wxFilePickerCtrl: A control which allows the user to choose a file
203 @li wxFontPickerCtrl: A control which allows the user to choose a font
204 @li wxDatePickerCtrl: Small date picker control
208 @section page_class_cat_miscwnd Miscellaneous Windows
210 The following are a variety of classes that are derived from wxWindow.
212 @li wxPanel: A window whose colour changes according to current user settings
213 @li ::wxScrolledWindow: Window with automatically managed scrollbars (see
215 @li wxHScrolledWindow: As ::wxScrolledWindow but supports columns of variable
217 @li wxVScrolledWindow: As ::wxScrolledWindow but supports rows of variable
219 @li wxHVScrolledWindow: As ::wxScrolledWindow but supports scroll units of
221 @li wxGrid: A grid (table) window
222 @li wxSplitterWindow: Window which can be split vertically or horizontally
223 @li wxStatusBar: Implements the status bar on a frame
224 @li wxToolBar: Toolbar class
225 @li wxNotebook: Notebook class
226 @li wxListbook: Similar to notebook but using list control
227 @li wxChoicebook: Similar to notebook but using choice control
228 @li wxTreebook: Similar to notebook but using tree control
229 @li wxSashWindow: Window with four optional sashes that can be dragged
230 @li wxSashLayoutWindow: Window that can be involved in an IDE-like layout
232 @li wxWizardPage: A base class for the page in wizard dialog.
233 @li wxWizardPageSimple: A page in wizard dialog.
237 @section page_class_cat_aui Window Docking (wxAUI)
239 wxAUI is a set classes for writing a customizable application interface
240 with built-in docking, floatable panes and a flexible MDI-like interface.
242 Related Overviews: @ref overview_aui
244 @li wxAuiManager: The central class for managing the interface
245 @li wxAuiNotebook: A replacement notebook class with extra features
246 @li wxAuiPaneInfo: Describes a single pane
247 @li wxAuiDockArt: Art and metrics provider for customizing the docking user
249 @li wxAuiTabArt: Art and metrics provider for customizing the notebook user
254 @section page_class_cat_cmndlg Common Dialogs
256 Common dialogs are ready-made dialog classes which are frequently used in an
259 Related Overviews: @ref overview_cmndlg
261 @li wxDialog: Base class for common dialogs
262 @li wxColourDialog: Colour chooser dialog
263 @li wxDirDialog: Directory selector dialog
264 @li wxFileDialog: File selector dialog
265 @li wxFindReplaceDialog: Text search/replace dialog
266 @li wxMultiChoiceDialog: Dialog to get one or more selections from a list
267 @li wxSingleChoiceDialog: Dialog to get a single selection from a list and
269 @li wxTextEntryDialog: Dialog to get a single line of text from the user
270 @li wxPasswordEntryDialog: Dialog to get a password from the user
271 @li wxFontDialog: Font chooser dialog
272 @li wxPageSetupDialog: Standard page setup dialog
273 @li wxPrintDialog: Standard print dialog
274 @li wxProgressDialog: Progress indication dialog
275 @li wxMessageDialog: Simple message box dialog
276 @li wxSymbolPickerDialog: Symbol selector dialog
277 @li wxRichTextFormattingDialog: A dialog for formatting the content of a
279 @li wxWizard: A wizard dialog.
283 @section page_class_cat_html HTML
285 wxWidgets provides a set of classes to display text in HTML format. These
286 classes include a help system based on the HTML widget.
288 @li wxHtmlHelpController: HTML help controller class
289 @li wxHtmlWindow: HTML window class
290 @li wxHtmlEasyPrinting: Simple class for printing HTML
291 @li wxHtmlPrintout: Generic HTML wxPrintout class
292 @li wxHtmlParser: Generic HTML parser class
293 @li wxHtmlTagHandler: HTML tag handler, pluginable into wxHtmlParser
294 @li wxHtmlWinParser: HTML parser class for wxHtmlWindow
295 @li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser
299 @section page_class_cat_richtext Rich Text
301 wxWidgets provides a set of generic classes to edit and print simple rich text
302 with character and paragraph formatting.
304 @li wxTextAttr: Attributes specifying text styling.
305 @li wxRichTextCtrl: A rich text control.
306 @li wxRichTextBuffer: The content of a rich text control.
307 @li wxRichTextCharacterStyleDefinition: Definition of character styling.
308 @li wxRichTextParagraphStyleDefinition: Definition of paragraph styling.
309 @li wxRichTextListStyleDefinition: Definition of list styling.
310 @li wxRichTextStyleSheet: A set of style definitions.
311 @li wxRichTextStyleComboCtrl: A drop-down control for applying styles.
312 @li wxRichTextStyleListBox: A listbox for applying styles.
313 @li wxRichTextStyleOrganiserDialog: A dialog that can be used for managing or
315 @li wxRichTextEvent: A rich text event.
316 @li wxRichTextRange: Specification for ranges in a rich text control or buffer.
317 @li wxRichTextFileHandler: File handler base class.
318 @li wxRichTextHTMLHandler: A handler for converting rich text to HTML.
319 @li wxRichTextXMLHandler: A handler for loading and saving rich text XML.
320 @li wxRichTextFormattingDialog: A dialog for rich text formatting.
321 @li wxRichTextPrinting: A class for easy printing of rich text buffers.
322 @li wxRichTextPrintout: A class used by wxRichTextPrinting.
323 @li wxRichTextHeaderFooterData: Header and footer data specification.
326 @section page_class_cat_dc Device Contexts
328 Device contexts are surfaces that may be drawn on, and provide an abstraction
329 that allows parameterisation of your drawing code by passing different device
332 Related Overviews: @ref overview_dc
334 @li wxAutoBufferedPaintDC: A helper device context for double buffered drawing
336 @li wxBufferedDC: A helper device context for double buffered drawing.
337 @li wxBufferedPaintDC: A helper device context for double buffered drawing
339 @li wxClientDC: A device context to access the client area outside
341 @li wxPaintDC: A device context to access the client area inside @b OnPaint()
343 @li wxWindowDC: A device context to access the non-client area
344 @li wxScreenDC: A device context to access the entire screen
345 @li wxDC: The device context base class
346 @li wxMemoryDC: A device context for drawing into bitmaps
347 @li wxMetafileDC: A device context for drawing into metafiles
348 @li wxMirrorDC: A proxy device context allowing for simple mirroring.
349 @li wxPostScriptDC: A device context for drawing into PostScript files
350 @li wxPrinterDC: A device context for drawing to printers
354 @section page_class_cat_gc Graphics Context classes
356 These classes are related to drawing using a new vector based drawing API and
357 are based on the modern drawing backend GDI+, CoreGraphics and Cairo.
359 @li wxGraphicsRenderer: Represents a drawing engine.
360 @li wxGraphicsContext: Represents a graphics context currently being drawn on.
361 @li wxGraphicsBrush: Brush for drawing into a wxGraphicsContext
362 @li wxGraphicsPen: Pen for drawing into a wxGraphicsContext
363 @li wxGraphicsFont: Font for drawing text on a wxGraphicsContext
364 @li wxGraphicsMatrix: Represents an affine matrix for drawing transformation
365 @li wxGraphicsPath: Represents a path for drawing
369 @section page_class_cat_gdi Graphics Device Interface
371 These classes are related to drawing on device contexts and windows.
373 @li wxColour: Represents the red, blue and green elements of a colour
374 @li wxDCClipper: Wraps the operations of setting and destroying the clipping
376 @li wxBrush: Used for filling areas on a device context
377 @li wxBrushList: The list of previously-created brushes
378 @li wxFont: Represents fonts
379 @li wxFontList: The list of previously-created fonts
380 @li wxPen: Used for drawing lines on a device context
381 @li wxPenList: The list of previously-created pens
382 @li wxPalette: Represents a table of indices into RGB values
383 @li wxRegion: Represents a simple or complex region on a window or device
385 @li wxRendererNative: Abstracts high-level drawing primitives
389 @section page_class_cat_image Image and bitmap classes
391 These classes represent images and bitmap in various formats and ways
392 to access and create them.
394 Related Overviews: @ref overview_bitmap
396 @li wxAnimation: Represents an animation
397 @li wxBitmap: Represents a platform dependent bitmap
398 @li wxBitmapHandler: Class for loading a saving a wxBitmap in a specific format
399 @li wxCursor: A small, transparent bitmap representing the cursor
400 @li wxIcon: A small, transparent bitmap for assigning to frames and drawing on
402 @li wxImage: A platform-independent image class
403 @li wxImageHandler: Class for loading a saving a wxImage in a specific format
404 @li wxImageList: A list of images, used with some controls
405 @li wxMask: Represents a mask to be used with a bitmap for transparent drawing
406 @li wxMemoryDC: A device context for drawing into bitmaps
407 @li wxPixelData: Class template for direct access to wxBitmap's and wxImage's internal data
411 @section page_class_cat_events Events
413 An event object contains information about a specific event. Event handlers
414 (usually member functions) have a single, event argument.
416 Related Overviews: @ref overview_eventhandling
418 @li wxActivateEvent: A window or application activation event
419 @li wxCalendarEvent: Used with wxCalendarCtrl
420 @li wxCalculateLayoutEvent: Used to calculate window layout
421 @li wxChildFocusEvent: A child window focus event
422 @li wxClipboardTextEvent: A clipboard copy/cut/paste treebook event event
423 @li wxCloseEvent: A close window or end session event
424 @li wxCommandEvent: An event from a variety of standard controls
425 @li wxContextMenuEvent: An event generated when the user issues a context menu
427 @li wxDateEvent: Used with wxDatePickerCtrl
428 @li wxDialUpEvent: Event send by wxDialUpManager
429 @li wxDropFilesEvent: A drop files event
430 @li wxEraseEvent: An erase background event
431 @li wxEvent: The event base class
432 @li wxFindDialogEvent: Event sent by wxFindReplaceDialog
433 @li wxFocusEvent: A window focus event
434 @li wxKeyEvent: A keypress event
435 @li wxIconizeEvent: An iconize/restore event
436 @li wxIdleEvent: An idle event
437 @li wxInitDialogEvent: A dialog initialisation event
438 @li wxJoystickEvent: A joystick event
439 @li wxListEvent: A list control event
440 @li wxMaximizeEvent: A maximize event
441 @li wxMenuEvent: A menu event
442 @li wxMouseCaptureChangedEvent: A mouse capture changed event
443 @li wxMouseCaptureLostEvent: A mouse capture lost event
444 @li wxMouseEvent: A mouse event
445 @li wxMoveEvent: A move event
446 @li wxNavigationKeyEvent: An event set by navigation keys such as tab
447 @li wxNotebookEvent: A notebook control event
448 @li wxNotifyEvent: A notification event, which can be vetoed
449 @li wxPaintEvent: A paint event
450 @li wxProcessEvent: A process ending event
451 @li wxQueryLayoutInfoEvent: Used to query layout information
452 @li wxRichTextEvent: A rich text editing event
453 @li wxScrollEvent: A scroll event from sliders, stand-alone scrollbars and spin
455 @li wxScrollWinEvent: A scroll event from scrolled windows
456 @li wxSizeEvent: A size event
457 @li wxSocketEvent: A socket event
458 @li wxSpinEvent: An event from wxSpinButton
459 @li wxSplitterEvent: An event from wxSplitterWindow
460 @li wxSysColourChangedEvent: A system colour change event
461 @li wxTimerEvent: A timer expiration event
462 @li wxTreebookEvent: A treebook control event
463 @li wxTreeEvent: A tree control event
464 @li wxUpdateUIEvent: A user interface update event
465 @li wxWindowCreateEvent: A window creation event
466 @li wxWindowDestroyEvent: A window destruction event
467 @li wxWizardEvent: A wizard event
471 @section page_class_cat_validator Validators
473 These are the window validators, used for filtering and validating user input.
475 Related Overviews: @ref overview_validator
477 @li wxValidator: Base validator class
478 @li wxTextValidator: Text control validator class
479 @li wxGenericValidator: Generic control validator class
483 @section page_class_cat_appmanagement Application and Process Management
485 @li wxApp: Application class
486 @li wxCmdLineParser: Command line parser class
487 @li wxDllLoader: Class to work with shared libraries.
488 @li wxProcess: Process class
492 @section page_class_cat_printing Printing Framework
494 A printing and previewing framework is implemented to make it relatively
495 straightforward to provide document printing facilities.
497 Related Overviews: @ref overview_printing
499 @li wxPreviewFrame: Frame for displaying a print preview
500 @li wxPreviewCanvas: Canvas for displaying a print preview
501 @li wxPreviewControlBar: Standard control bar for a print preview
502 @li wxPrintDialog: Standard print dialog
503 @li wxPageSetupDialog: Standard page setup dialog
504 @li wxPrinter: Class representing the printer
505 @li wxPrinterDC: Printer device context
506 @li wxPrintout: Class representing a particular printout
507 @li wxPrintPreview: Class representing a print preview
508 @li wxPrintData: Represents information about the document being printed
509 @li wxPrintDialogData: Represents information about the print dialog
510 @li wxPageSetupDialogData: Represents information about the page setup dialog
514 @section page_class_cat_dvf Document/View Framework
516 wxWidgets supports a document/view framework which provides housekeeping for a
517 document-centric application.
519 Related Overviews: @ref overview_docview
521 @li wxCommand: Base class for undo/redo actions
522 @li wxCommandProcessor: Maintains the undo/redo stack
523 @li wxDocument: Represents a document
524 @li wxView: Represents a view
525 @li wxDocTemplate: Manages the relationship between a document class and a
527 @li wxDocManager: Manages the documents and views in an application
528 @li wxDocChildFrame: A child frame for showing a document view
529 @li wxDocParentFrame: A parent frame to contain views
530 @li wxDocMDIChildFrame: An MDI child frame for showing a document view
531 @li wxDocMDIParentFrame: An MDI parent frame to contain views
532 @li wxFileHistory: Maintains a list of the most recently visited files
536 @section page_class_cat_dnd Clipboard and Drag & Drop
538 Related Overviews: @ref overview_dnd
540 @li wxDataObject: Data object class
541 @li wxDataFormat: Represents a data format
542 @li wxTextDataObject: Text data object class
543 @li wxFileDataObject: File data object class
544 @li wxBitmapDataObject: Bitmap data object class
545 @li wxURLDataObject: URL data object class
546 @li wxCustomDataObject: Custom data object class
547 @li wxClipboard: Clipboard class
548 @li wxDropTarget: Drop target class
549 @li wxFileDropTarget: File drop target class
550 @li wxTextDropTarget: Text drop target class
551 @li wxDropSource: Drop source class
555 @section page_class_cat_vfs Virtual File System
557 wxWidgets provides a set of classes that implement an extensible virtual file
558 system, used internally by the HTML classes.
560 @li wxFSFile: Represents a file in the virtual file system
561 @li wxFileSystem: Main interface for the virtual file system
562 @li wxFileSystemHandler: Class used to announce file system type
566 @section page_class_cat_rtti Runtime Type Information (RTTI)
568 wxWidgets supports runtime manipulation of class information, and dynamic
569 creation of objects given class names.
571 Related Overviews: @ref overview_rtti
573 @see @ref group_funcmacro_rtti "RTTI Functions and Macros"
575 @li wxClassInfo: Holds runtime class information
576 @li wxObject: Root class for classes with runtime information
580 @section page_class_cat_debugging Debugging
582 wxWidgets supports some aspects of debugging an application through classes,
583 functions and macros.
585 Related Overviews: @ref overview_debugging
587 @see @ref group_funcmacro_debug "Debugging Functions and Macros"
589 @li wxDebugContext: Provides memory-checking facilities
590 @li wxDebugReport: Base class for creating debug reports in case of a program
592 @li wxDebugReportCompress: Class for creating compressed debug reports.
593 @li wxDebugReportUpload: Class for uploading compressed debug reports via HTTP.
594 @li wxDebugReportPreview: Abstract base class for previewing the contents of a
596 @li wxDebugReportPreviewStd: Standard implementation of wxDebugReportPreview.
600 @section page_class_cat_logging Logging
602 wxWidgets provides several classes and functions for message logging.
604 Related Overviews: @ref overview_log
606 @see @ref group_funcmacro_log "Logging Functions and Macros"
608 @li wxLog: The base log class
609 @li wxLogStderr: Log messages to a C STDIO stream
610 @li wxLogStream: Log messages to a C++ iostream
611 @li wxLogTextCtrl: Log messages to a wxTextCtrl
612 @li wxLogWindow: Log messages to a log frame
613 @li wxLogGui: Default log target for GUI programs
614 @li wxLogNull: Temporarily suppress message logging
615 @li wxLogChain: Allows to chain two log targets
616 @li wxLogInterposer: Allows to filter the log messages
617 @li wxLogInterposerTemp: Allows to filter the log messages
618 @li wxStreamToTextRedirector: Allows to redirect output sent to @c cout to a wxTextCtrl
622 @section page_class_cat_threading Threading
624 wxWidgets provides a set of classes to make use of the native thread
625 capabilities of the various platforms.
627 Related Overviews: @ref overview_thread
629 @li wxThread: Thread class
630 @li wxThreadHelper: Manages background threads easily
631 @li wxMutex: Mutex class
632 @li wxMutexLocker: Mutex locker utility class
633 @li wxCriticalSection: Critical section class
634 @li wxCriticalSectionLocker: Critical section locker utility class
635 @li wxCondition: Condition class
636 @li wxSemaphore: Semaphore class
640 @section page_class_cat_data Data Structures
642 These are the data structure classes supported by wxWidgets.
644 @li wxCmdLineParser: Command line parser class
645 @li wxDateSpan: A logical time interval.
646 @li wxDateTime: A class for date/time manipulations
647 @li wxLongLong: A portable 64 bit integer type
648 @li wxObject: The root class for most wxWidgets classes
649 @li wxPathList: A class to help search multiple paths
650 @li wxPoint: Representation of a point
651 @li wxRect: A class representing a rectangle
652 @li wxRegEx: Regular expression support
653 @li wxRegion: A class representing a region
654 @li wxString: A string class
655 @li wxStringTokenizer: A class for interpreting a string as a list of tokens or
657 @li wxRealPoint: Representation of a point using floating point numbers
658 @li wxSize: Representation of a size
659 @li wxTimeSpan: A time interval.
660 @li wxURI: Represents a Uniform Resource Identifier
661 @li wxVariant: A class for storing arbitrary types that may change at run-time
665 @section page_class_cat_containers Containers
667 These are classes, templates and class macros are used by wxWidgets. Most of
668 these classes provide a subset or almost complete STL API.
670 Related Overviews: @ref overview_container
672 @li wxArray<T>: A type-safe dynamic array implementation (macro based)
673 @li wxArrayString: An efficient container for storing wxString objects
674 @li wxHashMap<T>: A type-safe hash map implementation (macro based)
675 @li wxHashSet<T>: A type-safe hash set implementation(macro based)
676 @li wxHashTable: A simple hash table implementation (deprecated, use wxHashMap)
677 @li wxList<T>: A type-safe linked list implementation (macro based)
678 @li wxVector<T>: Template base vector implementation identical to std::vector
682 @section page_class_cat_smartpointers Smart Pointers
684 wxWidgets provides a few smart pointer class templates.
686 @li wxObjectDataPtr<T>: A shared pointer (using intrusive reference counting)
687 @li wxScopedPtr<T>: A scoped pointer
688 @li wxSharedPtr<T>: A shared pointer (using non-intrusive reference counting)
689 @li wxWeakRef<T>: A weak reference
693 @section page_class_cat_file File Handling
695 wxWidgets has several small classes to work with disk files and directories.
697 Related Overviews: @ref overview_file
699 @li wxFileName: Operations with the file name and attributes
700 @li wxDir: Class for enumerating files/subdirectories.
701 @li wxDirTraverser: Class used together with wxDir for recursively enumerating
702 the files/subdirectories
703 @li wxFile: Low-level file input/output class.
704 @li wxFFile: Another low-level file input/output class.
705 @li wxTempFile: Class to safely replace an existing file
706 @li wxTextFile: Class for working with text files as with arrays of lines
707 @li wxStandardPaths: Paths for standard directories
708 @li wxPathList: A class to help search multiple paths
712 @section page_class_cat_streams Streams
714 wxWidgets has its own set of stream classes, as an alternative to often buggy
715 standard stream libraries, and to provide enhanced functionality.
717 @li wxStreamBase: Stream base class
718 @li wxStreamBuffer: Stream buffer class
719 @li wxInputStream: Input stream class
720 @li wxOutputStream: Output stream class
721 @li wxCountingOutputStream: Stream class for querying what size a stream would
723 @li wxFilterInputStream: Filtered input stream class
724 @li wxFilterOutputStream: Filtered output stream class
725 @li wxBufferedInputStream: Buffered input stream class
726 @li wxBufferedOutputStream: Buffered output stream class
727 @li wxMemoryInputStream: Memory input stream class
728 @li wxMemoryOutputStream: Memory output stream class
729 @li wxDataInputStream: Platform-independent binary data input stream class
730 @li wxDataOutputStream: Platform-independent binary data output stream class
731 @li wxTextInputStream: Platform-independent text data input stream class
732 @li wxTextOutputStream: Platform-independent text data output stream class
733 @li wxFileInputStream: File input stream class
734 @li wxFileOutputStream: File output stream class
735 @li wxFFileInputStream: Another file input stream class
736 @li wxFFileOutputStream: Another file output stream class
737 @li wxTempFileOutputStream: Stream to safely replace an existing file
738 @li wxStringInputStream: String input stream class
739 @li wxStringOutputStream: String output stream class
740 @li wxZlibInputStream: Zlib and gzip (compression) input stream class
741 @li wxZlibOutputStream: Zlib and gzip (compression) output stream class
742 @li wxZipInputStream: Input stream for reading from ZIP archives
743 @li wxZipOutputStream: Output stream for writing from ZIP archives
744 @li wxTarInputStream: Input stream for reading from tar archives
745 @li wxTarOutputStream: Output stream for writing from tar archives
746 @li wxSocketInputStream: Socket input stream class
747 @li wxSocketOutputStream: Socket output stream class
751 @section page_class_cat_xml XML
753 @li wxXmlDocument: A class to parse XML files
754 @li wxXmlNode: A class which represents XML nodes
755 @li wxXmlAttribute: A class which represent an XML attribute
759 @section page_class_cat_archive Archive
761 @li wxArchiveInputStream
762 @li wxArchiveOutputStream
767 @section page_class_cat_xrc XML Based Resource System (XRC)
769 Resources allow your application to create controls and other user interface
770 elements from specifications stored in an XML format.
772 Related Overviews: @ref overview_xrc
774 @li wxXmlResource: The main class for working with resources
775 @li wxXmlResourceHandler: The base class for XML resource handlers
779 @section page_class_cat_net Networking
781 wxWidgets provides its own classes for socket based networking.
783 @li wxDialUpManager: Provides functions to check the status of network
784 connection and to establish one
785 @li wxIPV4address: Represents an Internet address
786 @li wxIPaddress: Represents an Internet address
787 @li wxSocketBase: Represents a socket base object
788 @li wxSocketClient: Represents a socket client
789 @li wxSocketServer: Represents a socket server
790 @li wxSocketEvent: A socket event
791 @li wxFTP: FTP protocol class
792 @li wxHTTP: HTTP protocol class
793 @li wxURL: Represents a Universal Resource Locator
797 @section page_class_cat_ipc Interprocess Communication
799 wxWidgets provides simple interprocess communications facilities based on
800 Windows DDE, but available on most platforms using TCP.
802 Related Overviews: @ref overview_ipc
804 @li wxClient, wxDDEClient: Represents a client
805 @li wxConnection, wxDDEConnection: Represents the connection between a client
807 @li wxServer, wxDDEServer: Represents a server
811 @section page_class_cat_help Help
813 @li wxHelpController: Family of classes for controlling help windows
814 @li wxHtmlHelpController: HTML help controller class
815 @li wxContextHelp: Class to put application into context-sensitive help mode
816 @li wxContextHelpButton: Button class for putting application into
817 context-sensitive help mode
818 @li wxHelpProvider: Abstract class for context-sensitive help provision
819 @li wxSimpleHelpProvider: Class for simple context-sensitive help provision
820 @li wxHelpControllerHelpProvider: Class for context-sensitive help provision
821 via a help controller
822 @li wxToolTip: Class implementing tooltips
826 @section page_class_cat_media Multimedia
828 @li wxMediaCtrl: Display multimedia contents.
832 @section page_class_cat_gl OpenGL
834 @li wxGLCanvas: Canvas that you can render OpenGL calls to.
835 @li wxGLContext: Class to ease sharing of OpenGL data resources.
839 @section page_class_cat_misc Miscellaneous
841 @li wxCaret: A caret (cursor) object
842 @li wxConfigBase: Classes for reading/writing the configuration settings
843 @li wxTimer: Timer class
844 @li wxStopWatch: Stop watch class
845 @li wxMimeTypesManager: MIME-types manager class
846 @li wxSystemSettings: System settings class for obtaining various global
848 @li wxSystemOptions: System options class for run-time configuration
849 @li wxAcceleratorTable: Accelerator table
850 @li wxAutomationObject: OLE automation class
851 @li wxFontMapper: Font mapping, finding suitable font for given encoding
852 @li wxEncodingConverter: Encoding conversions
853 @li wxCalendarDateAttr: Used with wxCalendarCtrl
854 @li wxQuantize: Class to perform quantization, or colour reduction
855 @li wxSingleInstanceChecker: Check that only single program instance is running