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