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