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