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