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