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