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