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