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