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