]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/category.tex
rebaked after animation control and helpbest.h changes
[wxWidgets.git] / docs / latex / wx / category.tex
CommitLineData
a660d684
KB
1\chapter{Classes by category}\label{classesbycat}
2\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
3\setfooter{\thepage}{}{}{}{}{\thepage}%
4
fc2171bd 5A classification of wxWidgets classes by category.
a660d684
KB
6
7{\large {\bf Managed windows}}
8
9There are several types of window that are directly controlled by the
10window manager (such as MS Windows, or the Motif Window Manager).
834ed994 11Frames and dialogs are similar in wxWidgets, but only dialogs may be modal.
a660d684 12
1c0c339c 13\twocolwidtha{6cm}
a660d684 14\begin{twocollist}\itemsep=0pt
834ed994 15\twocolitem{\helpref{wxTopLevelWindow}{wxtoplevelwindow}}{Any top level window, dialog or frame}
a660d684
KB
16\twocolitem{\helpref{wxDialog}{wxdialog}}{Dialog box}
17\twocolitem{\helpref{wxFrame}{wxframe}}{Normal frame}
a660d684 18\twocolitem{\helpref{wxMDIChildFrame}{wxmdichildframe}}{MDI child frame}
e3c10211 19\twocolitem{\helpref{wxMDIParentFrame}{wxmdiparentframe}}{MDI parent frame}
a660d684 20\twocolitem{\helpref{wxMiniFrame}{wxminiframe}}{A frame with a small title bar}
3c9287bb 21\twocolitem{\helpref{wxPropertySheetDialog}{wxpropertysheetdialog}}{Property sheet dialog}
62a268cc 22\twocolitem{\helpref{wxSplashScreen}{wxsplashscreen}}{Splash screen class}
bd330a69
JS
23%\twocolitem{\helpref{wxTabbedDialog}{wxtabbeddialog}}{Tabbed dialog
24%(deprecated, use wxNotebook instead)}
e3c10211
JS
25\twocolitem{\helpref{wxTipWindow}{wxtipwindow}}{Shows text in a small window}
26\twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog}
a660d684
KB
27\end{twocollist}
28
29See also {\bf Common dialogs}.
30
31{\large {\bf Miscellaneous windows}}
32
d7da9756 33The following are a variety of classes that are derived from wxWindow.
a660d684 34
1c0c339c 35\twocolwidtha{6cm}
a660d684 36\begin{twocollist}\itemsep=0pt
a660d684
KB
37\twocolitem{\helpref{wxPanel}{wxpanel}}{A window whose colour changes according to current user settings}
38\twocolitem{\helpref{wxScrolledWindow}{wxscrolledwindow}}{Window with automatically managed scrollbars}
a5a0dd06 39\twocolitem{\helpref{wxGrid}{wxgrid}}{A grid (table) window}
a660d684
KB
40\twocolitem{\helpref{wxSplitterWindow}{wxsplitterwindow}}{Window which can be split vertically or horizontally}
41\twocolitem{\helpref{wxStatusBar}{wxstatusbar}}{Implements the status bar on a frame}
81d66cf3 42\twocolitem{\helpref{wxToolBar}{wxtoolbar}}{Toolbar class}
3972fb49
JS
43%\twocolitem{\helpref{wxTabbedPanel}{wxtabbedpanel}}{Tabbed panel (to be replaced with wxNotebook)}
44\twocolitem{\helpref{wxNotebook}{wxnotebook}}{Notebook class}
c16b8e18 45\twocolitem{\helpref{wxListbook}{wxlistbook}}{Similar to notebook but using list control}
f5e0b4bc 46\twocolitem{\helpref{wxChoicebook}{wxchoicebook}}{Similar to notebook but using choice control}
eca15c0d 47\twocolitem{\helpref{wxTreebook}{wxtreebook}}{Similar to notebook but using tree control}
a5a0dd06
RR
48\twocolitem{\helpref{wxSashWindow}{wxsashwindow}}{Window with four optional sashes that can be dragged}
49\twocolitem{\helpref{wxSashLayoutWindow}{wxsashlayoutwindow}}{Window that can be involved in an IDE-like layout arrangement}
cf7d6329 50\twocolitem{\helpref{wxVScrolledWindow}{wxvscrolledwindow}}{As wxScrolledWindow but supports lines of variable height}
f6bcfd97
BP
51\twocolitem{\helpref{wxWizardPage}{wxwizardpage}}{A base class for the page in wizard dialog.}
52\twocolitem{\helpref{wxWizardPageSimple}{wxwizardpagesimple}}{A page in wizard dialog.}
a660d684
KB
53\end{twocollist}
54
55{\large {\bf Common dialogs}}
56
57\overview{Overview}{commondialogsoverview}
58
59Common dialogs are ready-made dialog classes which are frequently used
60in an application.
61
1c0c339c 62\twocolwidtha{6cm}
a660d684
KB
63\begin{twocollist}\itemsep=0pt
64\twocolitem{\helpref{wxDialog}{wxdialog}}{Base class for common dialogs}
65\twocolitem{\helpref{wxColourDialog}{wxcolourdialog}}{Colour chooser dialog}
66\twocolitem{\helpref{wxDirDialog}{wxdirdialog}}{Directory selector dialog}
67\twocolitem{\helpref{wxFileDialog}{wxfiledialog}}{File selector dialog}
8db37e06 68\twocolitem{\helpref{wxFindReplaceDialog}{wxfindreplacedialog}}{Text search/replace dialog}
04bf08b7 69\twocolitem{\helpref{wxMultiChoiceDialog}{wxmultichoicedialog}}{Dialog to get one or more selections from a list}
a660d684
KB
70\twocolitem{\helpref{wxSingleChoiceDialog}{wxsinglechoicedialog}}{Dialog to get a single selection from a list and return the string}
71\twocolitem{\helpref{wxTextEntryDialog}{wxtextentrydialog}}{Dialog to get a single line of text from the user}
55b46fd1 72\twocolitem{\helpref{wxPasswordEntryDialog}{wxpasswordentrydialog}}{Dialog to get a password from the user}
a660d684
KB
73\twocolitem{\helpref{wxFontDialog}{wxfontdialog}}{Font chooser dialog}
74\twocolitem{\helpref{wxPageSetupDialog}{wxpagesetupdialog}}{Standard page setup dialog}
75\twocolitem{\helpref{wxPrintDialog}{wxprintdialog}}{Standard print dialog}
74d88854 76\twocolitem{\helpref{wxProgressDialog}{wxprogressdialog}}{Progress indication dialog}
a660d684 77\twocolitem{\helpref{wxMessageDialog}{wxmessagedialog}}{Simple message box dialog}
62a268cc
JS
78\twocolitem{\helpref{wxSymbolPickerDialog}{wxsymbolpickerdialog}}{Symbol selector dialog}
79\twocolitem{\helpref{wxRichTextFormattingDialog}{wxrichtextformattingdialog}}{A dialog for formatting the content of a wxRichTextCtrl}
f6bcfd97 80\twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog.}
a660d684
KB
81\end{twocollist}
82
83{\large {\bf Controls}}
84
85Typically, these are small windows which provide interaction with the user. Controls
86that are not static can have \helpref{validators}{wxvalidator} associated with them.
87
1c0c339c 88\twocolwidtha{6cm}
a660d684 89\begin{twocollist}\itemsep=0pt
72045d57 90\twocolitem{\helpref{wxAnimationCtrl}{wxanimationctrl}}{A control to display an animation}
a660d684
KB
91\twocolitem{\helpref{wxControl}{wxcontrol}}{The base class for controls}
92\twocolitem{\helpref{wxButton}{wxbutton}}{Push button control, displaying text}
93\twocolitem{\helpref{wxBitmapButton}{wxbitmapbutton}}{Push button control, displaying a bitmap}
95a46303 94\twocolitem{\helpref{wxBitmapComboBox}{wxbitmapcombobox}}{A combobox with bitmaps next to text items}
ecdba0d1 95\twocolitem{\helpref{wxToggleButton}{wxtogglebutton}}{A button which stays pressed when clicked by user.}
feb72429 96\twocolitem{\helpref{wxCalendarCtrl}{wxcalendarctrl}}{Control showing an entire calendar month}
a660d684
KB
97\twocolitem{\helpref{wxCheckBox}{wxcheckbox}}{Checkbox control}
98\twocolitem{\helpref{wxCheckListBox}{wxchecklistbox}}{A listbox with a checkbox to the left of each item}
99\twocolitem{\helpref{wxChoice}{wxchoice}}{Choice control (a combobox without the editable area)}
100\twocolitem{\helpref{wxComboBox}{wxcombobox}}{A choice with an editable area}
0dfff674 101\twocolitem{\helpref{wxComboCtrl}{wxcomboctrl}}{A combobox with application defined popup}
91506eb0 102\twocolitem{\helpref{wxDataViewCtrl}{wxdataviewctrl}}{A control to tabular or tree like data}
a660d684 103\twocolitem{\helpref{wxGauge}{wxgauge}}{A control to represent a varying quantity, such as time remaining}
2f3ebe4c 104\twocolitem{\helpref{wxGenericDirCtrl}{wxgenericdirctrl}}{A control for displaying a directory tree}
9ebb7cad
VZ
105\twocolitem{\helpref{wxHtmlListBox}{wxhtmllistbox}}{An abstract class for creating listboxes showing HTML content}
106\twocolitem{\helpref{wxSimpleHtmlListBox}{wxsimplehtmllistbox}}{A listbox showing HTML content}
a660d684
KB
107\twocolitem{\helpref{wxStaticBox}{wxstaticbox}}{A static, or group box for visually grouping related controls}
108\twocolitem{\helpref{wxListBox}{wxlistbox}}{A list of strings for single or multiple selection}
109\twocolitem{\helpref{wxListCtrl}{wxlistctrl}}{A control for displaying lists of strings and/or icons, plus a multicolumn report view}
2b5f62a0 110\twocolitem{\helpref{wxListView}{wxlistview}}{A simpler interface ({\it fa\c{c}ade} for wxListCtrl in report mode}
0dfff674 111\twocolitem{\helpref{wxOwnerDrawnComboBox}{wxownerdrawncombobox}}{A combobox with owner-drawn list items}
5f35b46a 112\twocolitem{\helpref{wxRichTextCtrl}{wxrichtextctrl}}{Generic rich text editing control}
f6bcfd97
BP
113\twocolitem{\helpref{wxTextCtrl}{wxtextctrl}}{Single or multiline text editing control}
114\twocolitem{\helpref{wxTreeCtrl}{wxtreectrl}}{Tree (hierarchy) control}
a660d684
KB
115\twocolitem{\helpref{wxScrollBar}{wxscrollbar}}{Scrollbar control}
116\twocolitem{\helpref{wxSpinButton}{wxspinbutton}}{A spin or `up-down' control}
5d9dba5b 117\twocolitem{\helpref{wxSpinCtrl}{wxspinctrl}}{A spin control - i.e. spin button and text control}
a660d684 118\twocolitem{\helpref{wxStaticText}{wxstatictext}}{One or more lines of non-editable text}
17e91437 119\twocolitem{\helpref{wxHyperlinkCtrl}{wxhyperlinkctrl}}{A static text which opens an URL when clicked}
a660d684
KB
120\twocolitem{\helpref{wxStaticBitmap}{wxstaticbitmap}}{A control to display a bitmap}
121\twocolitem{\helpref{wxRadioBox}{wxradiobox}}{A group of radio buttons}
122\twocolitem{\helpref{wxRadioButton}{wxradiobutton}}{A round button to be used with others in a mutually exclusive way}
123\twocolitem{\helpref{wxSlider}{wxslider}}{A slider that can be dragged by the user}
e0c6027b 124\twocolitem{\helpref{wxVListBox}{wxvlistbox}}{A listbox supporting variable height rows}
a660d684
KB
125\end{twocollist}
126
ec376c8f
VZ
127
128{\large {\bf Miscellaneous pickers}}
129
130A picker control is a control whose appearance and behaviour is highly platform-dependent.
131
132\twocolwidtha{6cm}
133\begin{twocollist}\itemsep=0pt
134\twocolitem{\helpref{wxColourPickerCtrl}{wxcolourpickerctrl}}{A control which allows the user to choose a colour}
135\twocolitem{\helpref{wxDirPickerCtrl}{wxdirpickerctrl}}{A control which allows the user to choose a directory}
136\twocolitem{\helpref{wxFilePickerCtrl}{wxfilepickerctrl}}{A control which allows the user to choose a file}
137\twocolitem{\helpref{wxFontPickerCtrl}{wxfontpickerctrl}}{A control which allows the user to choose a font}
138\twocolitem{\helpref{wxDatePickerCtrl}{wxdatepickerctrl}}{Small date picker control}
139\end{twocollist}
140
141
a660d684
KB
142{\large {\bf Menus}}
143
1c0c339c 144\twocolwidtha{6cm}
a660d684
KB
145\begin{twocollist}\itemsep=0pt
146\twocolitem{\helpref{wxMenu}{wxmenu}}{Displays a series of menu items for selection}
147\twocolitem{\helpref{wxMenuBar}{wxmenubar}}{Contains a series of menus for use with a frame}
148\twocolitem{\helpref{wxMenuItem}{wxmenuitem}}{Represents a single menu item}
149\end{twocollist}
150
151{\large {\bf Window layout}}
152
1c0c339c 153There are two different systems for laying out windows (and dialogs in particular).
515da557
RR
154One is based upon so-called sizers and it requires less typing, thinking and calculating
155and will in almost all cases produce dialogs looking equally well on all platforms, the
1c0c339c 156other is based on so-called constraints and is deprecated, though still available.
a660d684 157
1c0c339c 158\overview{Sizer overview}{sizeroverview} describes sizer-based layout.
515da557 159
1c0c339c
JS
160These are the classes relevant to sizer-based layout.
161
162\twocolwidtha{6cm}
515da557
RR
163\begin{twocollist}\itemsep=0pt
164\twocolitem{\helpref{wxSizer}{wxsizer}}{Abstract base class}
f6bcfd97
BP
165\twocolitem{\helpref{wxGridSizer}{wxgridsizer}}{A sizer for laying out windows in a grid with all fields having the same size}
166\twocolitem{\helpref{wxFlexGridSizer}{wxflexgridsizer}}{A sizer for laying out windows in a flexible grid}
20b35a69 167\twocolitem{\helpref{wxGridBagSizer}{wxgridbagsizer}}{Another grid sizer that lets you specify the cell an item is in, and items can span rows and/or columns.}
515da557 168\twocolitem{\helpref{wxBoxSizer}{wxboxsizer}}{A sizer for laying out windows in a row or column}
1c0c339c 169\twocolitem{\helpref{wxStaticBoxSizer}{wxstaticboxsizer}}{Same as wxBoxSizer, but with a surrounding static box}
515da557
RR
170\end{twocollist}
171
1c0c339c 172\overview{Constraints overview}{constraintsoverview} describes constraints-based layout.
515da557
RR
173
174These are the classes relevant to constraints-based window layout.
a660d684 175
1c0c339c 176\twocolwidtha{6cm}
a660d684
KB
177\begin{twocollist}\itemsep=0pt
178\twocolitem{\helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}}{Represents a single constraint dimension}
179\twocolitem{\helpref{wxLayoutConstraints}{wxlayoutconstraints}}{Represents the constraints for a window class}
180\end{twocollist}
181
182{\large {\bf Device contexts}}
183
184\overview{Overview}{dcoverview}
185
186Device contexts are surfaces that may be drawn on, and provide an
187abstraction that allows parameterisation of your drawing code
188by passing different device contexts.
189
1c0c339c 190\twocolwidtha{6cm}
a660d684 191\begin{twocollist}\itemsep=0pt
3dfd8daf 192\twocolitem{\helpref{wxAutoBufferedPaintDC}{wxautobufferedpaintdc}}{A helper device context for double buffered drawing inside \textbf{OnPaint}.}
d6af57d4
VZ
193\twocolitem{\helpref{wxBufferedDC}{wxbuffereddc}}{A helper device context for double buffered drawing.}
194\twocolitem{\helpref{wxBufferedPaintDC}{wxbufferedpaintdc}}{A helper device context for double buffered drawing inside \textbf{OnPaint}.}
a660d684
KB
195\twocolitem{\helpref{wxClientDC}{wxclientdc}}{A device context to access the client area outside {\bf OnPaint} events}
196\twocolitem{\helpref{wxPaintDC}{wxpaintdc}}{A device context to access the client area inside {\bf OnPaint} events}
197\twocolitem{\helpref{wxWindowDC}{wxwindowdc}}{A device context to access the non-client area}
198\twocolitem{\helpref{wxScreenDC}{wxscreendc}}{A device context to access the entire screen}
199\twocolitem{\helpref{wxDC}{wxdc}}{The device context base class}
200\twocolitem{\helpref{wxMemoryDC}{wxmemorydc}}{A device context for drawing into bitmaps}
e2a6f233 201\twocolitem{\helpref{wxMetafileDC}{wxmetafiledc}}{A device context for drawing into metafiles}
8f20ea03 202\twocolitem{\helpref{wxMirrorDC}{wxmirrordc}}{A proxy device context allowing for simple mirroring.}
a660d684
KB
203\twocolitem{\helpref{wxPostScriptDC}{wxpostscriptdc}}{A device context for drawing into PostScript files}
204\twocolitem{\helpref{wxPrinterDC}{wxprinterdc}}{A device context for drawing to printers}
205\end{twocollist}
206
207{\large {\bf Graphics device interface}}
208
209\overview{Bitmaps overview}{wxbitmapoverview}
210
211These classes are related to drawing on device contexts and windows.
212
1c0c339c 213\twocolwidtha{6cm}
a660d684
KB
214\begin{twocollist}\itemsep=0pt
215\twocolitem{\helpref{wxColour}{wxcolour}}{Represents the red, blue and green elements of a colour}
6c975af1 216\twocolitem{\helpref{wxDCClipper}{wxdcclipper}}{Wraps the operations of setting and destroying the clipping region}
a660d684
KB
217\twocolitem{\helpref{wxBitmap}{wxbitmap}}{Represents a bitmap}
218\twocolitem{\helpref{wxBrush}{wxbrush}}{Used for filling areas on a device context}
219\twocolitem{\helpref{wxBrushList}{wxbrushlist}}{The list of previously-created brushes}
220\twocolitem{\helpref{wxCursor}{wxcursor}}{A small, transparent bitmap representing the cursor}
221\twocolitem{\helpref{wxFont}{wxfont}}{Represents fonts}
222\twocolitem{\helpref{wxFontList}{wxfontlist}}{The list of previously-created fonts}
223\twocolitem{\helpref{wxIcon}{wxicon}}{A small, transparent bitmap for assigning to frames and drawing on device contexts}
89c684ef 224\twocolitem{\helpref{wxImage}{wximage}}{A platform-independent image class}
a660d684
KB
225\twocolitem{\helpref{wxImageList}{wximagelist}}{A list of images, used with some controls}
226\twocolitem{\helpref{wxMask}{wxmask}}{Represents a mask to be used with a bitmap for transparent drawing}
227\twocolitem{\helpref{wxPen}{wxpen}}{Used for drawing lines on a device context}
228\twocolitem{\helpref{wxPenList}{wxpenlist}}{The list of previously-created pens}
229\twocolitem{\helpref{wxPalette}{wxpalette}}{Represents a table of indices into RGB values}
230\twocolitem{\helpref{wxRegion}{wxregion}}{Represents a simple or complex region on a window or device context}
684761db 231\twocolitem{\helpref{wxRendererNative}{wxrenderernative}}{Abstracts high-level drawing primitives}
a660d684
KB
232\end{twocollist}
233
234{\large {\bf Events}}
235
236\overview{Overview}{eventhandlingoverview}
237
238An event object contains information about a specific event. Event handlers
239(usually member functions) have a single, event argument.
240
1c0c339c 241\twocolwidtha{6cm}
a660d684
KB
242\begin{twocollist}\itemsep=0pt
243\twocolitem{\helpref{wxActivateEvent}{wxactivateevent}}{A window or application activation event}
f6bcfd97 244\twocolitem{\helpref{wxCalendarEvent}{wxcalendarevent}}{Used with \helpref{wxCalendarCtrl}{wxcalendarctrl}}
6fb26ea3 245\twocolitem{\helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}}{Used to calculate window layout}
66ad556c 246\twocolitem{\helpref{wxChildFocusEvent}{wxchildfocusevent}}{A child window focus event}
78c91815 247\twocolitem{\helpref{wxClipboardTextEvent}{wxclipboardtextevent}}{A clipboard copy/cut/paste treebook event event}
a660d684
KB
248\twocolitem{\helpref{wxCloseEvent}{wxcloseevent}}{A close window or end session event}
249\twocolitem{\helpref{wxCommandEvent}{wxcommandevent}}{An event from a variety of standard controls}
5cb1ae8b 250\twocolitem{\helpref{wxContextMenuEvent}{wxcontextmenuevent}}{An event generated when the user issues a context menu command}
e6e86d52 251\twocolitem{\helpref{wxDateEvent}{wxdateevent}}{Used with \helpref{wxDatePickerCtrl}{wxdatepickerctrl}}
f6bcfd97 252\twocolitem{\helpref{wxDialUpEvent}{wxdialupevent}}{Event send by \helpref{wxDialUpManager}{wxdialupmanager}}
a660d684
KB
253\twocolitem{\helpref{wxDropFilesEvent}{wxdropfilesevent}}{A drop files event}
254\twocolitem{\helpref{wxEraseEvent}{wxeraseevent}}{An erase background event}
255\twocolitem{\helpref{wxEvent}{wxevent}}{The event base class}
f010ad48 256\twocolitem{\helpref{wxFindDialogEvent}{wxfinddialogevent}}{Event sent by
8db37e06 257\helpref{wxFindReplaceDialog}{wxfindreplacedialog}}
a660d684
KB
258\twocolitem{\helpref{wxFocusEvent}{wxfocusevent}}{A window focus event}
259\twocolitem{\helpref{wxKeyEvent}{wxkeyevent}}{A keypress event}
3dd9b88a 260\twocolitem{\helpref{wxIconizeEvent}{wxiconizeevent}}{An iconize/restore event}
a660d684
KB
261\twocolitem{\helpref{wxIdleEvent}{wxidleevent}}{An idle event}
262\twocolitem{\helpref{wxInitDialogEvent}{wxinitdialogevent}}{A dialog initialisation event}
263\twocolitem{\helpref{wxJoystickEvent}{wxjoystickevent}}{A joystick event}
264\twocolitem{\helpref{wxListEvent}{wxlistevent}}{A list control event}
3dd9b88a 265\twocolitem{\helpref{wxMaximizeEvent}{wxmaximizeevent}}{A maximize event}
a660d684 266\twocolitem{\helpref{wxMenuEvent}{wxmenuevent}}{A menu event}
a5e84126 267\twocolitem{\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}}{A mouse capture changed event}
63e819f2 268\twocolitem{\helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}}{A mouse capture lost event}
a660d684
KB
269\twocolitem{\helpref{wxMouseEvent}{wxmouseevent}}{A mouse event}
270\twocolitem{\helpref{wxMoveEvent}{wxmoveevent}}{A move event}
3972fb49 271\twocolitem{\helpref{wxNotebookEvent}{wxnotebookevent}}{A notebook control event}
fd128b0c 272\twocolitem{\helpref{wxNotifyEvent}{wxnotifyevent}}{A notification event, which can be vetoed}
a660d684 273\twocolitem{\helpref{wxPaintEvent}{wxpaintevent}}{A paint event}
3972fb49 274\twocolitem{\helpref{wxProcessEvent}{wxprocessevent}}{A process ending event}
6fb26ea3 275\twocolitem{\helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent}}{Used to query layout information}
5f35b46a 276\twocolitem{\helpref{wxRichTextEvent}{wxrichtextevent}}{A rich text editing event}
fd128b0c
RR
277\twocolitem{\helpref{wxScrollEvent}{wxscrollevent}}{A scroll event from sliders, stand-alone scrollbars and spin buttons}
278\twocolitem{\helpref{wxScrollWinEvent}{wxscrollwinevent}}{A scroll event from scrolled windows}
a660d684 279\twocolitem{\helpref{wxSizeEvent}{wxsizeevent}}{A size event}
42ff6409 280\twocolitem{\helpref{wxSocketEvent}{wxsocketevent}}{A socket event}
f6bcfd97 281\twocolitem{\helpref{wxSpinEvent}{wxspinevent}}{An event from \helpref{wxSpinButton}{wxspinbutton}}
e6e86d52 282\twocolitem{\helpref{wxSplitterEvent}{wxsplitterevent}}{An event from \helpref{wxSplitterWindow}{wxsplitterwindow}}
a660d684 283\twocolitem{\helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}}{A system colour change event}
e3f17fc8 284\twocolitem{\helpref{wxTimerEvent}{wxtimerevent}}{A timer expiration event}
eca15c0d 285\twocolitem{\helpref{wxTreebookEvent}{wxtreebookevent}}{A treebook control event}
a660d684
KB
286\twocolitem{\helpref{wxTreeEvent}{wxtreeevent}}{A tree control event}
287\twocolitem{\helpref{wxUpdateUIEvent}{wxupdateuievent}}{A user interface update event}
4acaa5e2
JS
288\twocolitem{\helpref{wxWindowCreateEvent}{wxwindowcreateevent}}{A window creation event}
289\twocolitem{\helpref{wxWindowDestroyEvent}{wxwindowdestroyevent}}{A window destruction event}
f6bcfd97 290\twocolitem{\helpref{wxWizardEvent}{wxwizardevent}}{A wizard event}
a660d684
KB
291\end{twocollist}
292
293{\large {\bf Validators}}
294
6b037754
JS
295\overview{Overview}{validatoroverview}
296
a660d684
KB
297These are the window validators, used for filtering and validating
298user input.
299
1c0c339c 300\twocolwidtha{6cm}
a660d684 301\begin{twocollist}\itemsep=0pt
89c684ef
JS
302\twocolitem{\helpref{wxValidator}{wxvalidator}}{Base validator class}
303\twocolitem{\helpref{wxTextValidator}{wxtextvalidator}}{Text control validator class}
304\twocolitem{\helpref{wxGenericValidator}{wxgenericvalidator}}{Generic control validator class}
a660d684
KB
305\end{twocollist}
306
307{\large {\bf Data structures}}
308
fc2171bd 309These are the data structure classes supported by wxWidgets.
a660d684 310
1c0c339c 311\twocolwidtha{6cm}
a660d684 312\begin{twocollist}\itemsep=0pt
f6bcfd97 313\twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class}
f6bcfd97 314\twocolitem{\helpref{wxDateSpan}{wxdatespan}}{A logical time interval.}
d7da9756 315\twocolitem{\helpref{wxDateTime}{wxdatetime}}{A class for date/time manipulations}
c92ddcd2
JS
316%\twocolitem{\helpref{wxExpr}{wxexpr}}{A class for flexible I/O}
317%\twocolitem{\helpref{wxExprDatabase}{wxexprdatabase}}{A class for flexible I/O}
e6e86d52
MR
318\twocolitem{\helpref{wxArray}{wxarray}}{A dynamic array implementation}
319\twocolitem{\helpref{wxArrayString}{wxarraystring}}{An efficient container for storing \helpref{wxString}{wxstring} objects}
e676441f 320\twocolitem{\helpref{wxHashMap}{wxhashmap}}{A simple hash map implementation}
8cd74a14 321\twocolitem{\helpref{wxHashSet}{wxhashset}}{A simple hash set implementation}
e676441f 322\twocolitem{\helpref{wxHashTable}{wxhashtable}}{A simple hash table implementation (deprecated, use wxHashMap)}
d7da9756 323% \twocolitem{\helpref{wxHashTableLong}{wxhashtablelong}}{A wxHashTable version for storing long data}
a660d684 324\twocolitem{\helpref{wxList}{wxlist}}{A simple linked list implementation}
d7da9756 325\twocolitem{\helpref{wxLongLong}{wxlonglong}}{A portable 64 bit integer type}
a660d684 326\twocolitem{\helpref{wxNode}{wxnode}}{Represents a node in the wxList implementation}
fc2171bd 327\twocolitem{\helpref{wxObject}{wxobject}}{The root class for most wxWidgets classes}
a660d684
KB
328\twocolitem{\helpref{wxPathList}{wxpathlist}}{A class to help search multiple paths}
329\twocolitem{\helpref{wxPoint}{wxpoint}}{Representation of a point}
330\twocolitem{\helpref{wxRect}{wxrect}}{A class representing a rectangle}
8fb2999a 331\twocolitem{\helpref{wxRegEx}{wxregex}}{Regular expression support}
a660d684
KB
332\twocolitem{\helpref{wxRegion}{wxregion}}{A class representing a region}
333\twocolitem{\helpref{wxString}{wxstring}}{A string class}
9c884972 334\twocolitem{\helpref{wxStringTokenizer}{wxstringtokenizer}}{A class for interpreting a string as a list of tokens or words}
a660d684
KB
335\twocolitem{\helpref{wxRealPoint}{wxrealpoint}}{Representation of a point using floating point numbers}
336\twocolitem{\helpref{wxSize}{wxsize}}{Representation of a size}
f6bcfd97 337\twocolitem{\helpref{wxTimeSpan}{wxtimespan}}{A time interval.}
86470d43 338\twocolitem{\helpref{wxURI}{wxuri}}{Represents a Uniform Resource Identifier}
d7da9756 339\twocolitem{\helpref{wxVariant}{wxvariant}}{A class for storing arbitrary types that may change at run-time}
a660d684
KB
340\end{twocollist}
341
342{\large {\bf Run-time class information system}}
343
344\overview{Overview}{runtimeclassoverview}
345
fc2171bd 346wxWidgets supports run-time manipulation of class information, and dynamic
a660d684
KB
347creation of objects given class names.
348
1c0c339c 349\twocolwidtha{6cm}
a660d684
KB
350\begin{twocollist}\itemsep=0pt
351\twocolitem{\helpref{wxClassInfo}{wxclassinfo}}{Holds run-time class information}
352\twocolitem{\helpref{wxObject}{wxobject}}{Root class for classes with run-time information}
f4fcc291 353\twocolitem{\helpref{RTTI macros}{rttimacros}}{Macros for manipulating run-time information}
a660d684
KB
354\end{twocollist}
355
2fda2145 356{\large {\bf Logging features}}
a660d684 357
30fc2c8e 358\overview{Overview}{wxlogoverview}
f1fa9adc 359
fc2171bd 360wxWidgets provides several classes and functions for message logging.
f1fa9adc
VZ
361Please see the \helpref{wxLog overview}{wxlogoverview} for more details.
362
1c0c339c 363\twocolwidtha{6cm}
f1fa9adc
VZ
364\begin{twocollist}\itemsep=0pt
365\twocolitem{\helpref{wxLog}{wxlog}}{The base log class}
366\twocolitem{\helpref{wxLogStderr}{wxlogstderr}}{Log messages to a C STDIO stream}
367\twocolitem{\helpref{wxLogStream}{wxlogstream}}{Log messages to a C++ iostream}
368\twocolitem{\helpref{wxLogTextCtrl}{wxlogtextctrl}}{Log messages to a \helpref{wxTextCtrl}{wxtextctrl}}
369\twocolitem{\helpref{wxLogWindow}{wxlogwindow}}{Log messages to a log frame}
370\twocolitem{\helpref{wxLogGui}{wxloggui}}{Default log target for GUI programs}
371\twocolitem{\helpref{wxLogNull}{wxlognull}}{Temporarily suppress message logging}
372\twocolitem{\helpref{wxLogChain}{wxlogchain}}{Allows to chain two log targets}
373\twocolitem{\helpref{wxLogPassThrough}{wxlogpassthrough}}{Allows to filter the log messages}
374\twocolitem{\helpref{wxStreamToTextRedirector}{wxstreamtotextredirector}}{Allows
375to redirect output sent to {\tt cout} to a \helpref{wxTextCtrl}{wxtextctrl}}
376\twocolitem{\helpref{Log functions}{logfunctions}}{Error and warning logging functions}
377\end{twocollist}
378
379{\large {\bf Debugging features}}
380
a660d684
KB
381\overview{Overview}{debuggingoverview}
382
fc2171bd 383wxWidgets supports some aspects of debugging an application through
a660d684
KB
384classes, functions and macros.
385
1c0c339c 386\twocolwidtha{6cm}
a660d684 387\begin{twocollist}\itemsep=0pt
6b037754 388\twocolitem{\helpref{wxDebugContext}{wxdebugcontext}}{Provides memory-checking facilities}
6b037754 389\twocolitem{\helpref{Debugging macros}{debugmacros}}{Debug macros for assertion and checking}
a660d684 390\twocolitem{\helpref{WXDEBUG\_NEW}{debugnew}}{Use this macro to give further debugging information}
af127680
VZ
391\twocolitem{\helpref{wxDebugReport}{wxdebugreport}}{Base class for creating debug reports in case of a program crash.}
392\twocolitem{\helpref{wxDebugReportCompress}{wxdebugreportcompress}}{Class for creating compressed debug reports.}
393\twocolitem{\helpref{wxDebugReportUpload}{wxdebugreportupload}}{Class for uploading compressed debug reports via HTTP.}
394\twocolitem{\helpref{wxDebugReportPreview}{wxdebugreportpreview}}{Abstract base class for previewing the contents of a debug report.}
395\twocolitem{\helpref{wxDebugReportPreviewStd}{wxdebugreportpreviewstd}}{Standard implementation of wxDebugReportPreview.}
a660d684
KB
396\end{twocollist}
397
238ddd26
RR
398{\large {\bf Networking classes}}
399
fc2171bd 400wxWidgets provides its own classes for socket based networking.
238ddd26 401
1c0c339c 402\twocolwidtha{6cm}
238ddd26 403\begin{twocollist}\itemsep=0pt
f6bcfd97
BP
404\twocolitem{\helpref{wxDialUpManager}{wxdialupmanager}}{Provides functions to check the status of network connection and to establish one}
405\twocolitem{\helpref{wxIPV4address}{wxipv4address}}{Represents an Internet address}
be4bd463 406\twocolitem{\helpref{wxIPaddress}{wxipaddress}}{Represents an Internet address}
672186ef 407\twocolitem{\helpref{wxSocketBase}{wxsocketbase}}{Represents a socket base object}
238ddd26
RR
408\twocolitem{\helpref{wxSocketClient}{wxsocketclient}}{Represents a socket client}
409\twocolitem{\helpref{wxSocketServer}{wxsocketserver}}{Represents a socket server}
238ddd26 410\twocolitem{\helpref{wxSocketEvent}{wxsocketevent}}{A socket event}
672186ef
GRG
411\twocolitem{\helpref{wxFTP}{wxftp}}{FTP protocol class}
412\twocolitem{\helpref{wxHTTP}{wxhttp}}{HTTP protocol class}
413\twocolitem{\helpref{wxURL}{wxurl}}{Represents a Universal Resource Locator}
238ddd26
RR
414\end{twocollist}
415
416
a660d684
KB
417{\large {\bf Interprocess communication}}
418
419\overview{Overview}{ipcoverview}
420
fc2171bd 421wxWidgets provides simple interprocess communications facilities
f010ad48 422based on Windows DDE, but available on most platforms using TCP.
a660d684 423
1c0c339c 424\twocolwidtha{6cm}
a660d684 425\begin{twocollist}\itemsep=0pt
f510b7b2
WS
426\twocolitem{\helpref{wxClient}{wxclient}, \helpref{wxDDEClient}{wxddeclient}}{Represents a client}
427\twocolitem{\helpref{wxConnection}{wxconnection}, \helpref{wxDDEConnection}{wxddeconnection}}{Represents the connection between a client and a server}
428\twocolitem{\helpref{wxServer}{wxserver}, \helpref{wxDDEServer}{wxddeserver}}{Represents a server}
d7cb14ce 429%\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler}
a660d684
KB
430\end{twocollist}
431
432{\large {\bf Document/view framework}}
433
434\overview{Overview}{docviewoverview}
435
fc2171bd 436wxWidgets supports a document/view framework which provides
a660d684
KB
437housekeeping for a document-centric application.
438
1c0c339c 439\twocolwidtha{6cm}
a660d684
KB
440\begin{twocollist}\itemsep=0pt
441\twocolitem{\helpref{wxDocument}{wxdocument}}{Represents a document}
442\twocolitem{\helpref{wxView}{wxview}}{Represents a view}
f6bcfd97 443\twocolitem{\helpref{wxDocTemplate}{wxdoctemplate}}{Manages the relationship between a document class and a view class}
a660d684
KB
444\twocolitem{\helpref{wxDocManager}{wxdocmanager}}{Manages the documents and views in an application}
445\twocolitem{\helpref{wxDocChildFrame}{wxdocchildframe}}{A child frame for showing a document view}
446\twocolitem{\helpref{wxDocParentFrame}{wxdocparentframe}}{A parent frame to contain views}
6fb26ea3
JS
447%\twocolitem{\helpref{wxMDIDocChildFrame}{wxmdidocchildframe}}{An MDI child frame for showing a document view}
448%\twocolitem{\helpref{wxMDIDocParentFrame}{wxmdidocparentframe}}{An MDI parent frame to contain views}
a660d684
KB
449\end{twocollist}
450
451{\large {\bf Printing framework}}
452
453\overview{Overview}{printingoverview}
454
455A printing and previewing framework is implemented to
f6bcfd97 456make it relatively straightforward to provide document printing
a660d684
KB
457facilities.
458
1c0c339c 459\twocolwidtha{6cm}
a660d684
KB
460\begin{twocollist}\itemsep=0pt
461\twocolitem{\helpref{wxPreviewFrame}{wxpreviewframe}}{Frame for displaying a print preview}
462\twocolitem{\helpref{wxPreviewCanvas}{wxpreviewcanvas}}{Canvas for displaying a print preview}
463\twocolitem{\helpref{wxPreviewControlBar}{wxpreviewcontrolbar}}{Standard control bar for a print preview}
a660d684 464\twocolitem{\helpref{wxPrintDialog}{wxprintdialog}}{Standard print dialog}
7bcb11d3 465\twocolitem{\helpref{wxPageSetupDialog}{wxpagesetupdialog}}{Standard page setup dialog}
a660d684
KB
466\twocolitem{\helpref{wxPrinter}{wxprinter}}{Class representing the printer}
467\twocolitem{\helpref{wxPrinterDC}{wxprinterdc}}{Printer device context}
468\twocolitem{\helpref{wxPrintout}{wxprintout}}{Class representing a particular printout}
469\twocolitem{\helpref{wxPrintPreview}{wxprintpreview}}{Class representing a print preview}
7bcb11d3
JS
470\twocolitem{\helpref{wxPrintData}{wxprintdata}}{Represents information about the document being printed}
471\twocolitem{\helpref{wxPrintDialogData}{wxprintdialogdata}}{Represents information about the print dialog}
472\twocolitem{\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}}{Represents information about the page setup dialog}
a660d684
KB
473\end{twocollist}
474
dface61c
JS
475{\large {\bf Drag and drop and clipboard classes}}
476
477\overview{Drag and drop and clipboard overview}{wxdndoverview}
478
1c0c339c 479\twocolwidtha{6cm}
dface61c 480\begin{twocollist}\itemsep=0pt
dface61c 481\twocolitem{\helpref{wxDataObject}{wxdataobject}}{Data object class}
c03648c2 482\twocolitem{\helpref{wxDataFormat}{wxdataformat}}{Represents a data format}
dface61c 483\twocolitem{\helpref{wxTextDataObject}{wxtextdataobject}}{Text data object class}
5ab2950d 484\twocolitem{\helpref{wxFileDataObject}{wxfiledataobject}}{File data object class}
dface61c 485\twocolitem{\helpref{wxBitmapDataObject}{wxbitmapdataobject}}{Bitmap data object class}
c959d912 486\twocolitem{\helpref{wxURLDataObject}{wxurldataobject}}{URL data object class}
0a2017e0 487\twocolitem{\helpref{wxCustomDataObject}{wxcustomdataobject}}{Custom data object class}
dface61c 488\twocolitem{\helpref{wxClipboard}{wxclipboard}}{Clipboard class}
5aa5e35a
RR
489\twocolitem{\helpref{wxDropTarget}{wxdroptarget}}{Drop target class}
490\twocolitem{\helpref{wxFileDropTarget}{wxfiledroptarget}}{File drop target class}
491\twocolitem{\helpref{wxTextDropTarget}{wxtextdroptarget}}{Text drop target class}
492\twocolitem{\helpref{wxDropSource}{wxdropsource}}{Drop source class}
dface61c
JS
493\end{twocollist}
494
247aba10
VZ
495{\large {\bf File related classes}}
496
fc2171bd 497wxWidgets has several small classes to work with disk files, see \helpref{file classes
247aba10
VZ
498overview}{wxfileoverview} for more details.
499
1c0c339c 500\twocolwidtha{6cm}
247aba10 501\begin{twocollist}\itemsep=0pt
2569938d 502\twocolitem{\helpref{wxFileName}{wxfilename}}{Operations with the file name and attributes}
4afd7529 503\twocolitem{\helpref{wxDir}{wxdir}}{Class for enumerating files/subdirectories.}
509cd921 504\twocolitem{\helpref{wxDirTraverser}{wxdirtraverser}}{Class used together with wxDir for recursively enumerating the files/subdirectories}
842d6c94
RR
505\twocolitem{\helpref{wxFile}{wxfile}}{Low-level file input/output class.}
506\twocolitem{\helpref{wxFFile}{wxffile}}{Another low-level file input/output class.}
247aba10
VZ
507\twocolitem{\helpref{wxTempFile}{wxtempfile}}{Class to safely replace an existing file}
508\twocolitem{\helpref{wxTextFile}{wxtextfile}}{Class for working with text files as with arrays of lines}
a8d08dbd 509\twocolitem{\helpref{wxStandardPaths}{wxstandardpaths}}{Paths for standard directories}
247aba10
VZ
510\end{twocollist}
511
631f1bfe
JS
512{\large {\bf Stream classes}}
513
fc2171bd 514wxWidgets has its own set of stream classes, as an alternative to often buggy standard stream
631f1bfe
JS
515libraries, and to provide enhanced functionality.
516
1c0c339c 517\twocolwidtha{6cm}
631f1bfe
JS
518\begin{twocollist}\itemsep=0pt
519\twocolitem{\helpref{wxStreamBase}{wxstreambase}}{Stream base class}
520\twocolitem{\helpref{wxStreamBuffer}{wxstreambuffer}}{Stream buffer class}
521\twocolitem{\helpref{wxInputStream}{wxinputstream}}{Input stream class}
522\twocolitem{\helpref{wxOutputStream}{wxoutputstream}}{Output stream class}
d984207c 523\twocolitem{\helpref{wxCountingOutputStream}{wxcountingoutputstream}}{Stream class for querying what size a stream would have.}
631f1bfe
JS
524\twocolitem{\helpref{wxFilterInputStream}{wxfilterinputstream}}{Filtered input stream class}
525\twocolitem{\helpref{wxFilterOutputStream}{wxfilteroutputstream}}{Filtered output stream class}
d984207c
RR
526\twocolitem{\helpref{wxBufferedInputStream}{wxbufferedinputstream}}{Buffered input stream class}
527\twocolitem{\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}}{Buffered output stream class}
2bf8e4eb
RR
528\twocolitem{\helpref{wxMemoryInputStream}{wxmeminputstream}}{Memory input stream class}
529\twocolitem{\helpref{wxMemoryOutputStream}{wxmemoutputstream}}{Memory output stream class}
7ff14117
RR
530\twocolitem{\helpref{wxDataInputStream}{wxdatainputstream}}{Platform-independent binary data input stream class}
531\twocolitem{\helpref{wxDataOutputStream}{wxdataoutputstream}}{Platform-independent binary data output stream class}
532\twocolitem{\helpref{wxTextInputStream}{wxtextinputstream}}{Platform-independent text data input stream class}
533\twocolitem{\helpref{wxTextOutputStream}{wxtextoutputstream}}{Platform-independent text data output stream class}
631f1bfe
JS
534\twocolitem{\helpref{wxFileInputStream}{wxfileinputstream}}{File input stream class}
535\twocolitem{\helpref{wxFileOutputStream}{wxfileoutputstream}}{File output stream class}
842d6c94
RR
536\twocolitem{\helpref{wxFFileInputStream}{wxffileinputstream}}{Another file input stream class}
537\twocolitem{\helpref{wxFFileOutputStream}{wxffileoutputstream}}{Another file output stream class}
e1265174 538\twocolitem{\helpref{wxTempFileOutputStream}{wxtempfileoutputstream}}{Stream to safely replace an existing file}
121fa06a
VZ
539\twocolitem{\helpref{wxStringInputStream}{wxstringinputstream}}{String input stream class}
540\twocolitem{\helpref{wxStringOutputStream}{wxstringoutputstream}}{String output stream class}
631f1bfe
JS
541\twocolitem{\helpref{wxZlibInputStream}{wxzlibinputstream}}{Zlib (compression) input stream class}
542\twocolitem{\helpref{wxZlibOutputStream}{wxzliboutputstream}}{Zlib (compression) output stream class}
738bfca9 543\twocolitem{\helpref{wxZipInputStream}{wxzipinputstream}}{Input stream for reading from ZIP archives}
df467a9d 544\twocolitem{\helpref{wxZipOutputStream}{wxzipoutputstream}}{Output stream for writing from ZIP archives}
631f1bfe
JS
545\twocolitem{\helpref{wxSocketInputStream}{wxsocketinputstream}}{Socket input stream class}
546\twocolitem{\helpref{wxSocketOutputStream}{wxsocketoutputstream}}{Socket output stream class}
547\end{twocollist}
548
238ddd26
RR
549{\large {\bf Threading classes}}
550
551\overview{Multithreading overview}{wxthreadoverview}
738bfca9 552
fc2171bd 553wxWidgets provides a set of classes to make use of the native thread
238ddd26
RR
554capabilities of the various platforms.
555
1c0c339c 556\twocolwidtha{6cm}
238ddd26
RR
557\begin{twocollist}\itemsep=0pt
558\twocolitem{\helpref{wxThread}{wxthread}}{Thread class}
78ee6a47 559\twocolitem{\helpref{wxThreadHelper}{wxthreadhelper}}{Manages background threads easily}
238ddd26
RR
560\twocolitem{\helpref{wxMutex}{wxmutex}}{Mutex class}
561\twocolitem{\helpref{wxMutexLocker}{wxmutexlocker}}{Mutex locker utility class}
562\twocolitem{\helpref{wxCriticalSection}{wxcriticalsection}}{Critical section class}
f6bcfd97 563\twocolitem{\helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}}{Critical section locker utility class}
88413fec 564\twocolitem{\helpref{wxCondition}{wxcondition}}{Condition class}
be809868 565\twocolitem{\helpref{wxSemaphore}{wxsemaphore}}{Semaphore class}
238ddd26
RR
566\end{twocollist}
567
568{\large {\bf HTML classes}}
569
fc2171bd 570wxWidgets provides a set of classes to display text in HTML format. These
238ddd26 571class include a help system based on the HTML widget.
738bfca9 572
1c0c339c 573\twocolwidtha{6cm}
738bfca9
VS
574\begin{twocollist}\itemsep=0pt
575\twocolitem{\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}}{HTML help controller class}
576\twocolitem{\helpref{wxHtmlWindow}{wxhtmlwindow}}{HTML window class}
e5436d59
VS
577\twocolitem{\helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting}}{Simple class for printing HTML}
578\twocolitem{\helpref{wxHtmlPrintout}{wxhtmlprintout}}{Generic HTML wxPrintout class}
738bfca9
VS
579\twocolitem{\helpref{wxHtmlParser}{wxhtmlparser}}{Generic HTML parser class}
580\twocolitem{\helpref{wxHtmlTagHandler}{wxhtmltaghandler}}{HTML tag handler, pluginable into wxHtmlParser}
581\twocolitem{\helpref{wxHtmlWinParser}{wxhtmlwinparser}}{HTML parser class for wxHtmlWindow}
582\twocolitem{\helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}}{HTML tag handler, pluginable into wxHtmlWinParser}
583\end{twocollist}
584
4aeaf419
JS
585{\large {\bf Rich text classes}}
586
587wxWidgets provides a set of generic classes to edit and print simple rich text with character
588and paragraph formatting.
589
590\twocolwidtha{6cm}
591\begin{twocollist}\itemsep=0pt
592\twocolitem{\helpref{wxRichTextCtrl}{wxrichtextctrl}}{A rich text control.}
593\twocolitem{\helpref{wxRichTextBuffer}{wxrichtextbuffer}}{The content of a rich text control.}
594\twocolitem{\helpref{wxRichTextAttr}{wxrichtextattr}}{Attributes specifying rich text styling.}
595\twocolitem{\helpref{wxRichTextCharacterStyleDefinition}{wxrichtextcharacterstyledefinition}}{Definition of character styling.}
596\twocolitem{\helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition}}{Definition of paragraph styling.}
597\twocolitem{\helpref{wxRichTextListStyleDefinition}{wxrichtextliststyledefinition}}{Definition of list styling.}
598\twocolitem{\helpref{wxRichTextStyleSheet}{wxrichtextstylesheet}}{A set of style definitions.}
599\twocolitem{\helpref{wxRichTextStyleComboCtrl}{wxrichtextstylecomboctrl}}{A drop-down control for applying styles.}
600\twocolitem{\helpref{wxRichTextStyleListBox}{wxrichtextstylelistbox}}{A listbox for applying styles.}
601\twocolitem{\helpref{wxRichTextEvent}{wxrichtextevent}}{A rich text event.}
602\twocolitem{\helpref{wxRichTextRange}{wxrichtextrange}}{Specification for ranges in a rich text control or buffer.}
603\twocolitem{\helpref{wxRichTextFileHandler}{wxrichtextfilehandler}}{File handler base class.}
604\twocolitem{\helpref{wxRichTextHTMLHandler}{wxrichtexthtmlhandler}}{A handler for converting rich text to HTML.}
605\twocolitem{\helpref{wxRichTextXMLHandler}{wxrichtextxmlhandler}}{A handler for loading and saving rich text XML.}
606\twocolitem{\helpref{wxRichTextFormattingDialog}{wxrichtextformattingdialog}}{A dialog for rich text formatting.}
607\twocolitem{\helpref{wxRichTextPrinting}{wxrichtextprinting}}{A class for easy printing of rich text buffers.}
608\twocolitem{\helpref{wxRichTextPrintout}{wxrichtextprintout}}{A class used by wxRichTextPrinting.}
609\twocolitem{\helpref{wxRichTextHeaderFooterData}{wxrichtextheaderfooterdata}}{Header and footer data specification.}
610\end{twocollist}
611
88413fec
RR
612{\large {\bf Virtual file system classes}}
613
fc2171bd 614wxWidgets provides a set of classes that implement an extensible virtual file system,
88413fec
RR
615used internally by the HTML classes.
616
1c0c339c 617\twocolwidtha{6cm}
88413fec
RR
618\begin{twocollist}\itemsep=0pt
619\twocolitem{\helpref{wxFSFile}{wxfsfile}}{Represents a file in the virtual file system}
620\twocolitem{\helpref{wxFileSystem}{wxfilesystem}}{Main interface for the virtual file system}
621\twocolitem{\helpref{wxFileSystemHandler}{wxfilesystemhandler}}{Class used to announce file system type}
622\end{twocollist}
623
3193b86f
VZ
624{\large {\bf XML classes}}
625
626\twocolwidtha{6cm}
627\begin{twocollist}\itemsep=0pt
628\twocolitem{\helpref{wxXmlDocument}{wxxmldocument}}{A class to parse XML files.}
629\twocolitem{\helpref{wxXmlNode}{wxxmlnode}}{A class which represents XML nodes.}
630\twocolitem{\helpref{wxXmlProperty}{wxxmlproperty}}{A class which represents XML properties.}
631\end{twocollist}
632
d958c9bd
JS
633{\large {\bf XML-based resource system classes}}
634
3980000c 635\overview{XML-based resource system (XRC) overview}{xrcoverview}
d958c9bd
JS
636
637Resources allow your application to create controls and other user interface elements
638from specifications stored in an XML format.
639
1c0c339c 640\twocolwidtha{6cm}
d958c9bd
JS
641\begin{twocollist}\itemsep=0pt
642\twocolitem{\helpref{wxXmlResource}{wxxmlresource}}{The main class for working with resources.}
643\twocolitem{\helpref{wxXmlResourceHandler}{wxxmlresourcehandler}}{The base class for XML resource handlers.}
644\end{twocollist}
645
7cb74906
JS
646{\large {\bf Online help}}
647
1c0c339c 648\twocolwidtha{6cm}
7cb74906
JS
649\begin{twocollist}\itemsep=0pt
650\twocolitem{\helpref{wxHelpController}{wxhelpcontroller}}{Family of classes for controlling help windows}
651\twocolitem{\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}}{HTML help controller class}
652\twocolitem{\helpref{wxContextHelp}{wxcontexthelp}}{Class to put application into context-sensitive help mode}
653\twocolitem{\helpref{wxContextHelpButton}{wxcontexthelpbutton}}{Button class for putting application into context-sensitive help mode}
654\twocolitem{\helpref{wxHelpProvider}{wxhelpprovider}}{Abstract class for context-sensitive help provision}
655\twocolitem{\helpref{wxSimpleHelpProvider}{wxsimplehelpprovider}}{Class for simple context-sensitive help provision}
656\twocolitem{\helpref{wxHelpControllerHelpProvider}{wxhelpcontrollerhelpprovider}}{Class for context-sensitive help provision via a help controller}
657\twocolitem{\helpref{wxToolTip}{wxtooltip}}{Class implementing tooltips}
658\end{twocollist}
659
509cd921
VZ
660{\large {\bf Database classes}}
661
662\overview{Database classes overview}{odbcoverview}
663
fc2171bd 664wxWidgets provides a set of classes for accessing Microsoft's ODBC (Open Database Connectivity)
f7292ebe 665product, donated by Remstar. This is known as wxODBC.
509cd921 666
1c0c339c 667\twocolwidtha{6cm}
509cd921
VZ
668\begin{twocollist}\itemsep=0pt
669\twocolitem{\helpref{wxDb}{wxdb}}{ODBC database connection}
670\twocolitem{\helpref{wxDbTable}{wxdbtable}}{Provides access to a database table}
671\twocolitem{\helpref{wxDbInf}{wxdbinf}}{}
672\twocolitem{\helpref{wxDbTableInf}{wxdbtableinf}}{}
673\twocolitem{\helpref{wxDbColDef}{wxdbcoldef}}{}
674\twocolitem{\helpref{wxDbColInf}{wxdbcolinf}}{}
44bb263a 675\twocolitem{\helpref{wxDbColDataPtr}{wxdbcoldataptr}}{}
509cd921
VZ
676\twocolitem{\helpref{wxDbColFor}{wxdbcolfor}}{}
677\twocolitem{\helpref{wxDbConnectInf}{wxdbconnectinf}}{}
0f353563 678\twocolitem{\helpref{wxDbIdxDef}{wxdbidxdef}}{}
509cd921
VZ
679\end{twocollist}
680
a660d684
KB
681{\large {\bf Miscellaneous}}
682
1c0c339c 683\twocolwidtha{6cm}
a660d684
KB
684\begin{twocollist}\itemsep=0pt
685\twocolitem{\helpref{wxApp}{wxapp}}{Application class}
f6bcfd97
BP
686\twocolitem{\helpref{wxCaret}{wxcaret}}{A caret (cursor) object}
687\twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class}
688\twocolitem{\helpref{wxConfig}{wxconfigbase}}{Classes for configuration reading/writing (using either INI files or registry)}
689\twocolitem{\helpref{wxDllLoader}{wxdllloader}}{Class to work with shared libraries.}
43e8916f
MW
690\twocolitem{\helpref{wxGLCanvas}{wxglcanvas}}{Canvas that you can render OpenGL calls to.}
691\twocolitem{\helpref{wxGLContext}{wxglcontext}}{Class to ease sharing of OpenGL data resources.}
6fb26ea3 692\twocolitem{\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}}{An alternative window layout facility}
3972fb49 693\twocolitem{\helpref{wxProcess}{wxprocess}}{Process class}
a660d684 694\twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class}
5f445b31 695\twocolitem{\helpref{wxStopWatch}{wxstopwatch}}{Stop watch class}
88413fec 696\twocolitem{\helpref{wxMimeTypesManager}{wxmimetypesmanager}}{MIME-types manager class}
0cbff120
JS
697\twocolitem{\helpref{wxSystemSettings}{wxsystemsettings}}{System settings class for obtaining various global parameters}
698\twocolitem{\helpref{wxSystemOptions}{wxsystemoptions}}{System options class for run-time configuration}
238ddd26
RR
699\twocolitem{\helpref{wxAcceleratorTable}{wxacceleratortable}}{Accelerator table}
700\twocolitem{\helpref{wxAutomationObject}{wxautomationobject}}{OLE automation class}
5d9dba5b
VS
701\twocolitem{\helpref{wxFontMapper}{wxfontmapper}}{Font mapping, finding suitable font for given encoding}
702\twocolitem{\helpref{wxEncodingConverter}{wxencodingconverter}}{Encoding conversions}
f6bcfd97 703\twocolitem{\helpref{wxCalendarDateAttr}{wxcalendardateattr}}{Used with \helpref{wxCalendarCtrl}{wxcalendarctrl}}
e3c10211 704\twocolitem{\helpref{wxQuantize}{wxquantize}}{Class to perform quantization, or colour reduction}
68a602fc 705\twocolitem{\helpref{wxSingleInstanceChecker}{wxsingleinstancechecker}}{Check that only single program instance is running}
238ddd26 706\end{twocollist}