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