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