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