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