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