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