document wxSpinCtrlDouble (#9834)
[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 </td><td>
54 @li @ref page_class_cat_xrc
55 @li @ref page_class_cat_net
56 @li @ref page_class_cat_archive
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 displaying
178 an integer
179 @li wxSpinCtrlDouble: A spin control - i.e. spin button and text control displaying
180 a real number
181 @li wxStaticText: One or more lines of non-editable text
182 @li wxHyperlinkCtrl: A static text which opens an URL when clicked
183 @li wxStaticBitmap: A control to display a bitmap
184 @li wxRadioBox: A group of radio buttons
185 @li wxRadioButton: A round button to be used with others in a mutually
186 exclusive way
187 @li wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code
188 editing component for plain text editing.
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 @section page_class_cat_dc Device Contexts
326
327 Device contexts are surfaces that may be drawn on, and provide an abstraction
328 that allows parameterisation of your drawing code by passing different device
329 contexts.
330
331 Related Overviews: @ref overview_dc
332
333 @li wxAutoBufferedPaintDC: A helper device context for double buffered drawing
334 inside @b OnPaint().
335 @li wxBufferedDC: A helper device context for double buffered drawing.
336 @li wxBufferedPaintDC: A helper device context for double buffered drawing
337 inside @b OnPaint().
338 @li wxClientDC: A device context to access the client area outside
339 @b OnPaint() events
340 @li wxPaintDC: A device context to access the client area inside @b OnPaint()
341 events
342 @li wxWindowDC: A device context to access the non-client area
343 @li wxScreenDC: A device context to access the entire screen
344 @li wxDC: The device context base class
345 @li wxMemoryDC: A device context for drawing into bitmaps
346 @li wxMetafileDC: A device context for drawing into metafiles
347 @li wxMirrorDC: A proxy device context allowing for simple mirroring.
348 @li wxPostScriptDC: A device context for drawing into PostScript files
349 @li wxPrinterDC: A device context for drawing to printers
350
351
352
353 @section page_class_cat_gc Graphics Context classes
354
355 These classes are related to drawing using a new vector based drawing API and
356 are based on the modern drawing backend GDI+, CoreGraphics and Cairo.
357
358 @li wxGraphicsRenderer: Represents a drawing engine.
359 @li wxGraphicsContext: Represents a graphics context currently being drawn on.
360 @li wxGraphicsBrush: Brush for drawing into a wxGraphicsContext
361 @li wxGraphicsPen: Pen for drawing into a wxGraphicsContext
362 @li wxGraphicsFont: Font for drawing text on a wxGraphicsContext
363 @li wxGraphicsMatrix: Represents an affine matrix for drawing transformation
364 @li wxGraphicsPath: Represents a path for drawing
365
366
367
368 @section page_class_cat_gdi Graphics Device Interface
369
370 These classes are related to drawing on device contexts and windows.
371
372 @li wxColour: Represents the red, blue and green elements of a colour
373 @li wxDCClipper: Wraps the operations of setting and destroying the clipping
374 region
375 @li wxBrush: Used for filling areas on a device context
376 @li wxBrushList: The list of previously-created brushes
377 @li wxFont: Represents fonts
378 @li wxFontList: The list of previously-created fonts
379 @li wxPen: Used for drawing lines on a device context
380 @li wxPenList: The list of previously-created pens
381 @li wxPalette: Represents a table of indices into RGB values
382 @li wxRegion: Represents a simple or complex region on a window or device
383 context
384 @li wxRendererNative: Abstracts high-level drawing primitives
385
386
387
388 @section page_class_cat_image Image and bitmap classes
389
390 These classes represent images and bitmap in various formats and ways
391 to access and create them.
392
393 Related Overviews: @ref overview_bitmap
394
395 @li wxAnimation: Represents an animation
396 @li wxBitmap: Represents a platform dependent bitmap
397 @li wxBitmapHandler: Class for loading a saving a wxBitmap in a specific format
398 @li wxCursor: A small, transparent bitmap representing the cursor
399 @li wxIcon: A small, transparent bitmap for assigning to frames and drawing on
400 device contexts
401 @li wxImage: A platform-independent image class
402 @li wxImageHandler: Class for loading a saving a wxImage in a specific format
403 @li wxImageList: A list of images, used with some controls
404 @li wxMask: Represents a mask to be used with a bitmap for transparent drawing
405 @li wxMemoryDC: A device context for drawing into bitmaps
406 @li wxPixelData: Class template for direct access to wxBitmap's and wxImage's internal data
407
408
409
410 @section page_class_cat_events Events
411
412 An event object contains information about a specific event. Event handlers
413 (usually member functions) have a single, event argument.
414
415 Related Overviews: @ref overview_eventhandling
416
417 @li wxActivateEvent: A window or application activation event
418 @li wxCalendarEvent: Used with wxCalendarCtrl
419 @li wxCalculateLayoutEvent: Used to calculate window layout
420 @li wxChildFocusEvent: A child window focus event
421 @li wxClipboardTextEvent: A clipboard copy/cut/paste treebook event event
422 @li wxCloseEvent: A close window or end session event
423 @li wxCommandEvent: An event from a variety of standard controls
424 @li wxContextMenuEvent: An event generated when the user issues a context menu
425 command
426 @li wxDateEvent: Used with wxDatePickerCtrl
427 @li wxDialUpEvent: Event send by wxDialUpManager
428 @li wxDropFilesEvent: A drop files event
429 @li wxEraseEvent: An erase background event
430 @li wxEvent: The event base class
431 @li wxFindDialogEvent: Event sent by wxFindReplaceDialog
432 @li wxFocusEvent: A window focus event
433 @li wxKeyEvent: A keypress event
434 @li wxIconizeEvent: An iconize/restore event
435 @li wxIdleEvent: An idle event
436 @li wxInitDialogEvent: A dialog initialisation event
437 @li wxJoystickEvent: A joystick event
438 @li wxListEvent: A list control event
439 @li wxMaximizeEvent: A maximize event
440 @li wxMenuEvent: A menu event
441 @li wxMouseCaptureChangedEvent: A mouse capture changed event
442 @li wxMouseCaptureLostEvent: A mouse capture lost event
443 @li wxMouseEvent: A mouse event
444 @li wxMoveEvent: A move event
445 @li wxNavigationKeyEvent: An event set by navigation keys such as tab
446 @li wxNotebookEvent: A notebook control event
447 @li wxNotifyEvent: A notification event, which can be vetoed
448 @li wxPaintEvent: A paint event
449 @li wxProcessEvent: A process ending event
450 @li wxQueryLayoutInfoEvent: Used to query layout information
451 @li wxRichTextEvent: A rich text editing event
452 @li wxScrollEvent: A scroll event from sliders, stand-alone scrollbars and spin
453 buttons
454 @li wxScrollWinEvent: A scroll event from scrolled windows
455 @li wxSizeEvent: A size event
456 @li wxSocketEvent: A socket event
457 @li wxSpinEvent: An event from wxSpinButton
458 @li wxSplitterEvent: An event from wxSplitterWindow
459 @li wxSysColourChangedEvent: A system colour change event
460 @li wxTimerEvent: A timer expiration event
461 @li wxTreebookEvent: A treebook control event
462 @li wxTreeEvent: A tree control event
463 @li wxUpdateUIEvent: A user interface update event
464 @li wxWindowCreateEvent: A window creation event
465 @li wxWindowDestroyEvent: A window destruction event
466 @li wxWizardEvent: A wizard event
467
468
469
470 @section page_class_cat_validator Validators
471
472 These are the window validators, used for filtering and validating user input.
473
474 Related Overviews: @ref overview_validator
475
476 @li wxValidator: Base validator class
477 @li wxTextValidator: Text control validator class
478 @li wxGenericValidator: Generic control validator class
479
480
481
482 @section page_class_cat_appmanagement Application and Process Management
483
484 @li wxApp: Application class
485 @li wxCmdLineParser: Command line parser class
486 @li wxDynamicLibrary: Class to work with shared libraries.
487 @li wxProcess: Process class
488
489
490
491 @section page_class_cat_printing Printing Framework
492
493 A printing and previewing framework is implemented to make it relatively
494 straightforward to provide document printing facilities.
495
496 Related Overviews: @ref overview_printing
497
498 @li wxPreviewFrame: Frame for displaying a print preview
499 @li wxPreviewCanvas: Canvas for displaying a print preview
500 @li wxPreviewControlBar: Standard control bar for a print preview
501 @li wxPrintDialog: Standard print dialog
502 @li wxPageSetupDialog: Standard page setup dialog
503 @li wxPrinter: Class representing the printer
504 @li wxPrinterDC: Printer device context
505 @li wxPrintout: Class representing a particular printout
506 @li wxPrintPreview: Class representing a print preview
507 @li wxPrintData: Represents information about the document being printed
508 @li wxPrintDialogData: Represents information about the print dialog
509 @li wxPageSetupDialogData: Represents information about the page setup dialog
510
511
512
513 @section page_class_cat_dvf Document/View Framework
514
515 wxWidgets supports a document/view framework which provides housekeeping for a
516 document-centric application.
517
518 Related Overviews: @ref overview_docview
519
520 @li wxCommand: Base class for undo/redo actions
521 @li wxCommandProcessor: Maintains the undo/redo stack
522 @li wxDocument: Represents a document
523 @li wxView: Represents a view
524 @li wxDocTemplate: Manages the relationship between a document class and a
525 view class
526 @li wxDocManager: Manages the documents and views in an application
527 @li wxDocChildFrame: A child frame for showing a document view
528 @li wxDocParentFrame: A parent frame to contain views
529 @li wxDocMDIChildFrame: An MDI child frame for showing a document view
530 @li wxDocMDIParentFrame: An MDI parent frame to contain views
531 @li wxFileHistory: Maintains a list of the most recently visited files
532
533
534
535 @section page_class_cat_dnd Clipboard and Drag & Drop
536
537 Related Overviews: @ref overview_dnd
538
539 @li wxDataObject: Data object class
540 @li wxDataFormat: Represents a data format
541 @li wxTextDataObject: Text data object class
542 @li wxFileDataObject: File data object class
543 @li wxBitmapDataObject: Bitmap data object class
544 @li wxURLDataObject: URL data object class
545 @li wxCustomDataObject: Custom data object class
546 @li wxClipboard: Clipboard class
547 @li wxDropTarget: Drop target class
548 @li wxFileDropTarget: File drop target class
549 @li wxTextDropTarget: Text drop target class
550 @li wxDropSource: Drop source class
551
552
553
554 @section page_class_cat_vfs Virtual File System
555
556 wxWidgets provides a set of classes that implement an extensible virtual file
557 system, used internally by the HTML classes.
558
559 @li wxFSFile: Represents a file in the virtual file system
560 @li wxFileSystem: Main interface for the virtual file system
561 @li wxFileSystemHandler: Class used to announce file system type
562
563
564
565 @section page_class_cat_rtti Runtime Type Information (RTTI)
566
567 wxWidgets supports runtime manipulation of class information, and dynamic
568 creation of objects given class names.
569
570 Related Overviews: @ref overview_rtti
571
572 @see @ref group_funcmacro_rtti "RTTI Functions and Macros"
573
574 @li wxClassInfo: Holds runtime class information
575 @li wxObject: Root class for classes with runtime information
576
577
578
579 @section page_class_cat_debugging Debugging
580
581 wxWidgets supports some aspects of debugging an application through classes,
582 functions and macros.
583
584 Related Overviews: @ref overview_debugging
585
586 @see @ref group_funcmacro_debug "Debugging Functions and Macros"
587
588 @li wxDebugContext: Provides memory-checking facilities
589 @li wxDebugReport: Base class for creating debug reports in case of a program
590 crash.
591 @li wxDebugReportCompress: Class for creating compressed debug reports.
592 @li wxDebugReportUpload: Class for uploading compressed debug reports via HTTP.
593 @li wxDebugReportPreview: Abstract base class for previewing the contents of a
594 debug report.
595 @li wxDebugReportPreviewStd: Standard implementation of wxDebugReportPreview.
596
597
598
599 @section page_class_cat_logging Logging
600
601 wxWidgets provides several classes and functions for message logging.
602
603 Related Overviews: @ref overview_log
604
605 @see @ref group_funcmacro_log "Logging Functions and Macros"
606
607 @li wxLog: The base log class
608 @li wxLogStderr: Log messages to a C STDIO stream
609 @li wxLogStream: Log messages to a C++ iostream
610 @li wxLogTextCtrl: Log messages to a wxTextCtrl
611 @li wxLogWindow: Log messages to a log frame
612 @li wxLogGui: Default log target for GUI programs
613 @li wxLogNull: Temporarily suppress message logging
614 @li wxLogChain: Allows to chain two log targets
615 @li wxLogInterposer: Allows to filter the log messages
616 @li wxLogInterposerTemp: Allows to filter the log messages
617 @li wxStreamToTextRedirector: Allows to redirect output sent to @c cout to a wxTextCtrl
618
619
620
621 @section page_class_cat_threading Threading
622
623 wxWidgets provides a set of classes to make use of the native thread
624 capabilities of the various platforms.
625
626 Related Overviews: @ref overview_thread
627
628 @li wxThread: Thread class
629 @li wxThreadHelper: Manages background threads easily
630 @li wxMutex: Mutex class
631 @li wxMutexLocker: Mutex locker utility class
632 @li wxCriticalSection: Critical section class
633 @li wxCriticalSectionLocker: Critical section locker utility class
634 @li wxCondition: Condition class
635 @li wxSemaphore: Semaphore class
636
637
638
639 @section page_class_cat_data Data Structures
640
641 These are the data structure classes supported by wxWidgets.
642
643 @li wxCmdLineParser: Command line parser class
644 @li wxDateSpan: A logical time interval.
645 @li wxDateTime: A class for date/time manipulations
646 @li wxLongLong: A portable 64 bit integer type
647 @li wxObject: The root class for most wxWidgets classes
648 @li wxPathList: A class to help search multiple paths
649 @li wxPoint: Representation of a point
650 @li wxRect: A class representing a rectangle
651 @li wxRegEx: Regular expression support
652 @li wxRegion: A class representing a region
653 @li wxString: A string class
654 @li wxStringTokenizer: A class for interpreting a string as a list of tokens or
655 words
656 @li wxRealPoint: Representation of a point using floating point numbers
657 @li wxSize: Representation of a size
658 @li wxTimeSpan: A time interval.
659 @li wxURI: Represents a Uniform Resource Identifier
660 @li wxVariant: A class for storing arbitrary types that may change at run-time
661
662
663
664 @section page_class_cat_conv Text Conversion
665
666 These classes define objects for performing conversions between different
667 multibyte and Unicode encodings and wide character strings.
668
669 @li wxMBConv: Base class for all convertors, defines the API implemented by all
670 the other convertor classes.
671 @li wxMBConvUTF7: Convertor for UTF-7
672 @li wxMBConvUTF8: Convertor for UTF-8
673 @li wxMBConvUTF16: Convertor for UTF-16
674 @li wxMBConvUTF32: Convertor for UTF-32
675 @li wxCSConv: Convertor for any system-supported encoding which can be
676 specified by name.
677
678 Related Overviews: @ref overview_mbconv
679
680
681 @section page_class_cat_containers Containers
682
683 These are classes, templates and class macros are used by wxWidgets. Most of
684 these classes provide a subset or almost complete STL API.
685
686 Related Overviews: @ref overview_container
687
688 @li wxArray<T>: A type-safe dynamic array implementation (macro based)
689 @li wxArrayString: An efficient container for storing wxString objects
690 @li wxHashMap<T>: A type-safe hash map implementation (macro based)
691 @li wxHashSet<T>: A type-safe hash set implementation(macro based)
692 @li wxHashTable: A simple hash table implementation (deprecated, use wxHashMap)
693 @li wxList<T>: A type-safe linked list implementation (macro based)
694 @li wxVector<T>: Template base vector implementation identical to std::vector
695
696
697
698 @section page_class_cat_smartpointers Smart Pointers
699
700 wxWidgets provides a few smart pointer class templates.
701
702 @li wxObjectDataPtr<T>: A shared pointer (using intrusive reference counting)
703 @li wxScopedPtr<T>: A scoped pointer
704 @li wxSharedPtr<T>: A shared pointer (using non-intrusive reference counting)
705 @li wxWeakRef<T>: A weak reference
706
707
708
709 @section page_class_cat_file File Handling
710
711 wxWidgets has several small classes to work with disk files and directories.
712
713 Related Overviews: @ref overview_file
714
715 @li wxFileName: Operations with the file name and attributes
716 @li wxDir: Class for enumerating files/subdirectories.
717 @li wxDirTraverser: Class used together with wxDir for recursively enumerating
718 the files/subdirectories
719 @li wxFile: Low-level file input/output class.
720 @li wxFFile: Another low-level file input/output class.
721 @li wxTempFile: Class to safely replace an existing file
722 @li wxTextFile: Class for working with text files as with arrays of lines
723 @li wxStandardPaths: Paths for standard directories
724 @li wxPathList: A class to help search multiple paths
725
726
727
728 @section page_class_cat_streams Streams
729
730 wxWidgets has its own set of stream classes, as an alternative to often buggy
731 standard stream libraries, and to provide enhanced functionality.
732
733 @li wxStreamBase: Stream base class
734 @li wxStreamBuffer: Stream buffer class
735 @li wxInputStream: Input stream class
736 @li wxOutputStream: Output stream class
737 @li wxCountingOutputStream: Stream class for querying what size a stream would
738 have.
739 @li wxFilterInputStream: Filtered input stream class
740 @li wxFilterOutputStream: Filtered output stream class
741 @li wxBufferedInputStream: Buffered input stream class
742 @li wxBufferedOutputStream: Buffered output stream class
743 @li wxMemoryInputStream: Memory input stream class
744 @li wxMemoryOutputStream: Memory output stream class
745 @li wxDataInputStream: Platform-independent binary data input stream class
746 @li wxDataOutputStream: Platform-independent binary data output stream class
747 @li wxTextInputStream: Platform-independent text data input stream class
748 @li wxTextOutputStream: Platform-independent text data output stream class
749 @li wxFileInputStream: File input stream class
750 @li wxFileOutputStream: File output stream class
751 @li wxFFileInputStream: Another file input stream class
752 @li wxFFileOutputStream: Another file output stream class
753 @li wxTempFileOutputStream: Stream to safely replace an existing file
754 @li wxStringInputStream: String input stream class
755 @li wxStringOutputStream: String output stream class
756 @li wxZlibInputStream: Zlib and gzip (compression) input stream class
757 @li wxZlibOutputStream: Zlib and gzip (compression) output stream class
758 @li wxZipInputStream: Input stream for reading from ZIP archives
759 @li wxZipOutputStream: Output stream for writing from ZIP archives
760 @li wxTarInputStream: Input stream for reading from tar archives
761 @li wxTarOutputStream: Output stream for writing from tar archives
762 @li wxSocketInputStream: Socket input stream class
763 @li wxSocketOutputStream: Socket output stream class
764
765
766
767 @section page_class_cat_xml XML
768
769 @li wxXmlDocument: A class to parse XML files
770 @li wxXmlNode: A class which represents XML nodes
771 @li wxXmlAttribute: A class which represent an XML attribute
772
773
774
775 @section page_class_cat_archive Archive
776
777 @li wxArchiveInputStream
778 @li wxArchiveOutputStream
779 @li wxArchiveEntry
780
781
782
783 @section page_class_cat_xrc XML Based Resource System (XRC)
784
785 Resources allow your application to create controls and other user interface
786 elements from specifications stored in an XML format.
787
788 Related Overviews: @ref overview_xrc
789
790 @li wxXmlResource: The main class for working with resources
791 @li wxXmlResourceHandler: The base class for XML resource handlers
792
793
794
795 @section page_class_cat_net Networking
796
797 wxWidgets provides its own classes for socket based networking.
798
799 @li wxDialUpManager: Provides functions to check the status of network
800 connection and to establish one
801 @li wxIPV4address: Represents an Internet address
802 @li wxIPaddress: Represents an Internet address
803 @li wxSocketBase: Represents a socket base object
804 @li wxSocketClient: Represents a socket client
805 @li wxSocketServer: Represents a socket server
806 @li wxSocketEvent: A socket event
807 @li wxFTP: FTP protocol class
808 @li wxHTTP: HTTP protocol class
809 @li wxURL: Represents a Universal Resource Locator
810
811
812
813 @section page_class_cat_ipc Interprocess Communication
814
815 wxWidgets provides simple interprocess communications facilities based on
816 Windows DDE, but available on most platforms using TCP.
817
818 Related Overviews: @ref overview_ipc
819
820 @li wxClient, wxDDEClient: Represents a client
821 @li wxConnection, wxDDEConnection: Represents the connection between a client
822 and a server
823 @li wxServer, wxDDEServer: Represents a server
824
825
826
827 @section page_class_cat_help Help
828
829 @li wxHelpController: Family of classes for controlling help windows
830 @li wxHtmlHelpController: HTML help controller class
831 @li wxContextHelp: Class to put application into context-sensitive help mode
832 @li wxContextHelpButton: Button class for putting application into
833 context-sensitive help mode
834 @li wxHelpProvider: Abstract class for context-sensitive help provision
835 @li wxSimpleHelpProvider: Class for simple context-sensitive help provision
836 @li wxHelpControllerHelpProvider: Class for context-sensitive help provision
837 via a help controller
838 @li wxToolTip: Class implementing tooltips
839
840
841
842 @section page_class_cat_media Multimedia
843
844 @li wxMediaCtrl: Display multimedia contents.
845
846
847
848 @section page_class_cat_gl OpenGL
849
850 @li wxGLCanvas: Canvas that you can render OpenGL calls to.
851 @li wxGLContext: Class to ease sharing of OpenGL data resources.
852
853
854
855 @section page_class_cat_misc Miscellaneous
856
857 @li wxCaret: A caret (cursor) object
858 @li wxConfigBase: Classes for reading/writing the configuration settings
859 @li wxTimer: Timer class
860 @li wxStopWatch: Stop watch class
861 @li wxMimeTypesManager: MIME-types manager class
862 @li wxSystemSettings: System settings class for obtaining various global
863 parameters
864 @li wxSystemOptions: System options class for run-time configuration
865 @li wxAcceleratorTable: Accelerator table
866 @li wxAutomationObject: OLE automation class
867 @li wxFontMapper: Font mapping, finding suitable font for given encoding
868 @li wxEncodingConverter: Encoding conversions
869 @li wxCalendarDateAttr: Used with wxCalendarCtrl
870 @li wxQuantize: Class to perform quantization, or colour reduction
871 @li wxSingleInstanceChecker: Check that only single program instance is running
872
873 */
874