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