]>
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 $ | |
526954c5 | 6 | // Licence: wxWindows licence |
29f86fc1 BP |
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 | |
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 | 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 | |
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 |
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 | |
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ç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 | ||
204 | These are the window validators, used for filtering and validating user input. | |
205 | ||
206 | Related 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 | |
211 | ||
212 | ||
213 | ||
29f86fc1 BP |
214 | @section page_class_cat_pickers Picker Controls |
215 | ||
216 | A picker control is a control whose appearance and behaviour is highly | |
217 | platform-dependent. | |
218 | ||
219 | @li wxColourPickerCtrl: A control which allows the user to choose a colour | |
220 | @li wxDirPickerCtrl: A control which allows the user to choose a directory | |
221 | @li wxFilePickerCtrl: A control which allows the user to choose a file | |
222 | @li wxFontPickerCtrl: A control which allows the user to choose a font | |
223 | @li wxDatePickerCtrl: Small date picker control | |
224 | ||
225 | ||
226 | ||
557563c8 | 227 | @section page_class_cat_miscwnd Miscellaneous Windows |
29f86fc1 | 228 | |
557563c8 RR |
229 | The following are a variety of classes that are derived from wxWindow. |
230 | ||
d23914f8 | 231 | @li wxCollapsiblePane: A panel which can be shown/hidden by the user |
557563c8 | 232 | @li wxPanel: A window whose colour changes according to current user settings |
f09b5681 BP |
233 | @li ::wxScrolledWindow: Window with automatically managed scrollbars (see |
234 | wxScrolled) | |
235 | @li wxHScrolledWindow: As ::wxScrolledWindow but supports columns of variable | |
236 | widths | |
237 | @li wxVScrolledWindow: As ::wxScrolledWindow but supports rows of variable | |
238 | heights | |
239 | @li wxHVScrolledWindow: As ::wxScrolledWindow but supports scroll units of | |
240 | variable sizes. | |
557563c8 | 241 | @li wxGrid: A grid (table) window |
a92b5dfe | 242 | @li wxInfoBar: An information bar usually shown on top of the main window. |
557563c8 RR |
243 | @li wxSplitterWindow: Window which can be split vertically or horizontally |
244 | @li wxStatusBar: Implements the status bar on a frame | |
245 | @li wxToolBar: Toolbar class | |
246 | @li wxNotebook: Notebook class | |
247 | @li wxListbook: Similar to notebook but using list control | |
248 | @li wxChoicebook: Similar to notebook but using choice control | |
249 | @li wxTreebook: Similar to notebook but using tree control | |
250 | @li wxSashWindow: Window with four optional sashes that can be dragged | |
251 | @li wxSashLayoutWindow: Window that can be involved in an IDE-like layout | |
252 | arrangement | |
557563c8 RR |
253 | @li wxWizardPage: A base class for the page in wizard dialog. |
254 | @li wxWizardPageSimple: A page in wizard dialog. | |
255 | ||
256 | ||
257 | ||
258 | @section page_class_cat_aui Window Docking (wxAUI) | |
259 | ||
260 | wxAUI is a set classes for writing a customizable application interface | |
261 | with built-in docking, floatable panes and a flexible MDI-like interface. | |
262 | ||
263 | Related Overviews: @ref overview_aui | |
264 | ||
265 | @li wxAuiManager: The central class for managing the interface | |
266 | @li wxAuiNotebook: A replacement notebook class with extra features | |
267 | @li wxAuiPaneInfo: Describes a single pane | |
268 | @li wxAuiDockArt: Art and metrics provider for customizing the docking user | |
269 | interface | |
270 | @li wxAuiTabArt: Art and metrics provider for customizing the notebook user | |
271 | interface | |
272 | ||
273 | ||
274 | ||
275 | @section page_class_cat_cmndlg Common Dialogs | |
276 | ||
277 | Common dialogs are ready-made dialog classes which are frequently used in an | |
278 | application. | |
279 | ||
280 | Related Overviews: @ref overview_cmndlg | |
281 | ||
282 | @li wxDialog: Base class for common dialogs | |
283 | @li wxColourDialog: Colour chooser dialog | |
284 | @li wxDirDialog: Directory selector dialog | |
285 | @li wxFileDialog: File selector dialog | |
286 | @li wxFindReplaceDialog: Text search/replace dialog | |
557563c8 | 287 | @li wxFontDialog: Font chooser dialog |
98b2861b RR |
288 | @li wxMessageDialog: Simple message box dialog |
289 | @li wxMultiChoiceDialog: Dialog to get one or more selections from a list | |
557563c8 | 290 | @li wxPageSetupDialog: Standard page setup dialog |
98b2861b | 291 | @li wxPasswordEntryDialog: Dialog to get a password from the user |
557563c8 RR |
292 | @li wxPrintDialog: Standard print dialog |
293 | @li wxProgressDialog: Progress indication dialog | |
98b2861b | 294 | @li wxRearrangeDialog: Dialog allowing the user to rearrange a list of items. |
557563c8 RR |
295 | @li wxRichTextFormattingDialog: A dialog for formatting the content of a |
296 | wxRichTextCtrl | |
0800eb84 | 297 | @li wxRichMessageDialog: Nicer message box dialog |
98b2861b RR |
298 | @li wxSingleChoiceDialog: Dialog to get a single selection from a list and |
299 | return the string | |
300 | @li wxSymbolPickerDialog: Symbol selector dialog | |
301 | @li wxTextEntryDialog: Dialog to get a single line of text from the user | |
557563c8 RR |
302 | @li wxWizard: A wizard dialog. |
303 | ||
304 | ||
305 | ||
306 | @section page_class_cat_html HTML | |
307 | ||
308 | wxWidgets provides a set of classes to display text in HTML format. These | |
309 | classes include a help system based on the HTML widget. | |
310 | ||
311 | @li wxHtmlHelpController: HTML help controller class | |
312 | @li wxHtmlWindow: HTML window class | |
313 | @li wxHtmlEasyPrinting: Simple class for printing HTML | |
314 | @li wxHtmlPrintout: Generic HTML wxPrintout class | |
315 | @li wxHtmlParser: Generic HTML parser class | |
316 | @li wxHtmlTagHandler: HTML tag handler, pluginable into wxHtmlParser | |
317 | @li wxHtmlWinParser: HTML parser class for wxHtmlWindow | |
318 | @li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser | |
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 | ||
830b7aa7 | 411 | Related Overviews: @ref overview_events |
29f86fc1 BP |
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 | |
9e0ed083 | 434 | @li wxKeyboardState: State of the keyboard modifiers. |
29f86fc1 BP |
435 | @li wxListEvent: A list control event |
436 | @li wxMaximizeEvent: A maximize event | |
437 | @li wxMenuEvent: A menu event | |
438 | @li wxMouseCaptureChangedEvent: A mouse capture changed event | |
439 | @li wxMouseCaptureLostEvent: A mouse capture lost event | |
440 | @li wxMouseEvent: A mouse event | |
9e0ed083 | 441 | @li wxMouseState: State of the mouse |
29f86fc1 BP |
442 | @li wxMoveEvent: A move event |
443 | @li wxNavigationKeyEvent: An event set by navigation keys such as tab | |
444 | @li wxNotebookEvent: A notebook control event | |
445 | @li wxNotifyEvent: A notification event, which can be vetoed | |
446 | @li wxPaintEvent: A paint event | |
447 | @li wxProcessEvent: A process ending event | |
448 | @li wxQueryLayoutInfoEvent: Used to query layout information | |
449 | @li wxRichTextEvent: A rich text editing event | |
450 | @li wxScrollEvent: A scroll event from sliders, stand-alone scrollbars and spin | |
451 | buttons | |
452 | @li wxScrollWinEvent: A scroll event from scrolled windows | |
453 | @li wxSizeEvent: A size event | |
454 | @li wxSocketEvent: A socket event | |
455 | @li wxSpinEvent: An event from wxSpinButton | |
456 | @li wxSplitterEvent: An event from wxSplitterWindow | |
457 | @li wxSysColourChangedEvent: A system colour change event | |
458 | @li wxTimerEvent: A timer expiration event | |
459 | @li wxTreebookEvent: A treebook control event | |
460 | @li wxTreeEvent: A tree control event | |
461 | @li wxUpdateUIEvent: A user interface update event | |
462 | @li wxWindowCreateEvent: A window creation event | |
463 | @li wxWindowDestroyEvent: A window destruction event | |
464 | @li wxWizardEvent: A wizard event | |
465 | ||
466 | ||
467 | ||
7ac7b533 | 468 | @section page_class_cat_appmanagement Application and Process Management |
29f86fc1 | 469 | |
7ac7b533 | 470 | @li wxApp: Application class |
29f86fc1 | 471 | @li wxCmdLineParser: Command line parser class |
09ad05fa | 472 | @li wxDynamicLibrary: Class to work with shared libraries. |
7ac7b533 | 473 | @li wxProcess: Process class |
29f86fc1 BP |
474 | |
475 | ||
476 | ||
7ac7b533 | 477 | @section page_class_cat_printing Printing Framework |
29f86fc1 | 478 | |
7ac7b533 RR |
479 | A printing and previewing framework is implemented to make it relatively |
480 | straightforward to provide document printing facilities. | |
29f86fc1 | 481 | |
7ac7b533 | 482 | Related Overviews: @ref overview_printing |
29f86fc1 | 483 | |
7ac7b533 RR |
484 | @li wxPreviewFrame: Frame for displaying a print preview |
485 | @li wxPreviewCanvas: Canvas for displaying a print preview | |
486 | @li wxPreviewControlBar: Standard control bar for a print preview | |
487 | @li wxPrintDialog: Standard print dialog | |
488 | @li wxPageSetupDialog: Standard page setup dialog | |
489 | @li wxPrinter: Class representing the printer | |
490 | @li wxPrinterDC: Printer device context | |
491 | @li wxPrintout: Class representing a particular printout | |
492 | @li wxPrintPreview: Class representing a print preview | |
493 | @li wxPrintData: Represents information about the document being printed | |
494 | @li wxPrintDialogData: Represents information about the print dialog | |
495 | @li wxPageSetupDialogData: Represents information about the page setup dialog | |
29f86fc1 BP |
496 | |
497 | ||
498 | ||
7ac7b533 | 499 | @section page_class_cat_dvf Document/View Framework |
29f86fc1 | 500 | |
7ac7b533 RR |
501 | wxWidgets supports a document/view framework which provides housekeeping for a |
502 | document-centric application. | |
29f86fc1 | 503 | |
7ac7b533 | 504 | Related Overviews: @ref overview_docview |
29f86fc1 | 505 | |
7ac7b533 RR |
506 | @li wxCommand: Base class for undo/redo actions |
507 | @li wxCommandProcessor: Maintains the undo/redo stack | |
508 | @li wxDocument: Represents a document | |
509 | @li wxView: Represents a view | |
510 | @li wxDocTemplate: Manages the relationship between a document class and a | |
511 | view class | |
512 | @li wxDocManager: Manages the documents and views in an application | |
513 | @li wxDocChildFrame: A child frame for showing a document view | |
514 | @li wxDocParentFrame: A parent frame to contain views | |
515 | @li wxDocMDIChildFrame: An MDI child frame for showing a document view | |
516 | @li wxDocMDIParentFrame: An MDI parent frame to contain views | |
517 | @li wxFileHistory: Maintains a list of the most recently visited files | |
29f86fc1 BP |
518 | |
519 | ||
29f86fc1 | 520 | |
7ac7b533 | 521 | @section page_class_cat_dnd Clipboard and Drag & Drop |
29f86fc1 | 522 | |
7ac7b533 | 523 | Related Overviews: @ref overview_dnd |
29f86fc1 | 524 | |
7ac7b533 RR |
525 | @li wxDataObject: Data object class |
526 | @li wxDataFormat: Represents a data format | |
527 | @li wxTextDataObject: Text data object class | |
528 | @li wxFileDataObject: File data object class | |
529 | @li wxBitmapDataObject: Bitmap data object class | |
530 | @li wxURLDataObject: URL data object class | |
531 | @li wxCustomDataObject: Custom data object class | |
532 | @li wxClipboard: Clipboard class | |
533 | @li wxDropTarget: Drop target class | |
534 | @li wxFileDropTarget: File drop target class | |
535 | @li wxTextDropTarget: Text drop target class | |
536 | @li wxDropSource: Drop source class | |
29f86fc1 | 537 | |
7ac7b533 RR |
538 | |
539 | ||
540 | @section page_class_cat_vfs Virtual File System | |
541 | ||
542 | wxWidgets provides a set of classes that implement an extensible virtual file | |
543 | system, used internally by the HTML classes. | |
544 | ||
545 | @li wxFSFile: Represents a file in the virtual file system | |
546 | @li wxFileSystem: Main interface for the virtual file system | |
547 | @li wxFileSystemHandler: Class used to announce file system type | |
548 | ||
549 | ||
550 | ||
c7d4ca81 RR |
551 | @section page_class_cat_threading Threading |
552 | ||
553 | wxWidgets provides a set of classes to make use of the native thread | |
554 | capabilities of the various platforms. | |
555 | ||
556 | Related Overviews: @ref overview_thread | |
557 | ||
558 | @li wxThread: Thread class | |
559 | @li wxThreadHelper: Manages background threads easily | |
560 | @li wxMutex: Mutex class | |
561 | @li wxMutexLocker: Mutex locker utility class | |
562 | @li wxCriticalSection: Critical section class | |
563 | @li wxCriticalSectionLocker: Critical section locker utility class | |
564 | @li wxCondition: Condition class | |
565 | @li wxSemaphore: Semaphore class | |
566 | ||
567 | ||
568 | ||
7ac7b533 RR |
569 | @section page_class_cat_rtti Runtime Type Information (RTTI) |
570 | ||
571 | wxWidgets supports runtime manipulation of class information, and dynamic | |
572 | creation of objects given class names. | |
573 | ||
574 | Related Overviews: @ref overview_rtti | |
575 | ||
576 | @see @ref group_funcmacro_rtti "RTTI Functions and Macros" | |
577 | ||
578 | @li wxClassInfo: Holds runtime class information | |
579 | @li wxObject: Root class for classes with runtime information | |
29f86fc1 BP |
580 | |
581 | ||
582 | ||
583 | @section page_class_cat_debugging Debugging | |
584 | ||
585 | wxWidgets supports some aspects of debugging an application through classes, | |
586 | functions and macros. | |
587 | ||
588 | Related Overviews: @ref overview_debugging | |
589 | ||
590 | @see @ref group_funcmacro_debug "Debugging Functions and Macros" | |
591 | ||
592 | @li wxDebugContext: Provides memory-checking facilities | |
593 | @li wxDebugReport: Base class for creating debug reports in case of a program | |
594 | crash. | |
595 | @li wxDebugReportCompress: Class for creating compressed debug reports. | |
596 | @li wxDebugReportUpload: Class for uploading compressed debug reports via HTTP. | |
597 | @li wxDebugReportPreview: Abstract base class for previewing the contents of a | |
598 | debug report. | |
599 | @li wxDebugReportPreviewStd: Standard implementation of wxDebugReportPreview. | |
600 | ||
601 | ||
602 | ||
7ac7b533 | 603 | @section page_class_cat_logging Logging |
29f86fc1 | 604 | |
7ac7b533 | 605 | wxWidgets provides several classes and functions for message logging. |
29f86fc1 | 606 | |
673453e2 | 607 | Related overview: @ref overview_log |
29f86fc1 | 608 | |
7ac7b533 | 609 | @see @ref group_funcmacro_log "Logging Functions and Macros" |
29f86fc1 | 610 | |
7ac7b533 RR |
611 | @li wxLog: The base log class |
612 | @li wxLogStderr: Log messages to a C STDIO stream | |
613 | @li wxLogStream: Log messages to a C++ iostream | |
614 | @li wxLogTextCtrl: Log messages to a wxTextCtrl | |
615 | @li wxLogWindow: Log messages to a log frame | |
616 | @li wxLogGui: Default log target for GUI programs | |
617 | @li wxLogNull: Temporarily suppress message logging | |
618 | @li wxLogChain: Allows to chain two log targets | |
619 | @li wxLogInterposer: Allows to filter the log messages | |
620 | @li wxLogInterposerTemp: Allows to filter the log messages | |
621 | @li wxStreamToTextRedirector: Allows to redirect output sent to @c cout to a wxTextCtrl | |
29f86fc1 | 622 | |
29f86fc1 | 623 | |
29f86fc1 | 624 | |
7ac7b533 | 625 | @section page_class_cat_data Data Structures |
29f86fc1 | 626 | |
7ac7b533 | 627 | These are the data structure classes supported by wxWidgets. |
29f86fc1 | 628 | |
178c7760 | 629 | @li wxAny: A class for storing arbitrary types that may change at run-time |
7ac7b533 RR |
630 | @li wxCmdLineParser: Command line parser class |
631 | @li wxDateSpan: A logical time interval. | |
632 | @li wxDateTime: A class for date/time manipulations | |
633 | @li wxLongLong: A portable 64 bit integer type | |
634 | @li wxObject: The root class for most wxWidgets classes | |
635 | @li wxPathList: A class to help search multiple paths | |
636 | @li wxPoint: Representation of a point | |
637 | @li wxRect: A class representing a rectangle | |
638 | @li wxRegEx: Regular expression support | |
639 | @li wxRegion: A class representing a region | |
640 | @li wxString: A string class | |
641 | @li wxStringTokenizer: A class for interpreting a string as a list of tokens or | |
642 | words | |
643 | @li wxRealPoint: Representation of a point using floating point numbers | |
644 | @li wxSize: Representation of a size | |
645 | @li wxTimeSpan: A time interval. | |
646 | @li wxURI: Represents a Uniform Resource Identifier | |
647 | @li wxVariant: A class for storing arbitrary types that may change at run-time | |
29f86fc1 BP |
648 | |
649 | ||
650 | ||
79b40dcf VZ |
651 | @section page_class_cat_conv Text Conversion |
652 | ||
653 | These classes define objects for performing conversions between different | |
654 | multibyte and Unicode encodings and wide character strings. | |
655 | ||
656 | @li wxMBConv: Base class for all convertors, defines the API implemented by all | |
657 | the other convertor classes. | |
658 | @li wxMBConvUTF7: Convertor for UTF-7 | |
659 | @li wxMBConvUTF8: Convertor for UTF-8 | |
660 | @li wxMBConvUTF16: Convertor for UTF-16 | |
661 | @li wxMBConvUTF32: Convertor for UTF-32 | |
662 | @li wxCSConv: Convertor for any system-supported encoding which can be | |
663 | specified by name. | |
664 | ||
665 | Related Overviews: @ref overview_mbconv | |
666 | ||
667 | ||
7ac7b533 | 668 | @section page_class_cat_containers Containers |
29f86fc1 | 669 | |
7ac7b533 RR |
670 | These are classes, templates and class macros are used by wxWidgets. Most of |
671 | these classes provide a subset or almost complete STL API. | |
29f86fc1 | 672 | |
7ac7b533 | 673 | Related Overviews: @ref overview_container |
29f86fc1 | 674 | |
7ac7b533 RR |
675 | @li wxArray<T>: A type-safe dynamic array implementation (macro based) |
676 | @li wxArrayString: An efficient container for storing wxString objects | |
677 | @li wxHashMap<T>: A type-safe hash map implementation (macro based) | |
678 | @li wxHashSet<T>: A type-safe hash set implementation(macro based) | |
679 | @li wxHashTable: A simple hash table implementation (deprecated, use wxHashMap) | |
680 | @li wxList<T>: A type-safe linked list implementation (macro based) | |
681 | @li wxVector<T>: Template base vector implementation identical to std::vector | |
29f86fc1 BP |
682 | |
683 | ||
684 | ||
7ac7b533 | 685 | @section page_class_cat_smartpointers Smart Pointers |
29f86fc1 | 686 | |
7ac7b533 | 687 | wxWidgets provides a few smart pointer class templates. |
29f86fc1 | 688 | |
7ac7b533 RR |
689 | @li wxObjectDataPtr<T>: A shared pointer (using intrusive reference counting) |
690 | @li wxScopedPtr<T>: A scoped pointer | |
691 | @li wxSharedPtr<T>: A shared pointer (using non-intrusive reference counting) | |
692 | @li wxWeakRef<T>: A weak reference | |
29f86fc1 BP |
693 | |
694 | ||
695 | ||
696 | @section page_class_cat_file File Handling | |
697 | ||
698 | wxWidgets has several small classes to work with disk files and directories. | |
699 | ||
673453e2 | 700 | Related overview: @ref overview_file |
29f86fc1 BP |
701 | |
702 | @li wxFileName: Operations with the file name and attributes | |
703 | @li wxDir: Class for enumerating files/subdirectories. | |
704 | @li wxDirTraverser: Class used together with wxDir for recursively enumerating | |
705 | the files/subdirectories | |
706 | @li wxFile: Low-level file input/output class. | |
707 | @li wxFFile: Another low-level file input/output class. | |
708 | @li wxTempFile: Class to safely replace an existing file | |
709 | @li wxTextFile: Class for working with text files as with arrays of lines | |
710 | @li wxStandardPaths: Paths for standard directories | |
711 | @li wxPathList: A class to help search multiple paths | |
6b8ef0b3 | 712 | @li wxFileSystemWatcher: Class providing notifications of file system changes |
29f86fc1 BP |
713 | |
714 | ||
715 | ||
29f86fc1 BP |
716 | @section page_class_cat_streams Streams |
717 | ||
673453e2 RR |
718 | wxWidgets has its own set of stream classes as an alternative to the |
719 | standard stream libraries and to provide enhanced functionality. | |
720 | ||
721 | Related overview: @ref overview_stream | |
29f86fc1 BP |
722 | |
723 | @li wxStreamBase: Stream base class | |
724 | @li wxStreamBuffer: Stream buffer class | |
725 | @li wxInputStream: Input stream class | |
726 | @li wxOutputStream: Output stream class | |
727 | @li wxCountingOutputStream: Stream class for querying what size a stream would | |
728 | have. | |
729 | @li wxFilterInputStream: Filtered input stream class | |
730 | @li wxFilterOutputStream: Filtered output stream class | |
731 | @li wxBufferedInputStream: Buffered input stream class | |
732 | @li wxBufferedOutputStream: Buffered output stream class | |
733 | @li wxMemoryInputStream: Memory input stream class | |
734 | @li wxMemoryOutputStream: Memory output stream class | |
735 | @li wxDataInputStream: Platform-independent binary data input stream class | |
736 | @li wxDataOutputStream: Platform-independent binary data output stream class | |
737 | @li wxTextInputStream: Platform-independent text data input stream class | |
738 | @li wxTextOutputStream: Platform-independent text data output stream class | |
739 | @li wxFileInputStream: File input stream class | |
740 | @li wxFileOutputStream: File output stream class | |
741 | @li wxFFileInputStream: Another file input stream class | |
742 | @li wxFFileOutputStream: Another file output stream class | |
743 | @li wxTempFileOutputStream: Stream to safely replace an existing file | |
744 | @li wxStringInputStream: String input stream class | |
745 | @li wxStringOutputStream: String output stream class | |
746 | @li wxZlibInputStream: Zlib and gzip (compression) input stream class | |
747 | @li wxZlibOutputStream: Zlib and gzip (compression) output stream class | |
748 | @li wxZipInputStream: Input stream for reading from ZIP archives | |
749 | @li wxZipOutputStream: Output stream for writing from ZIP archives | |
750 | @li wxTarInputStream: Input stream for reading from tar archives | |
751 | @li wxTarOutputStream: Output stream for writing from tar archives | |
752 | @li wxSocketInputStream: Socket input stream class | |
753 | @li wxSocketOutputStream: Socket output stream class | |
754 | ||
755 | ||
756 | ||
7ac7b533 | 757 | @section page_class_cat_xml XML |
29f86fc1 | 758 | |
7ac7b533 RR |
759 | @li wxXmlDocument: A class to parse XML files |
760 | @li wxXmlNode: A class which represents XML nodes | |
761 | @li wxXmlAttribute: A class which represent an XML attribute | |
29f86fc1 | 762 | |
29f86fc1 | 763 | |
29f86fc1 | 764 | |
7ac7b533 | 765 | @section page_class_cat_archive Archive |
29f86fc1 | 766 | |
7ac7b533 RR |
767 | @li wxArchiveInputStream |
768 | @li wxArchiveOutputStream | |
769 | @li wxArchiveEntry | |
29f86fc1 | 770 | |
29f86fc1 | 771 | |
29f86fc1 | 772 | |
1c9ac9a8 RR |
773 | @section page_class_cat_xrc XML Based Resource System (XRC) |
774 | ||
775 | Resources allow your application to create controls and other user interface | |
776 | elements from specifications stored in an XML format. | |
777 | ||
673453e2 | 778 | Related overview: @ref overview_xrc |
1c9ac9a8 RR |
779 | |
780 | @li wxXmlResource: The main class for working with resources | |
781 | @li wxXmlResourceHandler: The base class for XML resource handlers | |
782 | ||
783 | ||
29f86fc1 | 784 | |
7ac7b533 | 785 | @section page_class_cat_net Networking |
29f86fc1 | 786 | |
7ac7b533 | 787 | wxWidgets provides its own classes for socket based networking. |
29f86fc1 | 788 | |
7ac7b533 RR |
789 | @li wxDialUpManager: Provides functions to check the status of network |
790 | connection and to establish one | |
791 | @li wxIPV4address: Represents an Internet address | |
792 | @li wxIPaddress: Represents an Internet address | |
793 | @li wxSocketBase: Represents a socket base object | |
794 | @li wxSocketClient: Represents a socket client | |
795 | @li wxSocketServer: Represents a socket server | |
796 | @li wxSocketEvent: A socket event | |
797 | @li wxFTP: FTP protocol class | |
798 | @li wxHTTP: HTTP protocol class | |
799 | @li wxURL: Represents a Universal Resource Locator | |
29f86fc1 BP |
800 | |
801 | ||
29f86fc1 | 802 | |
7ac7b533 | 803 | @section page_class_cat_ipc Interprocess Communication |
29f86fc1 | 804 | |
7ac7b533 RR |
805 | wxWidgets provides simple interprocess communications facilities based on |
806 | Windows DDE, but available on most platforms using TCP. | |
807 | ||
673453e2 | 808 | Related overview: @ref overview_ipc |
7ac7b533 RR |
809 | |
810 | @li wxClient, wxDDEClient: Represents a client | |
811 | @li wxConnection, wxDDEConnection: Represents the connection between a client | |
812 | and a server | |
813 | @li wxServer, wxDDEServer: Represents a server | |
29f86fc1 BP |
814 | |
815 | ||
29f86fc1 | 816 | |
29f86fc1 BP |
817 | @section page_class_cat_help Help |
818 | ||
819 | @li wxHelpController: Family of classes for controlling help windows | |
820 | @li wxHtmlHelpController: HTML help controller class | |
821 | @li wxContextHelp: Class to put application into context-sensitive help mode | |
822 | @li wxContextHelpButton: Button class for putting application into | |
823 | context-sensitive help mode | |
824 | @li wxHelpProvider: Abstract class for context-sensitive help provision | |
825 | @li wxSimpleHelpProvider: Class for simple context-sensitive help provision | |
826 | @li wxHelpControllerHelpProvider: Class for context-sensitive help provision | |
827 | via a help controller | |
828 | @li wxToolTip: Class implementing tooltips | |
829 | ||
830 | ||
831 | ||
832 | @section page_class_cat_media Multimedia | |
833 | ||
834 | @li wxMediaCtrl: Display multimedia contents. | |
835 | ||
836 | ||
837 | ||
838 | @section page_class_cat_gl OpenGL | |
839 | ||
840 | @li wxGLCanvas: Canvas that you can render OpenGL calls to. | |
841 | @li wxGLContext: Class to ease sharing of OpenGL data resources. | |
842 | ||
843 | ||
844 | ||
29f86fc1 BP |
845 | @section page_class_cat_misc Miscellaneous |
846 | ||
847 | @li wxCaret: A caret (cursor) object | |
848 | @li wxConfigBase: Classes for reading/writing the configuration settings | |
849 | @li wxTimer: Timer class | |
850 | @li wxStopWatch: Stop watch class | |
851 | @li wxMimeTypesManager: MIME-types manager class | |
852 | @li wxSystemSettings: System settings class for obtaining various global | |
853 | parameters | |
854 | @li wxSystemOptions: System options class for run-time configuration | |
855 | @li wxAcceleratorTable: Accelerator table | |
856 | @li wxAutomationObject: OLE automation class | |
857 | @li wxFontMapper: Font mapping, finding suitable font for given encoding | |
858 | @li wxEncodingConverter: Encoding conversions | |
859 | @li wxCalendarDateAttr: Used with wxCalendarCtrl | |
860 | @li wxQuantize: Class to perform quantization, or colour reduction | |
861 | @li wxSingleInstanceChecker: Check that only single program instance is running | |
862 | ||
863 | */ | |
864 |