]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/mainpages/cat_classes.h
mention that mouse events carry position in window coordinates of the window which...
[wxWidgets.git] / docs / doxygen / mainpages / cat_classes.h
CommitLineData
29f86fc1
BP
1/////////////////////////////////////////////////////////////////////////////
2// Name: cat_classes.h
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/////////////////////////////////////////////////////////////////////////////
8
9/**
10
11@page page_class_cat Summarized Class List by Category
12
13This page contains a summarized listing of classes, please see the
14@ref group_class page for a full listing.
15
16@beginInvisibleTable
17<tr><td>
557563c8
RR
18@li @ref page_class_cat_basicwnd
19@li @ref page_class_cat_winlayout
29f86fc1 20@li @ref page_class_cat_managedwnd
557563c8
RR
21@li @ref page_class_cat_menus
22@li @ref page_class_cat_ctrl
c7d4ca81 23@li @ref page_class_cat_validator
557563c8 24@li @ref page_class_cat_pickers
29f86fc1 25@li @ref page_class_cat_aui
29f86fc1 26@li @ref page_class_cat_cmndlg
557563c8 27@li @ref page_class_cat_html
42b5841f 28@li @ref page_class_cat_miscwnd
557563c8 29</td><td>
29f86fc1
BP
30@li @ref page_class_cat_dc
31@li @ref page_class_cat_gdi
28792a70
RR
32@li @ref page_class_cat_gc
33@li @ref page_class_cat_image
29f86fc1 34@li @ref page_class_cat_events
557563c8 35@li @ref page_class_cat_appmanagement
29f86fc1 36@li @ref page_class_cat_printing
557563c8 37@li @ref page_class_cat_dvf
29f86fc1 38@li @ref page_class_cat_dnd
29f86fc1 39@li @ref page_class_cat_vfs
c7d4ca81 40@li @ref page_class_cat_threading
29f86fc1 41</td><td>
29f86fc1 42@li @ref page_class_cat_rtti
557563c8
RR
43@li @ref page_class_cat_debugging
44@li @ref page_class_cat_logging
557563c8 45@li @ref page_class_cat_data
79b40dcf 46@li @ref page_class_cat_conv
557563c8
RR
47@li @ref page_class_cat_containers
48@li @ref page_class_cat_smartpointers
557563c8 49@li @ref page_class_cat_file
557563c8 50@li @ref page_class_cat_streams
7ac7b533 51@li @ref page_class_cat_xml
29f86fc1 52@li @ref page_class_cat_xrc
c7d4ca81 53</td><td>
557563c8 54@li @ref page_class_cat_net
2038c5e2 55@li @ref page_class_cat_archive
557563c8 56@li @ref page_class_cat_ipc
29f86fc1
BP
57@li @ref page_class_cat_help
58@li @ref page_class_cat_media
59@li @ref page_class_cat_gl
29f86fc1
BP
60@li @ref page_class_cat_misc
61</td></tr>
62@endTable
63
64
65<hr>
66
67
557563c8 68@section page_class_cat_basicwnd Basic Windows
29f86fc1 69
557563c8 70The following are the most important window classes
29f86fc1 71
557563c8
RR
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
f09b5681
BP
75@li ::wxScrolledWindow: Window with automatically managed scrollbars (see
76 wxScrolled)
557563c8 77@li wxTopLevelWindow: Any top level window, dialog or frame
29f86fc1
BP
78
79
80
81@section page_class_cat_winlayout Window Layout
82
83There are two different systems for laying out windows (and dialogs in
84particular). One is based upon so-called sizers and it requires less typing,
85thinking and calculating and will in almost all cases produce dialogs looking
86equally well on all platforms, the other is based on so-called constraints and
87is deprecated, though still available.
88
09ad05fa 89Related Overviews: @ref overview_sizer
29f86fc1
BP
90
91These are the classes relevant to sizer-based layout:
92
93@li wxSizer: Abstract base class
94@li wxGridSizer: A sizer for laying out windows in a grid with all fields
95 having the same size
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
102
29f86fc1
BP
103Other layout classes:
104
105@li wxLayoutAlgorithm: An alternative window layout facility
106
107
108
557563c8 109@section page_class_cat_managedwnd Managed Windows
29f86fc1 110
557563c8
RR
111There are several types of window that are directly controlled by the window
112manager (such as MS Windows, or the Motif Window Manager). Frames and dialogs
113are similar in wxWidgets, but only dialogs may be modal.
29f86fc1
BP
114
115Related Overviews: @ref overview_cmndlg
116
557563c8
RR
117@li wxDialog: Dialog box
118@li wxFrame: Normal frame
119@li wxMDIChildFrame: MDI child frame
120@li wxMDIParentFrame: MDI parent frame
121@li wxMiniFrame: A frame with a small title bar
122@li wxPopupWindow: A toplevel window without decorations, e.g. for a combobox pop-up
123@li wxPropertySheetDialog: Property sheet dialog
124@li wxSplashScreen: Splash screen class
125@li wxTipWindow: Shows text in a small window
126@li wxWizard: A wizard dialog
127
128
129
130@section page_class_cat_menus Menus
131
132@li wxMenu: Displays a series of menu items for selection
133@li wxMenuBar: Contains a series of menus for use with a frame
134@li wxMenuItem: Represents a single menu item
29f86fc1
BP
135
136
137
138@section page_class_cat_ctrl Controls
139
140Typically, these are small windows which provide interaction with the user.
141Controls that are not static can have wxValidator associated with them.
142
143@li wxAnimationCtrl: A control to display an animation
144@li wxControl: The base class for controls
29f86fc1
BP
145@li wxBitmapButton: Push button control, displaying a bitmap
146@li wxBitmapComboBox: A combobox with bitmaps next to text items
29f86fc1 147@li wxBitmapToggleButton: A toggle button with bitmaps.
f9736c27 148@li wxButton: Push button control, displaying text
29f86fc1
BP
149@li wxCalendarCtrl: Control showing an entire calendar month
150@li wxCheckBox: Checkbox control
151@li wxCheckListBox: A listbox with a checkbox to the left of each item
152@li wxChoice: Choice control (a combobox without the editable area)
153@li wxCollapsiblePane: A panel which can be shown/hidden by the user
154@li wxComboBox: A choice with an editable area
155@li wxComboCtrl: A combobox with application defined popup
bb94502f
RR
156@li wxDataViewCtrl: A control to display tabular or tree like data
157@li wxDataViewTreeCtrl: A specialized wxDataViewCtrl with a wxTreeCtrl-like API
d23914f8 158@li wxEditableListBox: A listbox with editable items.
29f86fc1
BP
159@li wxGauge: A control to represent a varying quantity, such as time remaining
160@li wxGenericDirCtrl: A control for displaying a directory tree
c7d4ca81 161@li wxGrid: A control to display spread-sheet like data in tabular form
29f86fc1
BP
162@li wxHtmlListBox: An abstract class for creating listboxes showing HTML
163 content
f9736c27 164@li wxHyperlinkCtrl: A static text which opens an URL when clicked
29f86fc1
BP
165@li wxListBox: A list of strings for single or multiple selection
166@li wxListCtrl: A control for displaying lists of strings and/or icons, plus a
167 multicolumn report view
168@li wxListView: A simpler interface (fa&ccedil;ade) for wxListCtrl in report
169 mode
d23914f8 170@li wxNotebook: A notebook class
29f86fc1 171@li wxOwnerDrawnComboBox: A combobox with owner-drawn list items
c7d4ca81 172@li wxPropertyGrid: A complex control to display hierachical, editable information
f9736c27
RR
173@li wxRadioBox: A group of radio buttons
174@li wxRadioButton: A round button to be used with others in a mutually
175 exclusive way
29f86fc1 176@li wxRichTextCtrl: Generic rich text editing control
f9736c27
RR
177@li wxSimpleHtmlListBox: A listbox showing HTML content
178@li wxStaticBox: A static, or group box for visually grouping related controls
29f86fc1 179@li wxScrollBar: Scrollbar control
bb94502f 180@li wxSearchCtrl: A text input control used to initiate a search
29f86fc1 181@li wxSpinButton: A spin or `up-down' control
42561c3c
VZ
182@li wxSpinCtrl: A spin control - i.e. spin button and text control displaying
183 an integer
184@li wxSpinCtrlDouble: A spin control - i.e. spin button and text control displaying
185 a real number
29f86fc1 186@li wxStaticText: One or more lines of non-editable text
f9736c27
RR
187@li wxTextCtrl: Single or multiline text editing control
188@li wxToggleButton: A button which stays pressed when clicked by user.
189@li wxTreeCtrl: Tree (hierarchy) control
29f86fc1 190@li wxStaticBitmap: A control to display a bitmap
1694177e
RR
191@li wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code
192 editing component for plain text editing.
29f86fc1
BP
193@li wxSlider: A slider that can be dragged by the user
194@li wxVListBox: A listbox supporting variable height rows
195
196
197
c7d4ca81
RR
198@section page_class_cat_validator Validators
199
200These are the window validators, used for filtering and validating user input.
201
202Related Overviews: @ref overview_validator
203
204@li wxValidator: Base validator class
205@li wxTextValidator: Text control validator class
206@li wxGenericValidator: Generic control validator class
207
208
209
29f86fc1
BP
210@section page_class_cat_pickers Picker Controls
211
212A picker control is a control whose appearance and behaviour is highly
213platform-dependent.
214
215@li wxColourPickerCtrl: A control which allows the user to choose a colour
216@li wxDirPickerCtrl: A control which allows the user to choose a directory
217@li wxFilePickerCtrl: A control which allows the user to choose a file
218@li wxFontPickerCtrl: A control which allows the user to choose a font
219@li wxDatePickerCtrl: Small date picker control
220
221
222
557563c8 223@section page_class_cat_miscwnd Miscellaneous Windows
29f86fc1 224
557563c8
RR
225The following are a variety of classes that are derived from wxWindow.
226
d23914f8 227@li wxCollapsiblePane: A panel which can be shown/hidden by the user
557563c8 228@li wxPanel: A window whose colour changes according to current user settings
f09b5681
BP
229@li ::wxScrolledWindow: Window with automatically managed scrollbars (see
230 wxScrolled)
231@li wxHScrolledWindow: As ::wxScrolledWindow but supports columns of variable
232 widths
233@li wxVScrolledWindow: As ::wxScrolledWindow but supports rows of variable
234 heights
235@li wxHVScrolledWindow: As ::wxScrolledWindow but supports scroll units of
236 variable sizes.
557563c8
RR
237@li wxGrid: A grid (table) window
238@li wxSplitterWindow: Window which can be split vertically or horizontally
239@li wxStatusBar: Implements the status bar on a frame
240@li wxToolBar: Toolbar class
241@li wxNotebook: Notebook class
242@li wxListbook: Similar to notebook but using list control
243@li wxChoicebook: Similar to notebook but using choice control
244@li wxTreebook: Similar to notebook but using tree control
245@li wxSashWindow: Window with four optional sashes that can be dragged
246@li wxSashLayoutWindow: Window that can be involved in an IDE-like layout
247 arrangement
557563c8
RR
248@li wxWizardPage: A base class for the page in wizard dialog.
249@li wxWizardPageSimple: A page in wizard dialog.
250
251
252
253@section page_class_cat_aui Window Docking (wxAUI)
254
255wxAUI is a set classes for writing a customizable application interface
256with built-in docking, floatable panes and a flexible MDI-like interface.
257
258Related Overviews: @ref overview_aui
259
260@li wxAuiManager: The central class for managing the interface
261@li wxAuiNotebook: A replacement notebook class with extra features
262@li wxAuiPaneInfo: Describes a single pane
263@li wxAuiDockArt: Art and metrics provider for customizing the docking user
264 interface
265@li wxAuiTabArt: Art and metrics provider for customizing the notebook user
266 interface
267
268
269
270@section page_class_cat_cmndlg Common Dialogs
271
272Common dialogs are ready-made dialog classes which are frequently used in an
273application.
274
275Related Overviews: @ref overview_cmndlg
276
277@li wxDialog: Base class for common dialogs
278@li wxColourDialog: Colour chooser dialog
279@li wxDirDialog: Directory selector dialog
280@li wxFileDialog: File selector dialog
281@li wxFindReplaceDialog: Text search/replace dialog
282@li wxMultiChoiceDialog: Dialog to get one or more selections from a list
283@li wxSingleChoiceDialog: Dialog to get a single selection from a list and
284 return the string
285@li wxTextEntryDialog: Dialog to get a single line of text from the user
286@li wxPasswordEntryDialog: Dialog to get a password from the user
287@li wxFontDialog: Font chooser dialog
288@li wxPageSetupDialog: Standard page setup dialog
289@li wxPrintDialog: Standard print dialog
290@li wxProgressDialog: Progress indication dialog
291@li wxMessageDialog: Simple message box dialog
292@li wxSymbolPickerDialog: Symbol selector dialog
293@li wxRichTextFormattingDialog: A dialog for formatting the content of a
294 wxRichTextCtrl
295@li wxWizard: A wizard dialog.
296
297
298
299@section page_class_cat_html HTML
300
301wxWidgets provides a set of classes to display text in HTML format. These
302classes include a help system based on the HTML widget.
303
304@li wxHtmlHelpController: HTML help controller class
305@li wxHtmlWindow: HTML window class
306@li wxHtmlEasyPrinting: Simple class for printing HTML
307@li wxHtmlPrintout: Generic HTML wxPrintout class
308@li wxHtmlParser: Generic HTML parser class
309@li wxHtmlTagHandler: HTML tag handler, pluginable into wxHtmlParser
310@li wxHtmlWinParser: HTML parser class for wxHtmlWindow
311@li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser
312
313
29f86fc1
BP
314@section page_class_cat_dc Device Contexts
315
316Device contexts are surfaces that may be drawn on, and provide an abstraction
317that allows parameterisation of your drawing code by passing different device
318contexts.
319
320Related Overviews: @ref overview_dc
321
322@li wxAutoBufferedPaintDC: A helper device context for double buffered drawing
323 inside @b OnPaint().
324@li wxBufferedDC: A helper device context for double buffered drawing.
325@li wxBufferedPaintDC: A helper device context for double buffered drawing
326 inside @b OnPaint().
327@li wxClientDC: A device context to access the client area outside
328 @b OnPaint() events
329@li wxPaintDC: A device context to access the client area inside @b OnPaint()
330 events
331@li wxWindowDC: A device context to access the non-client area
332@li wxScreenDC: A device context to access the entire screen
333@li wxDC: The device context base class
334@li wxMemoryDC: A device context for drawing into bitmaps
335@li wxMetafileDC: A device context for drawing into metafiles
336@li wxMirrorDC: A proxy device context allowing for simple mirroring.
337@li wxPostScriptDC: A device context for drawing into PostScript files
338@li wxPrinterDC: A device context for drawing to printers
339
340
341
28792a70
RR
342@section page_class_cat_gc Graphics Context classes
343
344These classes are related to drawing using a new vector based drawing API and
345are based on the modern drawing backend GDI+, CoreGraphics and Cairo.
346
347@li wxGraphicsRenderer: Represents a drawing engine.
348@li wxGraphicsContext: Represents a graphics context currently being drawn on.
349@li wxGraphicsBrush: Brush for drawing into a wxGraphicsContext
350@li wxGraphicsPen: Pen for drawing into a wxGraphicsContext
351@li wxGraphicsFont: Font for drawing text on a wxGraphicsContext
352@li wxGraphicsMatrix: Represents an affine matrix for drawing transformation
4c7b80fb 353@li wxGraphicsPath: Represents a path for drawing
28792a70
RR
354
355
356
29f86fc1
BP
357@section page_class_cat_gdi Graphics Device Interface
358
359These classes are related to drawing on device contexts and windows.
360
29f86fc1
BP
361@li wxColour: Represents the red, blue and green elements of a colour
362@li wxDCClipper: Wraps the operations of setting and destroying the clipping
363 region
29f86fc1
BP
364@li wxBrush: Used for filling areas on a device context
365@li wxBrushList: The list of previously-created brushes
29f86fc1
BP
366@li wxFont: Represents fonts
367@li wxFontList: The list of previously-created fonts
29f86fc1
BP
368@li wxPen: Used for drawing lines on a device context
369@li wxPenList: The list of previously-created pens
370@li wxPalette: Represents a table of indices into RGB values
371@li wxRegion: Represents a simple or complex region on a window or device
372 context
29f86fc1
BP
373@li wxRendererNative: Abstracts high-level drawing primitives
374
375
376
28792a70
RR
377@section page_class_cat_image Image and bitmap classes
378
379These classes represent images and bitmap in various formats and ways
380to access and create them.
381
382Related Overviews: @ref overview_bitmap
383
384@li wxAnimation: Represents an animation
385@li wxBitmap: Represents a platform dependent bitmap
386@li wxBitmapHandler: Class for loading a saving a wxBitmap in a specific format
387@li wxCursor: A small, transparent bitmap representing the cursor
388@li wxIcon: A small, transparent bitmap for assigning to frames and drawing on
389 device contexts
390@li wxImage: A platform-independent image class
391@li wxImageHandler: Class for loading a saving a wxImage in a specific format
392@li wxImageList: A list of images, used with some controls
393@li wxMask: Represents a mask to be used with a bitmap for transparent drawing
394@li wxMemoryDC: A device context for drawing into bitmaps
395@li wxPixelData: Class template for direct access to wxBitmap's and wxImage's internal data
396
397
398
29f86fc1
BP
399@section page_class_cat_events Events
400
401An event object contains information about a specific event. Event handlers
402(usually member functions) have a single, event argument.
403
404Related Overviews: @ref overview_eventhandling
405
406@li wxActivateEvent: A window or application activation event
407@li wxCalendarEvent: Used with wxCalendarCtrl
408@li wxCalculateLayoutEvent: Used to calculate window layout
409@li wxChildFocusEvent: A child window focus event
410@li wxClipboardTextEvent: A clipboard copy/cut/paste treebook event event
411@li wxCloseEvent: A close window or end session event
412@li wxCommandEvent: An event from a variety of standard controls
413@li wxContextMenuEvent: An event generated when the user issues a context menu
414 command
415@li wxDateEvent: Used with wxDatePickerCtrl
416@li wxDialUpEvent: Event send by wxDialUpManager
417@li wxDropFilesEvent: A drop files event
418@li wxEraseEvent: An erase background event
419@li wxEvent: The event base class
420@li wxFindDialogEvent: Event sent by wxFindReplaceDialog
421@li wxFocusEvent: A window focus event
422@li wxKeyEvent: A keypress event
423@li wxIconizeEvent: An iconize/restore event
424@li wxIdleEvent: An idle event
425@li wxInitDialogEvent: A dialog initialisation event
426@li wxJoystickEvent: A joystick event
427@li wxListEvent: A list control event
428@li wxMaximizeEvent: A maximize event
429@li wxMenuEvent: A menu event
430@li wxMouseCaptureChangedEvent: A mouse capture changed event
431@li wxMouseCaptureLostEvent: A mouse capture lost event
432@li wxMouseEvent: A mouse event
433@li wxMoveEvent: A move event
434@li wxNavigationKeyEvent: An event set by navigation keys such as tab
435@li wxNotebookEvent: A notebook control event
436@li wxNotifyEvent: A notification event, which can be vetoed
437@li wxPaintEvent: A paint event
438@li wxProcessEvent: A process ending event
439@li wxQueryLayoutInfoEvent: Used to query layout information
440@li wxRichTextEvent: A rich text editing event
441@li wxScrollEvent: A scroll event from sliders, stand-alone scrollbars and spin
442 buttons
443@li wxScrollWinEvent: A scroll event from scrolled windows
444@li wxSizeEvent: A size event
445@li wxSocketEvent: A socket event
446@li wxSpinEvent: An event from wxSpinButton
447@li wxSplitterEvent: An event from wxSplitterWindow
448@li wxSysColourChangedEvent: A system colour change event
449@li wxTimerEvent: A timer expiration event
450@li wxTreebookEvent: A treebook control event
451@li wxTreeEvent: A tree control event
452@li wxUpdateUIEvent: A user interface update event
453@li wxWindowCreateEvent: A window creation event
454@li wxWindowDestroyEvent: A window destruction event
455@li wxWizardEvent: A wizard event
456
457
458
7ac7b533 459@section page_class_cat_appmanagement Application and Process Management
29f86fc1 460
7ac7b533 461@li wxApp: Application class
29f86fc1 462@li wxCmdLineParser: Command line parser class
09ad05fa 463@li wxDynamicLibrary: Class to work with shared libraries.
7ac7b533 464@li wxProcess: Process class
29f86fc1
BP
465
466
467
7ac7b533 468@section page_class_cat_printing Printing Framework
29f86fc1 469
7ac7b533
RR
470A printing and previewing framework is implemented to make it relatively
471straightforward to provide document printing facilities.
29f86fc1 472
7ac7b533 473Related Overviews: @ref overview_printing
29f86fc1 474
7ac7b533
RR
475@li wxPreviewFrame: Frame for displaying a print preview
476@li wxPreviewCanvas: Canvas for displaying a print preview
477@li wxPreviewControlBar: Standard control bar for a print preview
478@li wxPrintDialog: Standard print dialog
479@li wxPageSetupDialog: Standard page setup dialog
480@li wxPrinter: Class representing the printer
481@li wxPrinterDC: Printer device context
482@li wxPrintout: Class representing a particular printout
483@li wxPrintPreview: Class representing a print preview
484@li wxPrintData: Represents information about the document being printed
485@li wxPrintDialogData: Represents information about the print dialog
486@li wxPageSetupDialogData: Represents information about the page setup dialog
29f86fc1
BP
487
488
489
7ac7b533 490@section page_class_cat_dvf Document/View Framework
29f86fc1 491
7ac7b533
RR
492wxWidgets supports a document/view framework which provides housekeeping for a
493document-centric application.
29f86fc1 494
7ac7b533 495Related Overviews: @ref overview_docview
29f86fc1 496
7ac7b533
RR
497@li wxCommand: Base class for undo/redo actions
498@li wxCommandProcessor: Maintains the undo/redo stack
499@li wxDocument: Represents a document
500@li wxView: Represents a view
501@li wxDocTemplate: Manages the relationship between a document class and a
502 view class
503@li wxDocManager: Manages the documents and views in an application
504@li wxDocChildFrame: A child frame for showing a document view
505@li wxDocParentFrame: A parent frame to contain views
506@li wxDocMDIChildFrame: An MDI child frame for showing a document view
507@li wxDocMDIParentFrame: An MDI parent frame to contain views
508@li wxFileHistory: Maintains a list of the most recently visited files
29f86fc1
BP
509
510
29f86fc1 511
7ac7b533 512@section page_class_cat_dnd Clipboard and Drag & Drop
29f86fc1 513
7ac7b533 514Related Overviews: @ref overview_dnd
29f86fc1 515
7ac7b533
RR
516@li wxDataObject: Data object class
517@li wxDataFormat: Represents a data format
518@li wxTextDataObject: Text data object class
519@li wxFileDataObject: File data object class
520@li wxBitmapDataObject: Bitmap data object class
521@li wxURLDataObject: URL data object class
522@li wxCustomDataObject: Custom data object class
523@li wxClipboard: Clipboard class
524@li wxDropTarget: Drop target class
525@li wxFileDropTarget: File drop target class
526@li wxTextDropTarget: Text drop target class
527@li wxDropSource: Drop source class
29f86fc1 528
7ac7b533
RR
529
530
531@section page_class_cat_vfs Virtual File System
532
533wxWidgets provides a set of classes that implement an extensible virtual file
534system, used internally by the HTML classes.
535
536@li wxFSFile: Represents a file in the virtual file system
537@li wxFileSystem: Main interface for the virtual file system
538@li wxFileSystemHandler: Class used to announce file system type
539
540
541
c7d4ca81
RR
542@section page_class_cat_threading Threading
543
544wxWidgets provides a set of classes to make use of the native thread
545capabilities of the various platforms.
546
547Related Overviews: @ref overview_thread
548
549@li wxThread: Thread class
550@li wxThreadHelper: Manages background threads easily
551@li wxMutex: Mutex class
552@li wxMutexLocker: Mutex locker utility class
553@li wxCriticalSection: Critical section class
554@li wxCriticalSectionLocker: Critical section locker utility class
555@li wxCondition: Condition class
556@li wxSemaphore: Semaphore class
557
558
559
7ac7b533
RR
560@section page_class_cat_rtti Runtime Type Information (RTTI)
561
562wxWidgets supports runtime manipulation of class information, and dynamic
563creation of objects given class names.
564
565Related Overviews: @ref overview_rtti
566
567@see @ref group_funcmacro_rtti "RTTI Functions and Macros"
568
569@li wxClassInfo: Holds runtime class information
570@li wxObject: Root class for classes with runtime information
29f86fc1
BP
571
572
573
574@section page_class_cat_debugging Debugging
575
576wxWidgets supports some aspects of debugging an application through classes,
577functions and macros.
578
579Related Overviews: @ref overview_debugging
580
581@see @ref group_funcmacro_debug "Debugging Functions and Macros"
582
583@li wxDebugContext: Provides memory-checking facilities
584@li wxDebugReport: Base class for creating debug reports in case of a program
585 crash.
586@li wxDebugReportCompress: Class for creating compressed debug reports.
587@li wxDebugReportUpload: Class for uploading compressed debug reports via HTTP.
588@li wxDebugReportPreview: Abstract base class for previewing the contents of a
589 debug report.
590@li wxDebugReportPreviewStd: Standard implementation of wxDebugReportPreview.
591
592
593
7ac7b533 594@section page_class_cat_logging Logging
29f86fc1 595
7ac7b533 596wxWidgets provides several classes and functions for message logging.
29f86fc1 597
7ac7b533 598Related Overviews: @ref overview_log
29f86fc1 599
7ac7b533 600@see @ref group_funcmacro_log "Logging Functions and Macros"
29f86fc1 601
7ac7b533
RR
602@li wxLog: The base log class
603@li wxLogStderr: Log messages to a C STDIO stream
604@li wxLogStream: Log messages to a C++ iostream
605@li wxLogTextCtrl: Log messages to a wxTextCtrl
606@li wxLogWindow: Log messages to a log frame
607@li wxLogGui: Default log target for GUI programs
608@li wxLogNull: Temporarily suppress message logging
609@li wxLogChain: Allows to chain two log targets
610@li wxLogInterposer: Allows to filter the log messages
611@li wxLogInterposerTemp: Allows to filter the log messages
612@li wxStreamToTextRedirector: Allows to redirect output sent to @c cout to a wxTextCtrl
29f86fc1 613
29f86fc1 614
29f86fc1 615
7ac7b533 616@section page_class_cat_data Data Structures
29f86fc1 617
7ac7b533 618These are the data structure classes supported by wxWidgets.
29f86fc1 619
7ac7b533
RR
620@li wxCmdLineParser: Command line parser class
621@li wxDateSpan: A logical time interval.
622@li wxDateTime: A class for date/time manipulations
623@li wxLongLong: A portable 64 bit integer type
624@li wxObject: The root class for most wxWidgets classes
625@li wxPathList: A class to help search multiple paths
626@li wxPoint: Representation of a point
627@li wxRect: A class representing a rectangle
628@li wxRegEx: Regular expression support
629@li wxRegion: A class representing a region
630@li wxString: A string class
631@li wxStringTokenizer: A class for interpreting a string as a list of tokens or
632 words
633@li wxRealPoint: Representation of a point using floating point numbers
634@li wxSize: Representation of a size
635@li wxTimeSpan: A time interval.
636@li wxURI: Represents a Uniform Resource Identifier
637@li wxVariant: A class for storing arbitrary types that may change at run-time
29f86fc1
BP
638
639
640
79b40dcf
VZ
641@section page_class_cat_conv Text Conversion
642
643These classes define objects for performing conversions between different
644multibyte and Unicode encodings and wide character strings.
645
646@li wxMBConv: Base class for all convertors, defines the API implemented by all
647 the other convertor classes.
648@li wxMBConvUTF7: Convertor for UTF-7
649@li wxMBConvUTF8: Convertor for UTF-8
650@li wxMBConvUTF16: Convertor for UTF-16
651@li wxMBConvUTF32: Convertor for UTF-32
652@li wxCSConv: Convertor for any system-supported encoding which can be
653 specified by name.
654
655Related Overviews: @ref overview_mbconv
656
657
7ac7b533 658@section page_class_cat_containers Containers
29f86fc1 659
7ac7b533
RR
660These are classes, templates and class macros are used by wxWidgets. Most of
661these classes provide a subset or almost complete STL API.
29f86fc1 662
7ac7b533 663Related Overviews: @ref overview_container
29f86fc1 664
7ac7b533
RR
665@li wxArray<T>: A type-safe dynamic array implementation (macro based)
666@li wxArrayString: An efficient container for storing wxString objects
667@li wxHashMap<T>: A type-safe hash map implementation (macro based)
668@li wxHashSet<T>: A type-safe hash set implementation(macro based)
669@li wxHashTable: A simple hash table implementation (deprecated, use wxHashMap)
670@li wxList<T>: A type-safe linked list implementation (macro based)
671@li wxVector<T>: Template base vector implementation identical to std::vector
29f86fc1
BP
672
673
674
7ac7b533 675@section page_class_cat_smartpointers Smart Pointers
29f86fc1 676
7ac7b533 677wxWidgets provides a few smart pointer class templates.
29f86fc1 678
7ac7b533
RR
679@li wxObjectDataPtr<T>: A shared pointer (using intrusive reference counting)
680@li wxScopedPtr<T>: A scoped pointer
681@li wxSharedPtr<T>: A shared pointer (using non-intrusive reference counting)
682@li wxWeakRef<T>: A weak reference
29f86fc1
BP
683
684
685
686@section page_class_cat_file File Handling
687
688wxWidgets has several small classes to work with disk files and directories.
689
690Related Overviews: @ref overview_file
691
692@li wxFileName: Operations with the file name and attributes
693@li wxDir: Class for enumerating files/subdirectories.
694@li wxDirTraverser: Class used together with wxDir for recursively enumerating
695 the files/subdirectories
696@li wxFile: Low-level file input/output class.
697@li wxFFile: Another low-level file input/output class.
698@li wxTempFile: Class to safely replace an existing file
699@li wxTextFile: Class for working with text files as with arrays of lines
700@li wxStandardPaths: Paths for standard directories
701@li wxPathList: A class to help search multiple paths
702
703
704
29f86fc1
BP
705@section page_class_cat_streams Streams
706
707wxWidgets has its own set of stream classes, as an alternative to often buggy
708standard stream libraries, and to provide enhanced functionality.
709
710@li wxStreamBase: Stream base class
711@li wxStreamBuffer: Stream buffer class
712@li wxInputStream: Input stream class
713@li wxOutputStream: Output stream class
714@li wxCountingOutputStream: Stream class for querying what size a stream would
715 have.
716@li wxFilterInputStream: Filtered input stream class
717@li wxFilterOutputStream: Filtered output stream class
718@li wxBufferedInputStream: Buffered input stream class
719@li wxBufferedOutputStream: Buffered output stream class
720@li wxMemoryInputStream: Memory input stream class
721@li wxMemoryOutputStream: Memory output stream class
722@li wxDataInputStream: Platform-independent binary data input stream class
723@li wxDataOutputStream: Platform-independent binary data output stream class
724@li wxTextInputStream: Platform-independent text data input stream class
725@li wxTextOutputStream: Platform-independent text data output stream class
726@li wxFileInputStream: File input stream class
727@li wxFileOutputStream: File output stream class
728@li wxFFileInputStream: Another file input stream class
729@li wxFFileOutputStream: Another file output stream class
730@li wxTempFileOutputStream: Stream to safely replace an existing file
731@li wxStringInputStream: String input stream class
732@li wxStringOutputStream: String output stream class
733@li wxZlibInputStream: Zlib and gzip (compression) input stream class
734@li wxZlibOutputStream: Zlib and gzip (compression) output stream class
735@li wxZipInputStream: Input stream for reading from ZIP archives
736@li wxZipOutputStream: Output stream for writing from ZIP archives
737@li wxTarInputStream: Input stream for reading from tar archives
738@li wxTarOutputStream: Output stream for writing from tar archives
739@li wxSocketInputStream: Socket input stream class
740@li wxSocketOutputStream: Socket output stream class
741
742
743
7ac7b533 744@section page_class_cat_xml XML
29f86fc1 745
7ac7b533
RR
746@li wxXmlDocument: A class to parse XML files
747@li wxXmlNode: A class which represents XML nodes
748@li wxXmlAttribute: A class which represent an XML attribute
29f86fc1 749
29f86fc1 750
29f86fc1 751
7ac7b533 752@section page_class_cat_archive Archive
29f86fc1 753
7ac7b533
RR
754@li wxArchiveInputStream
755@li wxArchiveOutputStream
756@li wxArchiveEntry
29f86fc1 757
29f86fc1 758
29f86fc1 759
1c9ac9a8
RR
760@section page_class_cat_xrc XML Based Resource System (XRC)
761
762Resources allow your application to create controls and other user interface
763elements from specifications stored in an XML format.
764
765Related Overviews: @ref overview_xrc
766
767@li wxXmlResource: The main class for working with resources
768@li wxXmlResourceHandler: The base class for XML resource handlers
769
770
29f86fc1 771
7ac7b533 772@section page_class_cat_net Networking
29f86fc1 773
7ac7b533 774wxWidgets provides its own classes for socket based networking.
29f86fc1 775
7ac7b533
RR
776@li wxDialUpManager: Provides functions to check the status of network
777 connection and to establish one
778@li wxIPV4address: Represents an Internet address
779@li wxIPaddress: Represents an Internet address
780@li wxSocketBase: Represents a socket base object
781@li wxSocketClient: Represents a socket client
782@li wxSocketServer: Represents a socket server
783@li wxSocketEvent: A socket event
784@li wxFTP: FTP protocol class
785@li wxHTTP: HTTP protocol class
786@li wxURL: Represents a Universal Resource Locator
29f86fc1
BP
787
788
29f86fc1 789
7ac7b533 790@section page_class_cat_ipc Interprocess Communication
29f86fc1 791
7ac7b533
RR
792wxWidgets provides simple interprocess communications facilities based on
793Windows DDE, but available on most platforms using TCP.
794
795Related Overviews: @ref overview_ipc
796
797@li wxClient, wxDDEClient: Represents a client
798@li wxConnection, wxDDEConnection: Represents the connection between a client
799 and a server
800@li wxServer, wxDDEServer: Represents a server
29f86fc1
BP
801
802
29f86fc1 803
29f86fc1
BP
804@section page_class_cat_help Help
805
806@li wxHelpController: Family of classes for controlling help windows
807@li wxHtmlHelpController: HTML help controller class
808@li wxContextHelp: Class to put application into context-sensitive help mode
809@li wxContextHelpButton: Button class for putting application into
810 context-sensitive help mode
811@li wxHelpProvider: Abstract class for context-sensitive help provision
812@li wxSimpleHelpProvider: Class for simple context-sensitive help provision
813@li wxHelpControllerHelpProvider: Class for context-sensitive help provision
814 via a help controller
815@li wxToolTip: Class implementing tooltips
816
817
818
819@section page_class_cat_media Multimedia
820
821@li wxMediaCtrl: Display multimedia contents.
822
823
824
825@section page_class_cat_gl OpenGL
826
827@li wxGLCanvas: Canvas that you can render OpenGL calls to.
828@li wxGLContext: Class to ease sharing of OpenGL data resources.
829
830
831
29f86fc1
BP
832@section page_class_cat_misc Miscellaneous
833
834@li wxCaret: A caret (cursor) object
835@li wxConfigBase: Classes for reading/writing the configuration settings
836@li wxTimer: Timer class
837@li wxStopWatch: Stop watch class
838@li wxMimeTypesManager: MIME-types manager class
839@li wxSystemSettings: System settings class for obtaining various global
840 parameters
841@li wxSystemOptions: System options class for run-time configuration
842@li wxAcceleratorTable: Accelerator table
843@li wxAutomationObject: OLE automation class
844@li wxFontMapper: Font mapping, finding suitable font for given encoding
845@li wxEncodingConverter: Encoding conversions
846@li wxCalendarDateAttr: Used with wxCalendarCtrl
847@li wxQuantize: Class to perform quantization, or colour reduction
848@li wxSingleInstanceChecker: Check that only single program instance is running
849
850*/
851