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