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