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