]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/mainpages/cat_classes.h
Add support for wxRibbonBar and related controls to XRC.
[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 $
526954c5 6// Licence: wxWindows licence
29f86fc1
BP
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
524cb040 194@li wxTreeListCtrl: Multi-column tree control with simple interface
29f86fc1 195@li wxStaticBitmap: A control to display a bitmap
1694177e
RR
196@li wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code
197 editing component for plain text editing.
29f86fc1
BP
198@li wxSlider: A slider that can be dragged by the user
199@li wxVListBox: A listbox supporting variable height rows
200
201
202
c7d4ca81
RR
203@section page_class_cat_validator Validators
204
205These are the window validators, used for filtering and validating user input.
206
207Related Overviews: @ref overview_validator
208
209@li wxValidator: Base validator class
210@li wxTextValidator: Text control validator class
211@li wxGenericValidator: Generic control validator class
a54cf371
VZ
212@li wxIntegerValidator: Text control validator class for integer numbers
213@li wxFloatingPointValidator: Text control validator class for floating point numbers
c7d4ca81
RR
214
215
216
29f86fc1
BP
217@section page_class_cat_pickers Picker Controls
218
219A picker control is a control whose appearance and behaviour is highly
220platform-dependent.
221
222@li wxColourPickerCtrl: A control which allows the user to choose a colour
223@li wxDirPickerCtrl: A control which allows the user to choose a directory
224@li wxFilePickerCtrl: A control which allows the user to choose a file
225@li wxFontPickerCtrl: A control which allows the user to choose a font
226@li wxDatePickerCtrl: Small date picker control
227
228
229
557563c8 230@section page_class_cat_miscwnd Miscellaneous Windows
29f86fc1 231
557563c8
RR
232The following are a variety of classes that are derived from wxWindow.
233
d23914f8 234@li wxCollapsiblePane: A panel which can be shown/hidden by the user
557563c8 235@li wxPanel: A window whose colour changes according to current user settings
f09b5681
BP
236@li ::wxScrolledWindow: Window with automatically managed scrollbars (see
237 wxScrolled)
238@li wxHScrolledWindow: As ::wxScrolledWindow but supports columns of variable
239 widths
240@li wxVScrolledWindow: As ::wxScrolledWindow but supports rows of variable
241 heights
242@li wxHVScrolledWindow: As ::wxScrolledWindow but supports scroll units of
243 variable sizes.
557563c8 244@li wxGrid: A grid (table) window
a92b5dfe 245@li wxInfoBar: An information bar usually shown on top of the main window.
e520c3f7 246@li wxRichToolTip: A customizable tooltip.
557563c8
RR
247@li wxSplitterWindow: Window which can be split vertically or horizontally
248@li wxStatusBar: Implements the status bar on a frame
249@li wxToolBar: Toolbar class
250@li wxNotebook: Notebook class
251@li wxListbook: Similar to notebook but using list control
252@li wxChoicebook: Similar to notebook but using choice control
253@li wxTreebook: Similar to notebook but using tree control
254@li wxSashWindow: Window with four optional sashes that can be dragged
255@li wxSashLayoutWindow: Window that can be involved in an IDE-like layout
256 arrangement
cc699de8
VZ
257@li wxSimplebook: Another book control but one allowing only the program, not
258 the user, to change its current page.
557563c8
RR
259@li wxWizardPage: A base class for the page in wizard dialog.
260@li wxWizardPageSimple: A page in wizard dialog.
bbcf2821 261@li wxCustomBackgroundWindow: A window allowing to set a custom bitmap.
557563c8
RR
262
263
264@section page_class_cat_aui Window Docking (wxAUI)
265
266wxAUI is a set classes for writing a customizable application interface
267with built-in docking, floatable panes and a flexible MDI-like interface.
268
269Related Overviews: @ref overview_aui
270
271@li wxAuiManager: The central class for managing the interface
272@li wxAuiNotebook: A replacement notebook class with extra features
273@li wxAuiPaneInfo: Describes a single pane
274@li wxAuiDockArt: Art and metrics provider for customizing the docking user
275 interface
276@li wxAuiTabArt: Art and metrics provider for customizing the notebook user
277 interface
278
279
280
281@section page_class_cat_cmndlg Common Dialogs
282
283Common dialogs are ready-made dialog classes which are frequently used in an
284application.
285
286Related Overviews: @ref overview_cmndlg
287
288@li wxDialog: Base class for common dialogs
289@li wxColourDialog: Colour chooser dialog
290@li wxDirDialog: Directory selector dialog
291@li wxFileDialog: File selector dialog
292@li wxFindReplaceDialog: Text search/replace dialog
557563c8 293@li wxFontDialog: Font chooser dialog
98b2861b
RR
294@li wxMessageDialog: Simple message box dialog
295@li wxMultiChoiceDialog: Dialog to get one or more selections from a list
557563c8 296@li wxPageSetupDialog: Standard page setup dialog
98b2861b 297@li wxPasswordEntryDialog: Dialog to get a password from the user
557563c8
RR
298@li wxPrintDialog: Standard print dialog
299@li wxProgressDialog: Progress indication dialog
98b2861b 300@li wxRearrangeDialog: Dialog allowing the user to rearrange a list of items.
557563c8
RR
301@li wxRichTextFormattingDialog: A dialog for formatting the content of a
302 wxRichTextCtrl
0800eb84 303@li wxRichMessageDialog: Nicer message box dialog
98b2861b
RR
304@li wxSingleChoiceDialog: Dialog to get a single selection from a list and
305 return the string
306@li wxSymbolPickerDialog: Symbol selector dialog
307@li wxTextEntryDialog: Dialog to get a single line of text from the user
557563c8
RR
308@li wxWizard: A wizard dialog.
309
310
311
312@section page_class_cat_html HTML
313
314wxWidgets provides a set of classes to display text in HTML format. These
315classes include a help system based on the HTML widget.
316
317@li wxHtmlHelpController: HTML help controller class
318@li wxHtmlWindow: HTML window class
319@li wxHtmlEasyPrinting: Simple class for printing HTML
320@li wxHtmlPrintout: Generic HTML wxPrintout class
321@li wxHtmlParser: Generic HTML parser class
322@li wxHtmlTagHandler: HTML tag handler, pluginable into wxHtmlParser
323@li wxHtmlWinParser: HTML parser class for wxHtmlWindow
324@li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser
325
326
29f86fc1
BP
327@section page_class_cat_dc Device Contexts
328
329Device contexts are surfaces that may be drawn on, and provide an abstraction
330that allows parameterisation of your drawing code by passing different device
331contexts.
332
333Related Overviews: @ref overview_dc
334
335@li wxAutoBufferedPaintDC: A helper device context for double buffered drawing
336 inside @b OnPaint().
337@li wxBufferedDC: A helper device context for double buffered drawing.
338@li wxBufferedPaintDC: A helper device context for double buffered drawing
339 inside @b OnPaint().
340@li wxClientDC: A device context to access the client area outside
341 @b OnPaint() events
342@li wxPaintDC: A device context to access the client area inside @b OnPaint()
343 events
344@li wxWindowDC: A device context to access the non-client area
345@li wxScreenDC: A device context to access the entire screen
346@li wxDC: The device context base class
347@li wxMemoryDC: A device context for drawing into bitmaps
348@li wxMetafileDC: A device context for drawing into metafiles
349@li wxMirrorDC: A proxy device context allowing for simple mirroring.
350@li wxPostScriptDC: A device context for drawing into PostScript files
351@li wxPrinterDC: A device context for drawing to printers
352
353
354
28792a70
RR
355@section page_class_cat_gc Graphics Context classes
356
357These classes are related to drawing using a new vector based drawing API and
358are based on the modern drawing backend GDI+, CoreGraphics and Cairo.
359
360@li wxGraphicsRenderer: Represents a drawing engine.
361@li wxGraphicsContext: Represents a graphics context currently being drawn on.
362@li wxGraphicsBrush: Brush for drawing into a wxGraphicsContext
363@li wxGraphicsPen: Pen for drawing into a wxGraphicsContext
364@li wxGraphicsFont: Font for drawing text on a wxGraphicsContext
365@li wxGraphicsMatrix: Represents an affine matrix for drawing transformation
4c7b80fb 366@li wxGraphicsPath: Represents a path for drawing
28792a70
RR
367
368
369
29f86fc1
BP
370@section page_class_cat_gdi Graphics Device Interface
371
372These classes are related to drawing on device contexts and windows.
373
29f86fc1
BP
374@li wxColour: Represents the red, blue and green elements of a colour
375@li wxDCClipper: Wraps the operations of setting and destroying the clipping
376 region
29f86fc1
BP
377@li wxBrush: Used for filling areas on a device context
378@li wxBrushList: The list of previously-created brushes
29f86fc1
BP
379@li wxFont: Represents fonts
380@li wxFontList: The list of previously-created fonts
29f86fc1
BP
381@li wxPen: Used for drawing lines on a device context
382@li wxPenList: The list of previously-created pens
383@li wxPalette: Represents a table of indices into RGB values
384@li wxRegion: Represents a simple or complex region on a window or device
385 context
29f86fc1
BP
386@li wxRendererNative: Abstracts high-level drawing primitives
387
388
389
28792a70
RR
390@section page_class_cat_image Image and bitmap classes
391
392These classes represent images and bitmap in various formats and ways
393to access and create them.
394
395Related Overviews: @ref overview_bitmap
396
397@li wxAnimation: Represents an animation
398@li wxBitmap: Represents a platform dependent bitmap
399@li wxBitmapHandler: Class for loading a saving a wxBitmap in a specific format
400@li wxCursor: A small, transparent bitmap representing the cursor
401@li wxIcon: A small, transparent bitmap for assigning to frames and drawing on
402 device contexts
403@li wxImage: A platform-independent image class
404@li wxImageHandler: Class for loading a saving a wxImage in a specific format
405@li wxImageList: A list of images, used with some controls
406@li wxMask: Represents a mask to be used with a bitmap for transparent drawing
407@li wxMemoryDC: A device context for drawing into bitmaps
408@li wxPixelData: Class template for direct access to wxBitmap's and wxImage's internal data
409
410
411
29f86fc1
BP
412@section page_class_cat_events Events
413
414An event object contains information about a specific event. Event handlers
415(usually member functions) have a single, event argument.
416
830b7aa7 417Related Overviews: @ref overview_events
29f86fc1
BP
418
419@li wxActivateEvent: A window or application activation event
420@li wxCalendarEvent: Used with wxCalendarCtrl
421@li wxCalculateLayoutEvent: Used to calculate window layout
422@li wxChildFocusEvent: A child window focus event
423@li wxClipboardTextEvent: A clipboard copy/cut/paste treebook event event
424@li wxCloseEvent: A close window or end session event
425@li wxCommandEvent: An event from a variety of standard controls
426@li wxContextMenuEvent: An event generated when the user issues a context menu
427 command
428@li wxDateEvent: Used with wxDatePickerCtrl
429@li wxDialUpEvent: Event send by wxDialUpManager
430@li wxDropFilesEvent: A drop files event
431@li wxEraseEvent: An erase background event
432@li wxEvent: The event base class
433@li wxFindDialogEvent: Event sent by wxFindReplaceDialog
434@li wxFocusEvent: A window focus event
435@li wxKeyEvent: A keypress event
436@li wxIconizeEvent: An iconize/restore event
437@li wxIdleEvent: An idle event
438@li wxInitDialogEvent: A dialog initialisation event
439@li wxJoystickEvent: A joystick event
9e0ed083 440@li wxKeyboardState: State of the keyboard modifiers.
29f86fc1
BP
441@li wxListEvent: A list control event
442@li wxMaximizeEvent: A maximize event
443@li wxMenuEvent: A menu event
444@li wxMouseCaptureChangedEvent: A mouse capture changed event
445@li wxMouseCaptureLostEvent: A mouse capture lost event
446@li wxMouseEvent: A mouse event
9e0ed083 447@li wxMouseState: State of the mouse
29f86fc1
BP
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
7ac7b533 474@section page_class_cat_appmanagement Application and Process Management
29f86fc1 475
7ac7b533 476@li wxApp: Application class
29f86fc1 477@li wxCmdLineParser: Command line parser class
09ad05fa 478@li wxDynamicLibrary: Class to work with shared libraries.
7ac7b533 479@li wxProcess: Process class
29f86fc1
BP
480
481
482
7ac7b533 483@section page_class_cat_printing Printing Framework
29f86fc1 484
7ac7b533
RR
485A printing and previewing framework is implemented to make it relatively
486straightforward to provide document printing facilities.
29f86fc1 487
7ac7b533 488Related Overviews: @ref overview_printing
29f86fc1 489
7ac7b533
RR
490@li wxPreviewFrame: Frame for displaying a print preview
491@li wxPreviewCanvas: Canvas for displaying a print preview
492@li wxPreviewControlBar: Standard control bar for a print preview
493@li wxPrintDialog: Standard print dialog
494@li wxPageSetupDialog: Standard page setup dialog
495@li wxPrinter: Class representing the printer
496@li wxPrinterDC: Printer device context
497@li wxPrintout: Class representing a particular printout
498@li wxPrintPreview: Class representing a print preview
499@li wxPrintData: Represents information about the document being printed
500@li wxPrintDialogData: Represents information about the print dialog
501@li wxPageSetupDialogData: Represents information about the page setup dialog
29f86fc1
BP
502
503
504
7ac7b533 505@section page_class_cat_dvf Document/View Framework
29f86fc1 506
7ac7b533
RR
507wxWidgets supports a document/view framework which provides housekeeping for a
508document-centric application.
29f86fc1 509
7ac7b533 510Related Overviews: @ref overview_docview
29f86fc1 511
7ac7b533
RR
512@li wxCommand: Base class for undo/redo actions
513@li wxCommandProcessor: Maintains the undo/redo stack
514@li wxDocument: Represents a document
515@li wxView: Represents a view
516@li wxDocTemplate: Manages the relationship between a document class and a
517 view class
518@li wxDocManager: Manages the documents and views in an application
519@li wxDocChildFrame: A child frame for showing a document view
520@li wxDocParentFrame: A parent frame to contain views
521@li wxDocMDIChildFrame: An MDI child frame for showing a document view
522@li wxDocMDIParentFrame: An MDI parent frame to contain views
523@li wxFileHistory: Maintains a list of the most recently visited files
29f86fc1
BP
524
525
29f86fc1 526
7ac7b533 527@section page_class_cat_dnd Clipboard and Drag & Drop
29f86fc1 528
7ac7b533 529Related Overviews: @ref overview_dnd
29f86fc1 530
7ac7b533
RR
531@li wxDataObject: Data object class
532@li wxDataFormat: Represents a data format
533@li wxTextDataObject: Text data object class
534@li wxFileDataObject: File data object class
535@li wxBitmapDataObject: Bitmap data object class
536@li wxURLDataObject: URL data object class
537@li wxCustomDataObject: Custom data object class
538@li wxClipboard: Clipboard class
539@li wxDropTarget: Drop target class
540@li wxFileDropTarget: File drop target class
541@li wxTextDropTarget: Text drop target class
542@li wxDropSource: Drop source class
29f86fc1 543
7ac7b533
RR
544
545
546@section page_class_cat_vfs Virtual File System
547
548wxWidgets provides a set of classes that implement an extensible virtual file
549system, used internally by the HTML classes.
550
551@li wxFSFile: Represents a file in the virtual file system
552@li wxFileSystem: Main interface for the virtual file system
553@li wxFileSystemHandler: Class used to announce file system type
554
555
556
c7d4ca81
RR
557@section page_class_cat_threading Threading
558
559wxWidgets provides a set of classes to make use of the native thread
560capabilities of the various platforms.
561
562Related Overviews: @ref overview_thread
563
564@li wxThread: Thread class
565@li wxThreadHelper: Manages background threads easily
566@li wxMutex: Mutex class
567@li wxMutexLocker: Mutex locker utility class
568@li wxCriticalSection: Critical section class
569@li wxCriticalSectionLocker: Critical section locker utility class
570@li wxCondition: Condition class
571@li wxSemaphore: Semaphore class
572
573
574
7ac7b533
RR
575@section page_class_cat_rtti Runtime Type Information (RTTI)
576
577wxWidgets supports runtime manipulation of class information, and dynamic
578creation of objects given class names.
579
580Related Overviews: @ref overview_rtti
581
582@see @ref group_funcmacro_rtti "RTTI Functions and Macros"
583
584@li wxClassInfo: Holds runtime class information
585@li wxObject: Root class for classes with runtime information
29f86fc1
BP
586
587
588
589@section page_class_cat_debugging Debugging
590
591wxWidgets supports some aspects of debugging an application through classes,
592functions and macros.
593
594Related Overviews: @ref overview_debugging
595
596@see @ref group_funcmacro_debug "Debugging Functions and Macros"
597
598@li wxDebugContext: Provides memory-checking facilities
599@li wxDebugReport: Base class for creating debug reports in case of a program
600 crash.
601@li wxDebugReportCompress: Class for creating compressed debug reports.
602@li wxDebugReportUpload: Class for uploading compressed debug reports via HTTP.
603@li wxDebugReportPreview: Abstract base class for previewing the contents of a
604 debug report.
605@li wxDebugReportPreviewStd: Standard implementation of wxDebugReportPreview.
606
607
608
7ac7b533 609@section page_class_cat_logging Logging
29f86fc1 610
7ac7b533 611wxWidgets provides several classes and functions for message logging.
29f86fc1 612
673453e2 613Related overview: @ref overview_log
29f86fc1 614
7ac7b533 615@see @ref group_funcmacro_log "Logging Functions and Macros"
29f86fc1 616
7ac7b533
RR
617@li wxLog: The base log class
618@li wxLogStderr: Log messages to a C STDIO stream
619@li wxLogStream: Log messages to a C++ iostream
620@li wxLogTextCtrl: Log messages to a wxTextCtrl
621@li wxLogWindow: Log messages to a log frame
622@li wxLogGui: Default log target for GUI programs
623@li wxLogNull: Temporarily suppress message logging
624@li wxLogChain: Allows to chain two log targets
625@li wxLogInterposer: Allows to filter the log messages
626@li wxLogInterposerTemp: Allows to filter the log messages
627@li wxStreamToTextRedirector: Allows to redirect output sent to @c cout to a wxTextCtrl
29f86fc1 628
29f86fc1 629
29f86fc1 630
7ac7b533 631@section page_class_cat_data Data Structures
29f86fc1 632
7ac7b533 633These are the data structure classes supported by wxWidgets.
29f86fc1 634
178c7760 635@li wxAny: A class for storing arbitrary types that may change at run-time
7ac7b533
RR
636@li wxCmdLineParser: Command line parser class
637@li wxDateSpan: A logical time interval.
638@li wxDateTime: A class for date/time manipulations
639@li wxLongLong: A portable 64 bit integer type
640@li wxObject: The root class for most wxWidgets classes
641@li wxPathList: A class to help search multiple paths
642@li wxPoint: Representation of a point
643@li wxRect: A class representing a rectangle
644@li wxRegEx: Regular expression support
645@li wxRegion: A class representing a region
646@li wxString: A string class
647@li wxStringTokenizer: A class for interpreting a string as a list of tokens or
648 words
649@li wxRealPoint: Representation of a point using floating point numbers
650@li wxSize: Representation of a size
651@li wxTimeSpan: A time interval.
652@li wxURI: Represents a Uniform Resource Identifier
653@li wxVariant: A class for storing arbitrary types that may change at run-time
29f86fc1
BP
654
655
656
79b40dcf
VZ
657@section page_class_cat_conv Text Conversion
658
659These classes define objects for performing conversions between different
660multibyte and Unicode encodings and wide character strings.
661
d13b34d3
DS
662@li wxMBConv: Base class for all converters, defines the API implemented by all
663 the other converter classes.
664@li wxMBConvUTF7: Converter for UTF-7
665@li wxMBConvUTF8: Converter for UTF-8
666@li wxMBConvUTF16: Converter for UTF-16
667@li wxMBConvUTF32: Converter for UTF-32
668@li wxCSConv: Converter for any system-supported encoding which can be
79b40dcf
VZ
669 specified by name.
670
671Related Overviews: @ref overview_mbconv
672
673
7ac7b533 674@section page_class_cat_containers Containers
29f86fc1 675
7ac7b533
RR
676These are classes, templates and class macros are used by wxWidgets. Most of
677these classes provide a subset or almost complete STL API.
29f86fc1 678
7ac7b533 679Related Overviews: @ref overview_container
29f86fc1 680
7ac7b533
RR
681@li wxArray<T>: A type-safe dynamic array implementation (macro based)
682@li wxArrayString: An efficient container for storing wxString objects
683@li wxHashMap<T>: A type-safe hash map implementation (macro based)
684@li wxHashSet<T>: A type-safe hash set implementation(macro based)
685@li wxHashTable: A simple hash table implementation (deprecated, use wxHashMap)
686@li wxList<T>: A type-safe linked list implementation (macro based)
687@li wxVector<T>: Template base vector implementation identical to std::vector
29f86fc1
BP
688
689
690
7ac7b533 691@section page_class_cat_smartpointers Smart Pointers
29f86fc1 692
7ac7b533 693wxWidgets provides a few smart pointer class templates.
29f86fc1 694
7ac7b533
RR
695@li wxObjectDataPtr<T>: A shared pointer (using intrusive reference counting)
696@li wxScopedPtr<T>: A scoped pointer
697@li wxSharedPtr<T>: A shared pointer (using non-intrusive reference counting)
698@li wxWeakRef<T>: A weak reference
29f86fc1
BP
699
700
701
702@section page_class_cat_file File Handling
703
704wxWidgets has several small classes to work with disk files and directories.
705
673453e2 706Related overview: @ref overview_file
29f86fc1
BP
707
708@li wxFileName: Operations with the file name and attributes
709@li wxDir: Class for enumerating files/subdirectories.
710@li wxDirTraverser: Class used together with wxDir for recursively enumerating
711 the files/subdirectories
712@li wxFile: Low-level file input/output class.
713@li wxFFile: Another low-level file input/output class.
714@li wxTempFile: Class to safely replace an existing file
715@li wxTextFile: Class for working with text files as with arrays of lines
716@li wxStandardPaths: Paths for standard directories
717@li wxPathList: A class to help search multiple paths
6b8ef0b3 718@li wxFileSystemWatcher: Class providing notifications of file system changes
29f86fc1
BP
719
720
721
29f86fc1
BP
722@section page_class_cat_streams Streams
723
673453e2
RR
724wxWidgets has its own set of stream classes as an alternative to the
725standard stream libraries and to provide enhanced functionality.
726
727Related overview: @ref overview_stream
29f86fc1
BP
728
729@li wxStreamBase: Stream base class
730@li wxStreamBuffer: Stream buffer class
731@li wxInputStream: Input stream class
732@li wxOutputStream: Output stream class
733@li wxCountingOutputStream: Stream class for querying what size a stream would
734 have.
735@li wxFilterInputStream: Filtered input stream class
736@li wxFilterOutputStream: Filtered output stream class
737@li wxBufferedInputStream: Buffered input stream class
738@li wxBufferedOutputStream: Buffered output stream class
739@li wxMemoryInputStream: Memory input stream class
740@li wxMemoryOutputStream: Memory output stream class
741@li wxDataInputStream: Platform-independent binary data input stream class
742@li wxDataOutputStream: Platform-independent binary data output stream class
743@li wxTextInputStream: Platform-independent text data input stream class
744@li wxTextOutputStream: Platform-independent text data output stream class
745@li wxFileInputStream: File input stream class
746@li wxFileOutputStream: File output stream class
747@li wxFFileInputStream: Another file input stream class
748@li wxFFileOutputStream: Another file output stream class
749@li wxTempFileOutputStream: Stream to safely replace an existing file
750@li wxStringInputStream: String input stream class
751@li wxStringOutputStream: String output stream class
752@li wxZlibInputStream: Zlib and gzip (compression) input stream class
753@li wxZlibOutputStream: Zlib and gzip (compression) output stream class
754@li wxZipInputStream: Input stream for reading from ZIP archives
755@li wxZipOutputStream: Output stream for writing from ZIP archives
756@li wxTarInputStream: Input stream for reading from tar archives
757@li wxTarOutputStream: Output stream for writing from tar archives
758@li wxSocketInputStream: Socket input stream class
759@li wxSocketOutputStream: Socket output stream class
760
761
762
7ac7b533 763@section page_class_cat_xml XML
29f86fc1 764
7ac7b533
RR
765@li wxXmlDocument: A class to parse XML files
766@li wxXmlNode: A class which represents XML nodes
767@li wxXmlAttribute: A class which represent an XML attribute
29f86fc1 768
29f86fc1 769
29f86fc1 770
7ac7b533 771@section page_class_cat_archive Archive
29f86fc1 772
7ac7b533
RR
773@li wxArchiveInputStream
774@li wxArchiveOutputStream
775@li wxArchiveEntry
29f86fc1 776
29f86fc1 777
29f86fc1 778
1c9ac9a8
RR
779@section page_class_cat_xrc XML Based Resource System (XRC)
780
781Resources allow your application to create controls and other user interface
782elements from specifications stored in an XML format.
783
673453e2 784Related overview: @ref overview_xrc
1c9ac9a8
RR
785
786@li wxXmlResource: The main class for working with resources
787@li wxXmlResourceHandler: The base class for XML resource handlers
788
789
29f86fc1 790
7ac7b533 791@section page_class_cat_net Networking
29f86fc1 792
7ac7b533 793wxWidgets provides its own classes for socket based networking.
29f86fc1 794
7ac7b533
RR
795@li wxDialUpManager: Provides functions to check the status of network
796 connection and to establish one
797@li wxIPV4address: Represents an Internet address
798@li wxIPaddress: Represents an Internet address
799@li wxSocketBase: Represents a socket base object
800@li wxSocketClient: Represents a socket client
801@li wxSocketServer: Represents a socket server
802@li wxSocketEvent: A socket event
803@li wxFTP: FTP protocol class
804@li wxHTTP: HTTP protocol class
805@li wxURL: Represents a Universal Resource Locator
29f86fc1
BP
806
807
29f86fc1 808
7ac7b533 809@section page_class_cat_ipc Interprocess Communication
29f86fc1 810
7ac7b533
RR
811wxWidgets provides simple interprocess communications facilities based on
812Windows DDE, but available on most platforms using TCP.
813
673453e2 814Related overview: @ref overview_ipc
7ac7b533
RR
815
816@li wxClient, wxDDEClient: Represents a client
817@li wxConnection, wxDDEConnection: Represents the connection between a client
818 and a server
819@li wxServer, wxDDEServer: Represents a server
29f86fc1
BP
820
821
29f86fc1 822
29f86fc1
BP
823@section page_class_cat_help Help
824
825@li wxHelpController: Family of classes for controlling help windows
826@li wxHtmlHelpController: HTML help controller class
827@li wxContextHelp: Class to put application into context-sensitive help mode
828@li wxContextHelpButton: Button class for putting application into
829 context-sensitive help mode
830@li wxHelpProvider: Abstract class for context-sensitive help provision
831@li wxSimpleHelpProvider: Class for simple context-sensitive help provision
832@li wxHelpControllerHelpProvider: Class for context-sensitive help provision
833 via a help controller
834@li wxToolTip: Class implementing tooltips
835
836
837
838@section page_class_cat_media Multimedia
839
840@li wxMediaCtrl: Display multimedia contents.
841
842
843
844@section page_class_cat_gl OpenGL
845
846@li wxGLCanvas: Canvas that you can render OpenGL calls to.
847@li wxGLContext: Class to ease sharing of OpenGL data resources.
848
849
850
29f86fc1
BP
851@section page_class_cat_misc Miscellaneous
852
853@li wxCaret: A caret (cursor) object
854@li wxConfigBase: Classes for reading/writing the configuration settings
855@li wxTimer: Timer class
856@li wxStopWatch: Stop watch class
857@li wxMimeTypesManager: MIME-types manager class
858@li wxSystemSettings: System settings class for obtaining various global
859 parameters
860@li wxSystemOptions: System options class for run-time configuration
861@li wxAcceleratorTable: Accelerator table
862@li wxAutomationObject: OLE automation class
863@li wxFontMapper: Font mapping, finding suitable font for given encoding
864@li wxEncodingConverter: Encoding conversions
865@li wxCalendarDateAttr: Used with wxCalendarCtrl
866@li wxQuantize: Class to perform quantization, or colour reduction
867@li wxSingleInstanceChecker: Check that only single program instance is running
868
869*/
870