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