]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/categories.h
added wxWidgets samples
[wxWidgets.git] / docs / doxygen / categories.h
CommitLineData
15b6757b
FM
1/////////////////////////////////////////////////////////////////////////////
2// Name: categories.h
3// Purpose: Classes-by-category page of the Doxygen manual
4// Author: wxWidgets team
5// RCS-ID: $Id$
6// Licence: wxWindows license
7/////////////////////////////////////////////////////////////////////////////
8
9
10/*!
11
12 @page categories_page Classes by category
13
14 A classification of wxWidgets classes by category.
36c9828f 15
00e4f098
FM
16 @beginInvisibleTable
17 <tr><td>
15b6757b
FM
18 @li @ref cat_manwnd
19 @li @ref cat_miscwnd
20 @li @ref cat_cmndlg
21 @li @ref cat_ctrl
22 @li @ref cat_miscpickers
23 @li @ref cat_menus
24 @li @ref cat_wxaui
25 @li @ref cat_winlayout
26 @li @ref cat_dc
27 @li @ref cat_gdi
28 @li @ref cat_events
29 @li @ref cat_val
30 @li @ref cat_data
31 @li @ref cat_containers
32 @li @ref cat_smartpointers
33 @li @ref cat_rtti
34 @li @ref cat_logging
35 @li @ref cat_debugging
36 @li @ref cat_net
00e4f098 37 </td><td>
15b6757b
FM
38 @li @ref cat_ipc
39 @li @ref cat_dvf
40 @li @ref cat_printing
41 @li @ref cat_dd
42 @li @ref cat_file
43 @li @ref cat_streams
44 @li @ref cat_threading
45 @li @ref cat_html
46 @li @ref cat_rich
47 @li @ref cat_stc
48 @li @ref cat_vfs
49 @li @ref cat_xml
50 @li @ref cat_xrc
51 @li @ref cat_help
52 @li @ref cat_media
53 @li @ref cat_gl
54 @li @ref cat_appmanagement
55 @li @ref cat_misc
00e4f098
FM
56 </td></tr>
57 @endTable
15b6757b
FM
58
59 <hr>
60
61
62
63 @section cat_manwnd Managed windows
36c9828f 64
15b6757b
FM
65 There are several types of window that are directly controlled by the
66 window manager (such as MS Windows, or the Motif Window Manager).
67 Frames and dialogs are similar in wxWidgets, but only dialogs may be modal.
36c9828f 68
15b6757b
FM
69 @li wxTopLevelWindow: Any top level window, dialog or frame
70 @li wxDialog: Dialog box
71 @li wxFrame: Normal frame
72 @li wxMDIChildFrame: MDI child frame
73 @li wxMDIParentFrame: MDI parent frame
74 @li wxMiniFrame: A frame with a small title bar
75 @li wxPropertySheetDialog: Property sheet dialog
76 @li wxSplashScreen: Splash screen class
77 @li wxTipWindow: Shows text in a small window
78 @li wxWizard: A wizard dialog
36c9828f 79
8aa7f32d 80 See also the @ref commondialogs_overview.
36c9828f 81
15b6757b
FM
82
83 @section cat_miscwnd Miscellaneous windows
36c9828f 84
15b6757b 85 The following are a variety of classes that are derived from wxWindow.
36c9828f 86
15b6757b
FM
87 @li wxPanel: A window whose colour changes according to current user settings
88 @li wxScrolledWindow: Window with automatically managed scrollbars
89 @li wxGrid: A grid (table) window
90 @li wxSplitterWindow: Window which can be split vertically or horizontally
91 @li wxStatusBar: Implements the status bar on a frame
92 @li wxToolBar: Toolbar class
93 @li wxNotebook: Notebook class
94 @li wxListbook: Similar to notebook but using list control
95 @li wxChoicebook: Similar to notebook but using choice control
96 @li wxTreebook: Similar to notebook but using tree control
97 @li wxSashWindow: Window with four optional sashes that can be dragged
98 @li wxSashLayoutWindow: Window that can be involved in an IDE-like layout arrangement
99 @li wxVScrolledWindow: As wxScrolledWindow but supports lines of variable height
100 @li wxWizardPage: A base class for the page in wizard dialog.
101 @li wxWizardPageSimple: A page in wizard dialog.
36c9828f
FM
102
103
15b6757b 104 @section cat_cmndlg Common dialogs
36c9828f 105
8aa7f32d 106 @ref commondialogs_overview
36c9828f 107
15b6757b
FM
108 Common dialogs are ready-made dialog classes which are frequently used
109 in an application.
36c9828f 110
15b6757b
FM
111 @li wxDialog: Base class for common dialogs
112 @li wxColourDialog: Colour chooser dialog
113 @li wxDirDialog: Directory selector dialog
114 @li wxFileDialog: File selector dialog
115 @li wxFindReplaceDialog: Text search/replace dialog
116 @li wxMultiChoiceDialog: Dialog to get one or more selections from a list
117 @li wxSingleChoiceDialog: Dialog to get a single selection from a list and return the string
118 @li wxTextEntryDialog: Dialog to get a single line of text from the user
119 @li wxPasswordEntryDialog: Dialog to get a password from the user
120 @li wxFontDialog: Font chooser dialog
121 @li wxPageSetupDialog: Standard page setup dialog
122 @li wxPrintDialog: Standard print dialog
123 @li wxProgressDialog: Progress indication dialog
124 @li wxMessageDialog: Simple message box dialog
125 @li wxSymbolPickerDialog: Symbol selector dialog
126 @li wxRichTextFormattingDialog: A dialog for formatting the content of a wxRichTextCtrl
127 @li wxWizard: A wizard dialog.
36c9828f
FM
128
129
15b6757b 130 @section cat_ctrl Controls
36c9828f 131
15b6757b
FM
132 Typically, these are small windows which provide interaction with the user. Controls
133 that are not static can have wxValidator associated with them.
36c9828f 134
15b6757b
FM
135 @li wxAnimationCtrl: A control to display an animation
136 @li wxControl: The base class for controls
137 @li wxButton: Push button control, displaying text
138 @li wxBitmapButton: Push button control, displaying a bitmap
139 @li wxBitmapComboBox: A combobox with bitmaps next to text items
140 @li wxToggleButton: A button which stays pressed when clicked by user.
141 @li wxBitmapToggleButton: A toggle button with bitmaps.
142 @li wxCalendarCtrl: Control showing an entire calendar month
143 @li wxCheckBox: Checkbox control
144 @li wxCheckListBox: A listbox with a checkbox to the left of each item
145 @li wxChoice: Choice control (a combobox without the editable area)
146 @li wxCollapsiblePane: A panel which can be shown/hidden by the user
147 @li wxComboBox: A choice with an editable area
148 @li wxComboCtrl: A combobox with application defined popup
149 @li wxDataViewCtrl: A control to tabular or tree like data
150 @li wxDataViewTreeCtrl: A specialized wxDataViewCtrl with wxTreeCtrl-like API
151 @li wxGauge: A control to represent a varying quantity, such as time remaining
152 @li wxGenericDirCtrl: A control for displaying a directory tree
153 @li wxHtmlListBox: An abstract class for creating listboxes showing HTML content
154 @li wxSimpleHtmlListBox: A listbox showing HTML content
155 @li wxStaticBox: A static, or group box for visually grouping related controls
156 @li wxListBox: A list of strings for single or multiple selection
157 @li wxListCtrl: A control for displaying lists of strings and/or icons, plus a multicolumn report view
25c4a27c 158 @li wxListView: A simpler interface (fa&ccedil;ade) for wxListCtrl in report mode
15b6757b
FM
159 @li wxOwnerDrawnComboBox: A combobox with owner-drawn list items
160 @li wxRichTextCtrl: Generic rich text editing control
161 @li wxTextCtrl: Single or multiline text editing control
162 @li wxTreeCtrl: Tree (hierarchy) control
163 @li wxScrollBar: Scrollbar control
164 @li wxSpinButton: A spin or `up-down' control
165 @li wxSpinCtrl: A spin control - i.e. spin button and text control
166 @li wxStaticText: One or more lines of non-editable text
167 @li wxHyperlinkCtrl: A static text which opens an URL when clicked
168 @li wxStaticBitmap: A control to display a bitmap
169 @li wxRadioBox: A group of radio buttons
170 @li wxRadioButton: A round button to be used with others in a mutually exclusive way
171 @li wxSlider: A slider that can be dragged by the user
172 @li wxVListBox: A listbox supporting variable height rows
36c9828f
FM
173
174
175
15b6757b 176 @section cat_miscpickers Miscellaneous pickers
36c9828f 177
15b6757b 178 A picker control is a control whose appearance and behaviour is highly platform-dependent.
36c9828f 179
15b6757b
FM
180 @li wxColourPickerCtrl: A control which allows the user to choose a colour
181 @li wxDirPickerCtrl: A control which allows the user to choose a directory
182 @li wxFilePickerCtrl: A control which allows the user to choose a file
183 @li wxFontPickerCtrl: A control which allows the user to choose a font
184 @li wxDatePickerCtrl: Small date picker control
36c9828f
FM
185
186
187
15b6757b 188 @section cat_menus Menus
36c9828f 189
15b6757b
FM
190 @li wxMenu: Displays a series of menu items for selection
191 @li wxMenuBar: Contains a series of menus for use with a frame
192 @li wxMenuItem: Represents a single menu item
36c9828f
FM
193
194
8aa7f32d 195
15b6757b 196 @section cat_wxaui wxAUI - advanced user interface
36c9828f 197
15b6757b
FM
198 This is a new set of classes for writing a customizable application
199 interface with built-in docking, floatable panes and a flexible
200 MDI-like interface. Further classes for custom notebooks with
a3465294 201 draggable tabs etc. are in progress. See also @ref aui_overview.
36c9828f 202
15b6757b
FM
203 @li wxAuiManager: The central class for managing the interface
204 @li wxAuiNotebook: A replacement notebook class with extra features
205 @li wxAuiPaneInfo: Describes a single pane
206 @li wxAuiDockArt: Art and metrics provider for customizing the docking user interface
207 @li wxAuiTabArt: Art and metrics provider for customizing the notebook user interface
36c9828f
FM
208
209
210
15b6757b 211 @section cat_winlayout Window layout
36c9828f 212
15b6757b
FM
213 There are two different systems for laying out windows (and dialogs in particular).
214 One is based upon so-called sizers and it requires less typing, thinking and calculating
215 and will in almost all cases produce dialogs looking equally well on all platforms, the
216 other is based on so-called constraints and is deprecated, though still available.
36c9828f 217
8aa7f32d 218 @ref sizer_overview describes sizer-based layout.
36c9828f 219
15b6757b 220 These are the classes relevant to sizer-based layout.
36c9828f 221
15b6757b
FM
222 @li wxSizer: Abstract base class
223 @li wxGridSizer: A sizer for laying out windows in a grid with all fields having the same size
224 @li wxFlexGridSizer: A sizer for laying out windows in a flexible grid
225 @li wxGridBagSizer: Another grid sizer that lets you specify the cell an item is in, and items can span rows and/or columns.
226 @li wxBoxSizer: A sizer for laying out windows in a row or column
227 @li wxStaticBoxSizer: Same as wxBoxSizer, but with a surrounding static box
228 @li wxWrapSizer: A sizer which wraps its child controls as size permits
36c9828f 229
8aa7f32d 230 @ref constraints_overview describes constraints-based layout.
36c9828f 231
15b6757b 232 These are the classes relevant to constraints-based window layout.
36c9828f 233
15b6757b
FM
234 @li wxIndividualLayoutConstraint: Represents a single constraint dimension
235 @li wxLayoutConstraints: Represents the constraints for a window class
36c9828f 236
15b6757b 237 Other layouting classes:
36c9828f 238
15b6757b 239 @li wxLayoutAlgorithm: An alternative window layout facility
36c9828f
FM
240
241
15b6757b 242 @section cat_dc Device contexts
36c9828f 243
8aa7f32d 244 @ref dc_overview
36c9828f 245
15b6757b
FM
246 Device contexts are surfaces that may be drawn on, and provide an
247 abstraction that allows parameterisation of your drawing code
248 by passing different device contexts.
36c9828f 249
8aa7f32d 250 @li wxAutoBufferedPaintDC: A helper device context for double buffered drawing inside @b OnPaint.
15b6757b 251 @li wxBufferedDC: A helper device context for double buffered drawing.
8aa7f32d
FM
252 @li wxBufferedPaintDC: A helper device context for double buffered drawing inside @b OnPaint.
253 @li wxClientDC: A device context to access the client area outside @b OnPaint events
254 @li wxPaintDC: A device context to access the client area inside @b OnPaint events
15b6757b
FM
255 @li wxWindowDC: A device context to access the non-client area
256 @li wxScreenDC: A device context to access the entire screen
257 @li wxDC: The device context base class
258 @li wxMemoryDC: A device context for drawing into bitmaps
259 @li wxMetafileDC: A device context for drawing into metafiles
260 @li wxMirrorDC: A proxy device context allowing for simple mirroring.
261 @li wxPostScriptDC: A device context for drawing into PostScript files
262 @li wxPrinterDC: A device context for drawing to printers
36c9828f
FM
263
264
15b6757b 265 @section cat_gdi Graphics device interface
36c9828f 266
8aa7f32d 267 @ref bitmap_overview
36c9828f 268
15b6757b 269 These classes are related to drawing on device contexts and windows.
36c9828f 270
15b6757b
FM
271 @li wxColour: Represents the red, blue and green elements of a colour
272 @li wxDCClipper: Wraps the operations of setting and destroying the clipping region
273 @li wxBitmap: Represents a bitmap
274 @li wxBrush: Used for filling areas on a device context
275 @li wxBrushList: The list of previously-created brushes
276 @li wxCursor: A small, transparent bitmap representing the cursor
277 @li wxFont: Represents fonts
278 @li wxFontList: The list of previously-created fonts
279 @li wxIcon: A small, transparent bitmap for assigning to frames and drawing on device contexts
280 @li wxImage: A platform-independent image class
281 @li wxImageList: A list of images, used with some controls
282 @li wxMask: Represents a mask to be used with a bitmap for transparent drawing
283 @li wxPen: Used for drawing lines on a device context
284 @li wxPenList: The list of previously-created pens
285 @li wxPalette: Represents a table of indices into RGB values
286 @li wxRegion: Represents a simple or complex region on a window or device context
287 @li wxRendererNative: Abstracts high-level drawing primitives
36c9828f
FM
288
289
15b6757b 290 @section cat_events Events
36c9828f 291
8aa7f32d 292 @ref eventhandling_overview
36c9828f 293
15b6757b 294 An event object contains information about a specific event. Event handlers
36c9828f
FM
295 (usually member functions) have a single, event argument.
296
15b6757b 297 @li wxActivateEvent: A window or application activation event
8aa7f32d 298 @li wxCalendarEvent: Used with wxCalendarCtrl
15b6757b
FM
299 @li wxCalculateLayoutEvent: Used to calculate window layout
300 @li wxChildFocusEvent: A child window focus event
301 @li wxClipboardTextEvent: A clipboard copy/cut/paste treebook event event
302 @li wxCloseEvent: A close window or end session event
303 @li wxCommandEvent: An event from a variety of standard controls
304 @li wxContextMenuEvent: An event generated when the user issues a context menu command
8aa7f32d
FM
305 @li wxDateEvent: Used with wxDatePickerCtrl
306 @li wxDialUpEvent: Event send by wxDialUpManager
15b6757b
FM
307 @li wxDropFilesEvent: A drop files event
308 @li wxEraseEvent: An erase background event
309 @li wxEvent: The event base class
8aa7f32d 310 @li wxFindDialogEvent: Event sent by wxFindReplaceDialog
15b6757b
FM
311 @li wxFocusEvent: A window focus event
312 @li wxKeyEvent: A keypress event
313 @li wxIconizeEvent: An iconize/restore event
314 @li wxIdleEvent: An idle event
315 @li wxInitDialogEvent: A dialog initialisation event
316 @li wxJoystickEvent: A joystick event
317 @li wxListEvent: A list control event
318 @li wxMaximizeEvent: A maximize event
319 @li wxMenuEvent: A menu event
320 @li wxMouseCaptureChangedEvent: A mouse capture changed event
321 @li wxMouseCaptureLostEvent: A mouse capture lost event
322 @li wxMouseEvent: A mouse event
323 @li wxMoveEvent: A move event
324 @li wxNavigationKeyEvent: An event set by navigation keys such as tab
325 @li wxNotebookEvent: A notebook control event
326 @li wxNotifyEvent: A notification event, which can be vetoed
327 @li wxPaintEvent: A paint event
328 @li wxProcessEvent: A process ending event
329 @li wxQueryLayoutInfoEvent: Used to query layout information
330 @li wxRichTextEvent: A rich text editing event
331 @li wxScrollEvent: A scroll event from sliders, stand-alone scrollbars and spin buttons
332 @li wxScrollWinEvent: A scroll event from scrolled windows
333 @li wxSizeEvent: A size event
334 @li wxSocketEvent: A socket event
8aa7f32d
FM
335 @li wxSpinEvent: An event from wxSpinButton
336 @li wxSplitterEvent: An event from wxSplitterWindow
15b6757b
FM
337 @li wxSysColourChangedEvent: A system colour change event
338 @li wxTimerEvent: A timer expiration event
339 @li wxTreebookEvent: A treebook control event
340 @li wxTreeEvent: A tree control event
341 @li wxUpdateUIEvent: A user interface update event
342 @li wxWindowCreateEvent: A window creation event
343 @li wxWindowDestroyEvent: A window destruction event
344 @li wxWizardEvent: A wizard event
36c9828f
FM
345
346
15b6757b 347 @section cat_val Validators
36c9828f 348
8aa7f32d 349 @ref validator_overview
36c9828f 350
15b6757b 351 These are the window validators, used for filtering and validating
36c9828f
FM
352 user input.
353
15b6757b
FM
354 @li wxValidator: Base validator class
355 @li wxTextValidator: Text control validator class
356 @li wxGenericValidator: Generic control validator class
36c9828f
FM
357
358
15b6757b 359 @section cat_data Data structures
36c9828f
FM
360
361 These are the data structure classes supported by wxWidgets.
362
15b6757b
FM
363 @li wxCmdLineParser: Command line parser class
364 @li wxDateSpan: A logical time interval.
365 @li wxDateTime: A class for date/time manipulations
366 @li wxLongLong: A portable 64 bit integer type
367 @li wxObject: The root class for most wxWidgets classes
368 @li wxPathList: A class to help search multiple paths
369 @li wxPoint: Representation of a point
370 @li wxRect: A class representing a rectangle
371 @li wxRegEx: Regular expression support
372 @li wxRegion: A class representing a region
373 @li wxString: A string class
374 @li wxStringTokenizer: A class for interpreting a string as a list of tokens or words
375 @li wxRealPoint: Representation of a point using floating point numbers
376 @li wxSize: Representation of a size
377 @li wxTimeSpan: A time interval.
378 @li wxURI: Represents a Uniform Resource Identifier
379 @li wxVariant: A class for storing arbitrary types that may change at run-time
36c9828f
FM
380
381
15b6757b 382 @section cat_containers Container classes
36c9828f 383
8aa7f32d 384 @ref container_overview
36c9828f 385
15b6757b
FM
386 These are classes, templates and class macros are used by wxWidgets. Most
387 of these classes provide a subset or almost complete STL API.
36c9828f 388
15b6757b 389 @li wxArray<T>: A type-safe dynamic array implementation (macro based)
8aa7f32d 390 @li wxArrayString: An efficient container for storing wxString objects
15b6757b
FM
391 @li wxHashMap<T>: A type-safe hash map implementation (macro based)
392 @li wxHashSet<T>: A type-safe hash set implementation(macro based)
393 @li wxHashTable: A simple hash table implementation (deprecated, use wxHashMap)
394 @li wxList<T>: A type-safe linked list implementation (macro based)
395 @li wxVector<T>: Template base vector implementation identical to std::vector
36c9828f
FM
396
397
15b6757b 398 @section cat_smartpointers Smart pointers
36c9828f 399
15b6757b 400 wxWidgets provides a few smart pointer class templates.
36c9828f 401
15b6757b
FM
402 @li wxObjectDataPtr<T>: A shared pointer (using intrusive reference counting)
403 @li wxScopedPtr<T>: A scoped pointer
404 @li wxSharedPtr<T>: A shared pointer (using non-intrusive reference counting)
405 @li wxWeakRef<T>: A weak reference
36c9828f
FM
406
407
15b6757b 408 @section cat_rtti Run-time class information system
36c9828f 409
8aa7f32d 410 @ref runtimeclass_overview
36c9828f 411
15b6757b 412 wxWidgets supports run-time manipulation of class information, and dynamic
36c9828f
FM
413 creation of objects given class names.
414
15b6757b
FM
415 @li wxClassInfo: Holds run-time class information
416 @li wxObject: Root class for classes with run-time information
417 @li RTTI macros: Macros for manipulating run-time information
36c9828f
FM
418
419
15b6757b 420 @section cat_logging Logging features
36c9828f 421
8aa7f32d 422 @ref log_overview
36c9828f 423
15b6757b 424 wxWidgets provides several classes and functions for message logging.
36c9828f
FM
425 Please see the @ref log_overview for more details.
426
15b6757b
FM
427 @li wxLog: The base log class
428 @li wxLogStderr: Log messages to a C STDIO stream
429 @li wxLogStream: Log messages to a C++ iostream
8aa7f32d 430 @li wxLogTextCtrl: Log messages to a wxTextCtrl
15b6757b
FM
431 @li wxLogWindow: Log messages to a log frame
432 @li wxLogGui: Default log target for GUI programs
433 @li wxLogNull: Temporarily suppress message logging
434 @li wxLogChain: Allows to chain two log targets
435 @li wxLogInterposer: Allows to filter the log messages
436 @li wxLogInterposerTemp: Allows to filter the log messages
8aa7f32d 437 @li wxStreamToTextRedirector: Allows to redirect output sent to @c cout to a wxTextCtrl
15b6757b 438 @li Log functions: Error and warning logging functions
36c9828f
FM
439
440
15b6757b 441 @section cat_debugging Debugging features
36c9828f 442
8aa7f32d 443 @ref debugging_overview
36c9828f 444
15b6757b 445 wxWidgets supports some aspects of debugging an application through
36c9828f
FM
446 classes, functions and macros.
447
15b6757b
FM
448 @li wxDebugContext: Provides memory-checking facilities
449 @li Debugging macros: Debug macros for assertion and checking
a3465294 450 @li WXDEBUG_NEW: Use this macro to give further debugging information
15b6757b
FM
451 @li wxDebugReport: Base class for creating debug reports in case of a program crash.
452 @li wxDebugReportCompress: Class for creating compressed debug reports.
453 @li wxDebugReportUpload: Class for uploading compressed debug reports via HTTP.
454 @li wxDebugReportPreview: Abstract base class for previewing the contents of a debug report.
455 @li wxDebugReportPreviewStd: Standard implementation of wxDebugReportPreview.
36c9828f
FM
456
457
15b6757b 458 @section cat_net Networking classes
36c9828f
FM
459
460 wxWidgets provides its own classes for socket based networking.
461
15b6757b
FM
462 @li wxDialUpManager: Provides functions to check the status of network connection and to establish one
463 @li wxIPV4address: Represents an Internet address
464 @li wxIPaddress: Represents an Internet address
465 @li wxSocketBase: Represents a socket base object
466 @li wxSocketClient: Represents a socket client
467 @li wxSocketServer: Represents a socket server
468 @li wxSocketEvent: A socket event
469 @li wxFTP: FTP protocol class
470 @li wxHTTP: HTTP protocol class
471 @li wxURL: Represents a Universal Resource Locator
36c9828f
FM
472
473
474
15b6757b 475 @section cat_ipc Interprocess communication
36c9828f 476
8aa7f32d 477 @ref ipc_overview
36c9828f 478
15b6757b 479 wxWidgets provides simple interprocess communications facilities
36c9828f
FM
480 based on Windows DDE, but available on most platforms using TCP.
481
15b6757b
FM
482 @li wxClient, wxDDEClient: Represents a client
483 @li wxConnection, wxDDEConnection: Represents the connection between a client and a server
484 @li wxServer, wxDDEServer: Represents a server
36c9828f
FM
485
486
15b6757b
FM
487
488 @section cat_dvf Document-view framework
36c9828f 489
8aa7f32d 490 @ref docview_overview
36c9828f 491
15b6757b 492 wxWidgets supports a document/view framework which provides
36c9828f
FM
493 housekeeping for a document-centric application.
494
15b6757b
FM
495 @li wxDocument: Represents a document
496 @li wxView: Represents a view
497 @li wxDocTemplate: Manages the relationship between a document class and a view class
498 @li wxDocManager: Manages the documents and views in an application
499 @li wxDocChildFrame: A child frame for showing a document view
500 @li wxDocParentFrame: A parent frame to contain views
25c4a27c
FM
501<!-- %@li wxMDIDocChildFrame: An MDI child frame for showing a document view
502 %@li wxMDIDocParentFrame: An MDI parent frame to contain views -->
36c9828f
FM
503
504
15b6757b 505 @section cat_printing Printing framework
36c9828f 506
8aa7f32d 507 @ref printing_overview
36c9828f 508
15b6757b
FM
509 A printing and previewing framework is implemented to
510 make it relatively straightforward to provide document printing
36c9828f
FM
511 facilities.
512
15b6757b
FM
513 @li wxPreviewFrame: Frame for displaying a print preview
514 @li wxPreviewCanvas: Canvas for displaying a print preview
515 @li wxPreviewControlBar: Standard control bar for a print preview
516 @li wxPrintDialog: Standard print dialog
517 @li wxPageSetupDialog: Standard page setup dialog
518 @li wxPrinter: Class representing the printer
519 @li wxPrinterDC: Printer device context
520 @li wxPrintout: Class representing a particular printout
521 @li wxPrintPreview: Class representing a print preview
522 @li wxPrintData: Represents information about the document being printed
523 @li wxPrintDialogData: Represents information about the print dialog
524 @li wxPageSetupDialogData: Represents information about the page setup dialog
36c9828f
FM
525
526
527
15b6757b 528 @section cat_dd Drag and drop and clipboard classes
36c9828f
FM
529
530 @ref dnd_overview
531
15b6757b
FM
532 @li wxDataObject: Data object class
533 @li wxDataFormat: Represents a data format
534 @li wxTextDataObject: Text data object class
535 @li wxFileDataObject: File data object class
536 @li wxBitmapDataObject: Bitmap data object class
537 @li wxURLDataObject: URL data object class
538 @li wxCustomDataObject: Custom data object class
539 @li wxClipboard: Clipboard class
540 @li wxDropTarget: Drop target class
541 @li wxFileDropTarget: File drop target class
542 @li wxTextDropTarget: Text drop target class
543 @li wxDropSource: Drop source class
36c9828f
FM
544
545
15b6757b 546 @section cat_file File related classes
36c9828f 547
15b6757b 548 wxWidgets has several small classes to work with disk files, see wxfileoverview for more details.
36c9828f 549
15b6757b
FM
550 @li wxFileName: Operations with the file name and attributes
551 @li wxDir: Class for enumerating files/subdirectories.
552 @li wxDirTraverser: Class used together with wxDir for recursively enumerating the files/subdirectories
553 @li wxFile: Low-level file input/output class.
554 @li wxFFile: Another low-level file input/output class.
555 @li wxTempFile: Class to safely replace an existing file
556 @li wxTextFile: Class for working with text files as with arrays of lines
557 @li wxStandardPaths: Paths for standard directories
558 @li wxPathList: A class to help search multiple paths
36c9828f
FM
559
560
15b6757b 561 @section cat_streams Stream classes
36c9828f 562
15b6757b
FM
563 wxWidgets has its own set of stream classes, as an alternative to often buggy standard stream
564 libraries, and to provide enhanced functionality.
36c9828f 565
15b6757b
FM
566 @li wxStreamBase: Stream base class
567 @li wxStreamBuffer: Stream buffer class
568 @li wxInputStream: Input stream class
569 @li wxOutputStream: Output stream class
570 @li wxCountingOutputStream: Stream class for querying what size a stream would have.
571 @li wxFilterInputStream: Filtered input stream class
572 @li wxFilterOutputStream: Filtered output stream class
573 @li wxBufferedInputStream: Buffered input stream class
574 @li wxBufferedOutputStream: Buffered output stream class
575 @li wxMemoryInputStream: Memory input stream class
576 @li wxMemoryOutputStream: Memory output stream class
577 @li wxDataInputStream: Platform-independent binary data input stream class
578 @li wxDataOutputStream: Platform-independent binary data output stream class
579 @li wxTextInputStream: Platform-independent text data input stream class
580 @li wxTextOutputStream: Platform-independent text data output stream class
581 @li wxFileInputStream: File input stream class
582 @li wxFileOutputStream: File output stream class
583 @li wxFFileInputStream: Another file input stream class
584 @li wxFFileOutputStream: Another file output stream class
585 @li wxTempFileOutputStream: Stream to safely replace an existing file
586 @li wxStringInputStream: String input stream class
587 @li wxStringOutputStream: String output stream class
588 @li wxZlibInputStream: Zlib and gzip (compression) input stream class
589 @li wxZlibOutputStream: Zlib and gzip (compression) output stream class
590 @li wxZipInputStream: Input stream for reading from ZIP archives
591 @li wxZipOutputStream: Output stream for writing from ZIP archives
592 @li wxTarInputStream: Input stream for reading from tar archives
593 @li wxTarOutputStream: Output stream for writing from tar archives
594 @li wxSocketInputStream: Socket input stream class
595 @li wxSocketOutputStream: Socket output stream class
36c9828f
FM
596
597
15b6757b 598 @section cat_threading Threading classes
36c9828f 599
8aa7f32d 600 @ref thread_overview
36c9828f 601
15b6757b
FM
602 wxWidgets provides a set of classes to make use of the native thread
603 capabilities of the various platforms.
36c9828f 604
15b6757b
FM
605 @li wxThread: Thread class
606 @li wxThreadHelper: Manages background threads easily
607 @li wxMutex: Mutex class
608 @li wxMutexLocker: Mutex locker utility class
609 @li wxCriticalSection: Critical section class
610 @li wxCriticalSectionLocker: Critical section locker utility class
611 @li wxCondition: Condition class
612 @li wxSemaphore: Semaphore class
36c9828f
FM
613
614
15b6757b 615 @section cat_html HTML classes
36c9828f 616
15b6757b
FM
617 wxWidgets provides a set of classes to display text in HTML format. These
618 class include a help system based on the HTML widget.
36c9828f 619
15b6757b
FM
620 @li wxHtmlHelpController: HTML help controller class
621 @li wxHtmlWindow: HTML window class
622 @li wxHtmlEasyPrinting: Simple class for printing HTML
623 @li wxHtmlPrintout: Generic HTML wxPrintout class
624 @li wxHtmlParser: Generic HTML parser class
625 @li wxHtmlTagHandler: HTML tag handler, pluginable into wxHtmlParser
626 @li wxHtmlWinParser: HTML parser class for wxHtmlWindow
627 @li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser
36c9828f
FM
628
629
15b6757b 630 @section cat_rich Rich text classes
36c9828f 631
15b6757b
FM
632 wxWidgets provides a set of generic classes to edit and print simple rich text with character
633 and paragraph formatting.
36c9828f 634
15b6757b
FM
635 @li wxTextAttr: Attributes specifying text styling.
636 @li wxRichTextCtrl: A rich text control.
637 @li wxRichTextBuffer: The content of a rich text control.
638 @li wxRichTextCharacterStyleDefinition: Definition of character styling.
639 @li wxRichTextParagraphStyleDefinition: Definition of paragraph styling.
640 @li wxRichTextListStyleDefinition: Definition of list styling.
641 @li wxRichTextStyleSheet: A set of style definitions.
642 @li wxRichTextStyleComboCtrl: A drop-down control for applying styles.
643 @li wxRichTextStyleListBox: A listbox for applying styles.
644 @li wxRichTextStyleOrganiserDialog: A dialog that can be used for managing or browsing styles.
645 @li wxRichTextEvent: A rich text event.
646 @li wxRichTextRange: Specification for ranges in a rich text control or buffer.
647 @li wxRichTextFileHandler: File handler base class.
648 @li wxRichTextHTMLHandler: A handler for converting rich text to HTML.
649 @li wxRichTextXMLHandler: A handler for loading and saving rich text XML.
650 @li wxRichTextFormattingDialog: A dialog for rich text formatting.
651 @li wxRichTextPrinting: A class for easy printing of rich text buffers.
652 @li wxRichTextPrintout: A class used by wxRichTextPrinting.
653 @li wxRichTextHeaderFooterData: Header and footer data specification.
36c9828f
FM
654
655
15b6757b 656 @section cat_stc Scintilla text editor classes
36c9828f 657
15b6757b
FM
658 wxWidgets also provides a wrapper around the Scintilla text editor control, which is
659 a control for plain-text editing with support for highlighting, smart indentation, etc.
36c9828f 660
15b6757b 661 @li wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code editing component.
36c9828f
FM
662
663
15b6757b 664 @section cat_vfs Virtual file system classes
36c9828f 665
15b6757b
FM
666 wxWidgets provides a set of classes that implement an extensible virtual file system,
667 used internally by the HTML classes.
36c9828f 668
15b6757b
FM
669 @li wxFSFile: Represents a file in the virtual file system
670 @li wxFileSystem: Main interface for the virtual file system
671 @li wxFileSystemHandler: Class used to announce file system type
36c9828f
FM
672
673
15b6757b 674 @section cat_xml XML classes
36c9828f 675
15b6757b
FM
676 @li wxXmlDocument: A class to parse XML files
677 @li wxXmlNode: A class which represents XML nodes
678 @li wxXmlAttribute: A class which represent an XML attribute
36c9828f
FM
679
680
15b6757b 681 @section cat_xrc XML-based resource system classes
36c9828f 682
8aa7f32d 683 @ref xrc_overview
36c9828f 684
15b6757b
FM
685 Resources allow your application to create controls and other user interface elements
686 from specifications stored in an XML format.
36c9828f 687
15b6757b
FM
688 @li wxXmlResource: The main class for working with resources
689 @li wxXmlResourceHandler: The base class for XML resource handlers
36c9828f
FM
690
691
15b6757b 692 @section cat_help Online help
36c9828f 693
15b6757b
FM
694 @li wxHelpController: Family of classes for controlling help windows
695 @li wxHtmlHelpController: HTML help controller class
696 @li wxContextHelp: Class to put application into context-sensitive help mode
697 @li wxContextHelpButton: Button class for putting application into context-sensitive help mode
698 @li wxHelpProvider: Abstract class for context-sensitive help provision
699 @li wxSimpleHelpProvider: Class for simple context-sensitive help provision
700 @li wxHelpControllerHelpProvider: Class for context-sensitive help provision via a help controller
701 @li wxToolTip: Class implementing tooltips
36c9828f
FM
702
703
15b6757b 704 @section cat_media Multimedia classes
36c9828f 705
15b6757b 706 @li wxMediaCtrl: Display multimedia contents.
36c9828f
FM
707
708
15b6757b 709 @section cat_gl OpenGL classes
36c9828f 710
15b6757b
FM
711 @li wxGLCanvas: Canvas that you can render OpenGL calls to.
712 @li wxGLContext: Class to ease sharing of OpenGL data resources.
36c9828f
FM
713
714
15b6757b 715 @section cat_appmanagement Application and process-management classes
36c9828f 716
15b6757b
FM
717 @li wxApp: Application class
718 @li wxCmdLineParser: Command line parser class
719 @li wxDllLoader: Class to work with shared libraries.
720 @li wxProcess: Process class
36c9828f
FM
721
722
15b6757b 723 @section cat_misc Miscellaneous
36c9828f 724
15b6757b 725 @li wxCaret: A caret (cursor) object
00e4f098 726 @li wxConfigBase: Classes for reading/writing the configuration settings
15b6757b
FM
727 @li wxTimer: Timer class
728 @li wxStopWatch: Stop watch class
729 @li wxMimeTypesManager: MIME-types manager class
730 @li wxSystemSettings: System settings class for obtaining various global parameters
731 @li wxSystemOptions: System options class for run-time configuration
732 @li wxAcceleratorTable: Accelerator table
733 @li wxAutomationObject: OLE automation class
734 @li wxFontMapper: Font mapping, finding suitable font for given encoding
735 @li wxEncodingConverter: Encoding conversions
8aa7f32d 736 @li wxCalendarDateAttr: Used with wxCalendarCtrl
15b6757b
FM
737 @li wxQuantize: Class to perform quantization, or colour reduction
738 @li wxSingleInstanceChecker: Check that only single program instance is running
739
740*/