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