]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/category.tex
Added periods
[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}
913c8465 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
1fdd3f34
RR
151{\large {\bf wxAUI - advanced user interface}}
152
153This is a new set of classes for writing a customizable application
154interface with built-in docking, floatable panes and a flexible
155MDI-like interface. Further classes for custom notebooks with
156draggable tabs etc. are in progress. See also \helpref{wxAUI overview}{wxauioverview}.
157
158\twocolwidtha{6cm}
159\begin{twocollist}\itemsep=0pt
160\twocolitem{\helpref{wxAuiManager}{wxauimanager}}{The central class for managing the interface}
fa2aeeb5 161\twocolitem{\helpref{wxAuiNotebook}{wxauinotebook}}{A replacement notebook class with extra features}
1fdd3f34 162\twocolitem{\helpref{wxAuiPaneInfo}{wxauipaneinfo}}{Describes a single pane}
fa2aeeb5
BW
163\twocolitem{\helpref{wxAuiDockArt}{wxauidockart}}{Art and metrics provider for customizing the docking user interface}
164\twocolitem{\helpref{wxAuiTabArt}{wxauitabart}}{Art and metrics provider for customizing the notebook user interface}
1fdd3f34
RR
165\end{twocollist}
166
167
a660d684
KB
168{\large {\bf Window layout}}
169
1c0c339c 170There are two different systems for laying out windows (and dialogs in particular).
515da557
RR
171One is based upon so-called sizers and it requires less typing, thinking and calculating
172and will in almost all cases produce dialogs looking equally well on all platforms, the
1c0c339c 173other is based on so-called constraints and is deprecated, though still available.
a660d684 174
1c0c339c 175\overview{Sizer overview}{sizeroverview} describes sizer-based layout.
515da557 176
1c0c339c
JS
177These are the classes relevant to sizer-based layout.
178
179\twocolwidtha{6cm}
515da557
RR
180\begin{twocollist}\itemsep=0pt
181\twocolitem{\helpref{wxSizer}{wxsizer}}{Abstract base class}
f6bcfd97
BP
182\twocolitem{\helpref{wxGridSizer}{wxgridsizer}}{A sizer for laying out windows in a grid with all fields having the same size}
183\twocolitem{\helpref{wxFlexGridSizer}{wxflexgridsizer}}{A sizer for laying out windows in a flexible grid}
20b35a69 184\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 185\twocolitem{\helpref{wxBoxSizer}{wxboxsizer}}{A sizer for laying out windows in a row or column}
1c0c339c 186\twocolitem{\helpref{wxStaticBoxSizer}{wxstaticboxsizer}}{Same as wxBoxSizer, but with a surrounding static box}
515da557
RR
187\end{twocollist}
188
1c0c339c 189\overview{Constraints overview}{constraintsoverview} describes constraints-based layout.
515da557
RR
190
191These are the classes relevant to constraints-based window layout.
a660d684 192
1c0c339c 193\twocolwidtha{6cm}
a660d684
KB
194\begin{twocollist}\itemsep=0pt
195\twocolitem{\helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}}{Represents a single constraint dimension}
196\twocolitem{\helpref{wxLayoutConstraints}{wxlayoutconstraints}}{Represents the constraints for a window class}
197\end{twocollist}
198
199{\large {\bf Device contexts}}
200
201\overview{Overview}{dcoverview}
202
203Device contexts are surfaces that may be drawn on, and provide an
204abstraction that allows parameterisation of your drawing code
205by passing different device contexts.
206
1c0c339c 207\twocolwidtha{6cm}
a660d684 208\begin{twocollist}\itemsep=0pt
3dfd8daf 209\twocolitem{\helpref{wxAutoBufferedPaintDC}{wxautobufferedpaintdc}}{A helper device context for double buffered drawing inside \textbf{OnPaint}.}
d6af57d4
VZ
210\twocolitem{\helpref{wxBufferedDC}{wxbuffereddc}}{A helper device context for double buffered drawing.}
211\twocolitem{\helpref{wxBufferedPaintDC}{wxbufferedpaintdc}}{A helper device context for double buffered drawing inside \textbf{OnPaint}.}
a660d684
KB
212\twocolitem{\helpref{wxClientDC}{wxclientdc}}{A device context to access the client area outside {\bf OnPaint} events}
213\twocolitem{\helpref{wxPaintDC}{wxpaintdc}}{A device context to access the client area inside {\bf OnPaint} events}
214\twocolitem{\helpref{wxWindowDC}{wxwindowdc}}{A device context to access the non-client area}
215\twocolitem{\helpref{wxScreenDC}{wxscreendc}}{A device context to access the entire screen}
216\twocolitem{\helpref{wxDC}{wxdc}}{The device context base class}
217\twocolitem{\helpref{wxMemoryDC}{wxmemorydc}}{A device context for drawing into bitmaps}
e2a6f233 218\twocolitem{\helpref{wxMetafileDC}{wxmetafiledc}}{A device context for drawing into metafiles}
8f20ea03 219\twocolitem{\helpref{wxMirrorDC}{wxmirrordc}}{A proxy device context allowing for simple mirroring.}
a660d684
KB
220\twocolitem{\helpref{wxPostScriptDC}{wxpostscriptdc}}{A device context for drawing into PostScript files}
221\twocolitem{\helpref{wxPrinterDC}{wxprinterdc}}{A device context for drawing to printers}
222\end{twocollist}
223
224{\large {\bf Graphics device interface}}
225
226\overview{Bitmaps overview}{wxbitmapoverview}
227
228These classes are related to drawing on device contexts and windows.
229
1c0c339c 230\twocolwidtha{6cm}
a660d684
KB
231\begin{twocollist}\itemsep=0pt
232\twocolitem{\helpref{wxColour}{wxcolour}}{Represents the red, blue and green elements of a colour}
6c975af1 233\twocolitem{\helpref{wxDCClipper}{wxdcclipper}}{Wraps the operations of setting and destroying the clipping region}
a660d684
KB
234\twocolitem{\helpref{wxBitmap}{wxbitmap}}{Represents a bitmap}
235\twocolitem{\helpref{wxBrush}{wxbrush}}{Used for filling areas on a device context}
236\twocolitem{\helpref{wxBrushList}{wxbrushlist}}{The list of previously-created brushes}
237\twocolitem{\helpref{wxCursor}{wxcursor}}{A small, transparent bitmap representing the cursor}
238\twocolitem{\helpref{wxFont}{wxfont}}{Represents fonts}
239\twocolitem{\helpref{wxFontList}{wxfontlist}}{The list of previously-created fonts}
240\twocolitem{\helpref{wxIcon}{wxicon}}{A small, transparent bitmap for assigning to frames and drawing on device contexts}
89c684ef 241\twocolitem{\helpref{wxImage}{wximage}}{A platform-independent image class}
a660d684
KB
242\twocolitem{\helpref{wxImageList}{wximagelist}}{A list of images, used with some controls}
243\twocolitem{\helpref{wxMask}{wxmask}}{Represents a mask to be used with a bitmap for transparent drawing}
244\twocolitem{\helpref{wxPen}{wxpen}}{Used for drawing lines on a device context}
245\twocolitem{\helpref{wxPenList}{wxpenlist}}{The list of previously-created pens}
246\twocolitem{\helpref{wxPalette}{wxpalette}}{Represents a table of indices into RGB values}
247\twocolitem{\helpref{wxRegion}{wxregion}}{Represents a simple or complex region on a window or device context}
684761db 248\twocolitem{\helpref{wxRendererNative}{wxrenderernative}}{Abstracts high-level drawing primitives}
a660d684
KB
249\end{twocollist}
250
251{\large {\bf Events}}
252
253\overview{Overview}{eventhandlingoverview}
254
255An event object contains information about a specific event. Event handlers
256(usually member functions) have a single, event argument.
257
1c0c339c 258\twocolwidtha{6cm}
a660d684
KB
259\begin{twocollist}\itemsep=0pt
260\twocolitem{\helpref{wxActivateEvent}{wxactivateevent}}{A window or application activation event}
f6bcfd97 261\twocolitem{\helpref{wxCalendarEvent}{wxcalendarevent}}{Used with \helpref{wxCalendarCtrl}{wxcalendarctrl}}
6fb26ea3 262\twocolitem{\helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}}{Used to calculate window layout}
66ad556c 263\twocolitem{\helpref{wxChildFocusEvent}{wxchildfocusevent}}{A child window focus event}
78c91815 264\twocolitem{\helpref{wxClipboardTextEvent}{wxclipboardtextevent}}{A clipboard copy/cut/paste treebook event event}
a660d684
KB
265\twocolitem{\helpref{wxCloseEvent}{wxcloseevent}}{A close window or end session event}
266\twocolitem{\helpref{wxCommandEvent}{wxcommandevent}}{An event from a variety of standard controls}
5cb1ae8b 267\twocolitem{\helpref{wxContextMenuEvent}{wxcontextmenuevent}}{An event generated when the user issues a context menu command}
e6e86d52 268\twocolitem{\helpref{wxDateEvent}{wxdateevent}}{Used with \helpref{wxDatePickerCtrl}{wxdatepickerctrl}}
f6bcfd97 269\twocolitem{\helpref{wxDialUpEvent}{wxdialupevent}}{Event send by \helpref{wxDialUpManager}{wxdialupmanager}}
a660d684
KB
270\twocolitem{\helpref{wxDropFilesEvent}{wxdropfilesevent}}{A drop files event}
271\twocolitem{\helpref{wxEraseEvent}{wxeraseevent}}{An erase background event}
272\twocolitem{\helpref{wxEvent}{wxevent}}{The event base class}
f010ad48 273\twocolitem{\helpref{wxFindDialogEvent}{wxfinddialogevent}}{Event sent by
8db37e06 274\helpref{wxFindReplaceDialog}{wxfindreplacedialog}}
a660d684
KB
275\twocolitem{\helpref{wxFocusEvent}{wxfocusevent}}{A window focus event}
276\twocolitem{\helpref{wxKeyEvent}{wxkeyevent}}{A keypress event}
3dd9b88a 277\twocolitem{\helpref{wxIconizeEvent}{wxiconizeevent}}{An iconize/restore event}
a660d684
KB
278\twocolitem{\helpref{wxIdleEvent}{wxidleevent}}{An idle event}
279\twocolitem{\helpref{wxInitDialogEvent}{wxinitdialogevent}}{A dialog initialisation event}
280\twocolitem{\helpref{wxJoystickEvent}{wxjoystickevent}}{A joystick event}
281\twocolitem{\helpref{wxListEvent}{wxlistevent}}{A list control event}
3dd9b88a 282\twocolitem{\helpref{wxMaximizeEvent}{wxmaximizeevent}}{A maximize event}
a660d684 283\twocolitem{\helpref{wxMenuEvent}{wxmenuevent}}{A menu event}
a5e84126 284\twocolitem{\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}}{A mouse capture changed event}
63e819f2 285\twocolitem{\helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}}{A mouse capture lost event}
a660d684
KB
286\twocolitem{\helpref{wxMouseEvent}{wxmouseevent}}{A mouse event}
287\twocolitem{\helpref{wxMoveEvent}{wxmoveevent}}{A move event}
3972fb49 288\twocolitem{\helpref{wxNotebookEvent}{wxnotebookevent}}{A notebook control event}
fd128b0c 289\twocolitem{\helpref{wxNotifyEvent}{wxnotifyevent}}{A notification event, which can be vetoed}
a660d684 290\twocolitem{\helpref{wxPaintEvent}{wxpaintevent}}{A paint event}
3972fb49 291\twocolitem{\helpref{wxProcessEvent}{wxprocessevent}}{A process ending event}
6fb26ea3 292\twocolitem{\helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent}}{Used to query layout information}
5f35b46a 293\twocolitem{\helpref{wxRichTextEvent}{wxrichtextevent}}{A rich text editing event}
fd128b0c
RR
294\twocolitem{\helpref{wxScrollEvent}{wxscrollevent}}{A scroll event from sliders, stand-alone scrollbars and spin buttons}
295\twocolitem{\helpref{wxScrollWinEvent}{wxscrollwinevent}}{A scroll event from scrolled windows}
a660d684 296\twocolitem{\helpref{wxSizeEvent}{wxsizeevent}}{A size event}
42ff6409 297\twocolitem{\helpref{wxSocketEvent}{wxsocketevent}}{A socket event}
f6bcfd97 298\twocolitem{\helpref{wxSpinEvent}{wxspinevent}}{An event from \helpref{wxSpinButton}{wxspinbutton}}
e6e86d52 299\twocolitem{\helpref{wxSplitterEvent}{wxsplitterevent}}{An event from \helpref{wxSplitterWindow}{wxsplitterwindow}}
a660d684 300\twocolitem{\helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}}{A system colour change event}
e3f17fc8 301\twocolitem{\helpref{wxTimerEvent}{wxtimerevent}}{A timer expiration event}
eca15c0d 302\twocolitem{\helpref{wxTreebookEvent}{wxtreebookevent}}{A treebook control event}
a660d684
KB
303\twocolitem{\helpref{wxTreeEvent}{wxtreeevent}}{A tree control event}
304\twocolitem{\helpref{wxUpdateUIEvent}{wxupdateuievent}}{A user interface update event}
4acaa5e2
JS
305\twocolitem{\helpref{wxWindowCreateEvent}{wxwindowcreateevent}}{A window creation event}
306\twocolitem{\helpref{wxWindowDestroyEvent}{wxwindowdestroyevent}}{A window destruction event}
f6bcfd97 307\twocolitem{\helpref{wxWizardEvent}{wxwizardevent}}{A wizard event}
a660d684
KB
308\end{twocollist}
309
310{\large {\bf Validators}}
311
6b037754
JS
312\overview{Overview}{validatoroverview}
313
a660d684
KB
314These are the window validators, used for filtering and validating
315user input.
316
1c0c339c 317\twocolwidtha{6cm}
a660d684 318\begin{twocollist}\itemsep=0pt
89c684ef
JS
319\twocolitem{\helpref{wxValidator}{wxvalidator}}{Base validator class}
320\twocolitem{\helpref{wxTextValidator}{wxtextvalidator}}{Text control validator class}
321\twocolitem{\helpref{wxGenericValidator}{wxgenericvalidator}}{Generic control validator class}
a660d684
KB
322\end{twocollist}
323
324{\large {\bf Data structures}}
325
fc2171bd 326These are the data structure classes supported by wxWidgets.
a660d684 327
1c0c339c 328\twocolwidtha{6cm}
a660d684 329\begin{twocollist}\itemsep=0pt
f6bcfd97 330\twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class}
f6bcfd97 331\twocolitem{\helpref{wxDateSpan}{wxdatespan}}{A logical time interval.}
d7da9756 332\twocolitem{\helpref{wxDateTime}{wxdatetime}}{A class for date/time manipulations}
c92ddcd2
JS
333%\twocolitem{\helpref{wxExpr}{wxexpr}}{A class for flexible I/O}
334%\twocolitem{\helpref{wxExprDatabase}{wxexprdatabase}}{A class for flexible I/O}
e6e86d52
MR
335\twocolitem{\helpref{wxArray}{wxarray}}{A dynamic array implementation}
336\twocolitem{\helpref{wxArrayString}{wxarraystring}}{An efficient container for storing \helpref{wxString}{wxstring} objects}
e676441f 337\twocolitem{\helpref{wxHashMap}{wxhashmap}}{A simple hash map implementation}
8cd74a14 338\twocolitem{\helpref{wxHashSet}{wxhashset}}{A simple hash set implementation}
e676441f 339\twocolitem{\helpref{wxHashTable}{wxhashtable}}{A simple hash table implementation (deprecated, use wxHashMap)}
d7da9756 340% \twocolitem{\helpref{wxHashTableLong}{wxhashtablelong}}{A wxHashTable version for storing long data}
a660d684 341\twocolitem{\helpref{wxList}{wxlist}}{A simple linked list implementation}
d7da9756 342\twocolitem{\helpref{wxLongLong}{wxlonglong}}{A portable 64 bit integer type}
a660d684 343\twocolitem{\helpref{wxNode}{wxnode}}{Represents a node in the wxList implementation}
fc2171bd 344\twocolitem{\helpref{wxObject}{wxobject}}{The root class for most wxWidgets classes}
a660d684
KB
345\twocolitem{\helpref{wxPathList}{wxpathlist}}{A class to help search multiple paths}
346\twocolitem{\helpref{wxPoint}{wxpoint}}{Representation of a point}
347\twocolitem{\helpref{wxRect}{wxrect}}{A class representing a rectangle}
8fb2999a 348\twocolitem{\helpref{wxRegEx}{wxregex}}{Regular expression support}
a660d684
KB
349\twocolitem{\helpref{wxRegion}{wxregion}}{A class representing a region}
350\twocolitem{\helpref{wxString}{wxstring}}{A string class}
9c884972 351\twocolitem{\helpref{wxStringTokenizer}{wxstringtokenizer}}{A class for interpreting a string as a list of tokens or words}
a660d684
KB
352\twocolitem{\helpref{wxRealPoint}{wxrealpoint}}{Representation of a point using floating point numbers}
353\twocolitem{\helpref{wxSize}{wxsize}}{Representation of a size}
f6bcfd97 354\twocolitem{\helpref{wxTimeSpan}{wxtimespan}}{A time interval.}
86470d43 355\twocolitem{\helpref{wxURI}{wxuri}}{Represents a Uniform Resource Identifier}
d7da9756 356\twocolitem{\helpref{wxVariant}{wxvariant}}{A class for storing arbitrary types that may change at run-time}
a660d684
KB
357\end{twocollist}
358
359{\large {\bf Run-time class information system}}
360
361\overview{Overview}{runtimeclassoverview}
362
fc2171bd 363wxWidgets supports run-time manipulation of class information, and dynamic
a660d684
KB
364creation of objects given class names.
365
1c0c339c 366\twocolwidtha{6cm}
a660d684
KB
367\begin{twocollist}\itemsep=0pt
368\twocolitem{\helpref{wxClassInfo}{wxclassinfo}}{Holds run-time class information}
369\twocolitem{\helpref{wxObject}{wxobject}}{Root class for classes with run-time information}
f4fcc291 370\twocolitem{\helpref{RTTI macros}{rttimacros}}{Macros for manipulating run-time information}
a660d684
KB
371\end{twocollist}
372
2fda2145 373{\large {\bf Logging features}}
a660d684 374
30fc2c8e 375\overview{Overview}{wxlogoverview}
f1fa9adc 376
fc2171bd 377wxWidgets provides several classes and functions for message logging.
f1fa9adc
VZ
378Please see the \helpref{wxLog overview}{wxlogoverview} for more details.
379
1c0c339c 380\twocolwidtha{6cm}
f1fa9adc
VZ
381\begin{twocollist}\itemsep=0pt
382\twocolitem{\helpref{wxLog}{wxlog}}{The base log class}
383\twocolitem{\helpref{wxLogStderr}{wxlogstderr}}{Log messages to a C STDIO stream}
384\twocolitem{\helpref{wxLogStream}{wxlogstream}}{Log messages to a C++ iostream}
385\twocolitem{\helpref{wxLogTextCtrl}{wxlogtextctrl}}{Log messages to a \helpref{wxTextCtrl}{wxtextctrl}}
386\twocolitem{\helpref{wxLogWindow}{wxlogwindow}}{Log messages to a log frame}
387\twocolitem{\helpref{wxLogGui}{wxloggui}}{Default log target for GUI programs}
388\twocolitem{\helpref{wxLogNull}{wxlognull}}{Temporarily suppress message logging}
389\twocolitem{\helpref{wxLogChain}{wxlogchain}}{Allows to chain two log targets}
7ffc857f
VZ
390\twocolitem{\helpref{wxLogInterposer}{wxloginterposer}}{Allows to filter the log messages}
391\twocolitem{\helpref{wxLogInterposerTemp}{wxloginterposertemp}}{Allows to filter the log messages}
f1fa9adc
VZ
392\twocolitem{\helpref{wxStreamToTextRedirector}{wxstreamtotextredirector}}{Allows
393to redirect output sent to {\tt cout} to a \helpref{wxTextCtrl}{wxtextctrl}}
394\twocolitem{\helpref{Log functions}{logfunctions}}{Error and warning logging functions}
395\end{twocollist}
396
397{\large {\bf Debugging features}}
398
a660d684
KB
399\overview{Overview}{debuggingoverview}
400
fc2171bd 401wxWidgets supports some aspects of debugging an application through
a660d684
KB
402classes, functions and macros.
403
1c0c339c 404\twocolwidtha{6cm}
a660d684 405\begin{twocollist}\itemsep=0pt
6b037754 406\twocolitem{\helpref{wxDebugContext}{wxdebugcontext}}{Provides memory-checking facilities}
6b037754 407\twocolitem{\helpref{Debugging macros}{debugmacros}}{Debug macros for assertion and checking}
a660d684 408\twocolitem{\helpref{WXDEBUG\_NEW}{debugnew}}{Use this macro to give further debugging information}
af127680
VZ
409\twocolitem{\helpref{wxDebugReport}{wxdebugreport}}{Base class for creating debug reports in case of a program crash.}
410\twocolitem{\helpref{wxDebugReportCompress}{wxdebugreportcompress}}{Class for creating compressed debug reports.}
411\twocolitem{\helpref{wxDebugReportUpload}{wxdebugreportupload}}{Class for uploading compressed debug reports via HTTP.}
412\twocolitem{\helpref{wxDebugReportPreview}{wxdebugreportpreview}}{Abstract base class for previewing the contents of a debug report.}
413\twocolitem{\helpref{wxDebugReportPreviewStd}{wxdebugreportpreviewstd}}{Standard implementation of wxDebugReportPreview.}
a660d684
KB
414\end{twocollist}
415
238ddd26
RR
416{\large {\bf Networking classes}}
417
fc2171bd 418wxWidgets provides its own classes for socket based networking.
238ddd26 419
1c0c339c 420\twocolwidtha{6cm}
238ddd26 421\begin{twocollist}\itemsep=0pt
f6bcfd97
BP
422\twocolitem{\helpref{wxDialUpManager}{wxdialupmanager}}{Provides functions to check the status of network connection and to establish one}
423\twocolitem{\helpref{wxIPV4address}{wxipv4address}}{Represents an Internet address}
be4bd463 424\twocolitem{\helpref{wxIPaddress}{wxipaddress}}{Represents an Internet address}
672186ef 425\twocolitem{\helpref{wxSocketBase}{wxsocketbase}}{Represents a socket base object}
238ddd26
RR
426\twocolitem{\helpref{wxSocketClient}{wxsocketclient}}{Represents a socket client}
427\twocolitem{\helpref{wxSocketServer}{wxsocketserver}}{Represents a socket server}
238ddd26 428\twocolitem{\helpref{wxSocketEvent}{wxsocketevent}}{A socket event}
672186ef
GRG
429\twocolitem{\helpref{wxFTP}{wxftp}}{FTP protocol class}
430\twocolitem{\helpref{wxHTTP}{wxhttp}}{HTTP protocol class}
431\twocolitem{\helpref{wxURL}{wxurl}}{Represents a Universal Resource Locator}
238ddd26
RR
432\end{twocollist}
433
434
a660d684
KB
435{\large {\bf Interprocess communication}}
436
437\overview{Overview}{ipcoverview}
438
fc2171bd 439wxWidgets provides simple interprocess communications facilities
f010ad48 440based on Windows DDE, but available on most platforms using TCP.
a660d684 441
1c0c339c 442\twocolwidtha{6cm}
a660d684 443\begin{twocollist}\itemsep=0pt
f510b7b2
WS
444\twocolitem{\helpref{wxClient}{wxclient}, \helpref{wxDDEClient}{wxddeclient}}{Represents a client}
445\twocolitem{\helpref{wxConnection}{wxconnection}, \helpref{wxDDEConnection}{wxddeconnection}}{Represents the connection between a client and a server}
446\twocolitem{\helpref{wxServer}{wxserver}, \helpref{wxDDEServer}{wxddeserver}}{Represents a server}
d7cb14ce 447%\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler}
a660d684
KB
448\end{twocollist}
449
450{\large {\bf Document/view framework}}
451
452\overview{Overview}{docviewoverview}
453
fc2171bd 454wxWidgets supports a document/view framework which provides
a660d684
KB
455housekeeping for a document-centric application.
456
1c0c339c 457\twocolwidtha{6cm}
a660d684
KB
458\begin{twocollist}\itemsep=0pt
459\twocolitem{\helpref{wxDocument}{wxdocument}}{Represents a document}
460\twocolitem{\helpref{wxView}{wxview}}{Represents a view}
f6bcfd97 461\twocolitem{\helpref{wxDocTemplate}{wxdoctemplate}}{Manages the relationship between a document class and a view class}
a660d684
KB
462\twocolitem{\helpref{wxDocManager}{wxdocmanager}}{Manages the documents and views in an application}
463\twocolitem{\helpref{wxDocChildFrame}{wxdocchildframe}}{A child frame for showing a document view}
464\twocolitem{\helpref{wxDocParentFrame}{wxdocparentframe}}{A parent frame to contain views}
6fb26ea3
JS
465%\twocolitem{\helpref{wxMDIDocChildFrame}{wxmdidocchildframe}}{An MDI child frame for showing a document view}
466%\twocolitem{\helpref{wxMDIDocParentFrame}{wxmdidocparentframe}}{An MDI parent frame to contain views}
a660d684
KB
467\end{twocollist}
468
469{\large {\bf Printing framework}}
470
471\overview{Overview}{printingoverview}
472
473A printing and previewing framework is implemented to
f6bcfd97 474make it relatively straightforward to provide document printing
a660d684
KB
475facilities.
476
1c0c339c 477\twocolwidtha{6cm}
a660d684
KB
478\begin{twocollist}\itemsep=0pt
479\twocolitem{\helpref{wxPreviewFrame}{wxpreviewframe}}{Frame for displaying a print preview}
480\twocolitem{\helpref{wxPreviewCanvas}{wxpreviewcanvas}}{Canvas for displaying a print preview}
481\twocolitem{\helpref{wxPreviewControlBar}{wxpreviewcontrolbar}}{Standard control bar for a print preview}
a660d684 482\twocolitem{\helpref{wxPrintDialog}{wxprintdialog}}{Standard print dialog}
7bcb11d3 483\twocolitem{\helpref{wxPageSetupDialog}{wxpagesetupdialog}}{Standard page setup dialog}
a660d684
KB
484\twocolitem{\helpref{wxPrinter}{wxprinter}}{Class representing the printer}
485\twocolitem{\helpref{wxPrinterDC}{wxprinterdc}}{Printer device context}
486\twocolitem{\helpref{wxPrintout}{wxprintout}}{Class representing a particular printout}
487\twocolitem{\helpref{wxPrintPreview}{wxprintpreview}}{Class representing a print preview}
7bcb11d3
JS
488\twocolitem{\helpref{wxPrintData}{wxprintdata}}{Represents information about the document being printed}
489\twocolitem{\helpref{wxPrintDialogData}{wxprintdialogdata}}{Represents information about the print dialog}
490\twocolitem{\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}}{Represents information about the page setup dialog}
a660d684
KB
491\end{twocollist}
492
dface61c
JS
493{\large {\bf Drag and drop and clipboard classes}}
494
495\overview{Drag and drop and clipboard overview}{wxdndoverview}
496
1c0c339c 497\twocolwidtha{6cm}
dface61c 498\begin{twocollist}\itemsep=0pt
dface61c 499\twocolitem{\helpref{wxDataObject}{wxdataobject}}{Data object class}
c03648c2 500\twocolitem{\helpref{wxDataFormat}{wxdataformat}}{Represents a data format}
dface61c 501\twocolitem{\helpref{wxTextDataObject}{wxtextdataobject}}{Text data object class}
5ab2950d 502\twocolitem{\helpref{wxFileDataObject}{wxfiledataobject}}{File data object class}
dface61c 503\twocolitem{\helpref{wxBitmapDataObject}{wxbitmapdataobject}}{Bitmap data object class}
c959d912 504\twocolitem{\helpref{wxURLDataObject}{wxurldataobject}}{URL data object class}
0a2017e0 505\twocolitem{\helpref{wxCustomDataObject}{wxcustomdataobject}}{Custom data object class}
dface61c 506\twocolitem{\helpref{wxClipboard}{wxclipboard}}{Clipboard class}
5aa5e35a
RR
507\twocolitem{\helpref{wxDropTarget}{wxdroptarget}}{Drop target class}
508\twocolitem{\helpref{wxFileDropTarget}{wxfiledroptarget}}{File drop target class}
509\twocolitem{\helpref{wxTextDropTarget}{wxtextdroptarget}}{Text drop target class}
510\twocolitem{\helpref{wxDropSource}{wxdropsource}}{Drop source class}
dface61c
JS
511\end{twocollist}
512
247aba10
VZ
513{\large {\bf File related classes}}
514
fc2171bd 515wxWidgets has several small classes to work with disk files, see \helpref{file classes
247aba10
VZ
516overview}{wxfileoverview} for more details.
517
1c0c339c 518\twocolwidtha{6cm}
247aba10 519\begin{twocollist}\itemsep=0pt
2569938d 520\twocolitem{\helpref{wxFileName}{wxfilename}}{Operations with the file name and attributes}
4afd7529 521\twocolitem{\helpref{wxDir}{wxdir}}{Class for enumerating files/subdirectories.}
509cd921 522\twocolitem{\helpref{wxDirTraverser}{wxdirtraverser}}{Class used together with wxDir for recursively enumerating the files/subdirectories}
842d6c94
RR
523\twocolitem{\helpref{wxFile}{wxfile}}{Low-level file input/output class.}
524\twocolitem{\helpref{wxFFile}{wxffile}}{Another low-level file input/output class.}
247aba10
VZ
525\twocolitem{\helpref{wxTempFile}{wxtempfile}}{Class to safely replace an existing file}
526\twocolitem{\helpref{wxTextFile}{wxtextfile}}{Class for working with text files as with arrays of lines}
a8d08dbd 527\twocolitem{\helpref{wxStandardPaths}{wxstandardpaths}}{Paths for standard directories}
247aba10
VZ
528\end{twocollist}
529
631f1bfe
JS
530{\large {\bf Stream classes}}
531
fc2171bd 532wxWidgets has its own set of stream classes, as an alternative to often buggy standard stream
631f1bfe
JS
533libraries, and to provide enhanced functionality.
534
1c0c339c 535\twocolwidtha{6cm}
631f1bfe
JS
536\begin{twocollist}\itemsep=0pt
537\twocolitem{\helpref{wxStreamBase}{wxstreambase}}{Stream base class}
538\twocolitem{\helpref{wxStreamBuffer}{wxstreambuffer}}{Stream buffer class}
539\twocolitem{\helpref{wxInputStream}{wxinputstream}}{Input stream class}
540\twocolitem{\helpref{wxOutputStream}{wxoutputstream}}{Output stream class}
d984207c 541\twocolitem{\helpref{wxCountingOutputStream}{wxcountingoutputstream}}{Stream class for querying what size a stream would have.}
631f1bfe
JS
542\twocolitem{\helpref{wxFilterInputStream}{wxfilterinputstream}}{Filtered input stream class}
543\twocolitem{\helpref{wxFilterOutputStream}{wxfilteroutputstream}}{Filtered output stream class}
d984207c
RR
544\twocolitem{\helpref{wxBufferedInputStream}{wxbufferedinputstream}}{Buffered input stream class}
545\twocolitem{\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}}{Buffered output stream class}
2bf8e4eb
RR
546\twocolitem{\helpref{wxMemoryInputStream}{wxmeminputstream}}{Memory input stream class}
547\twocolitem{\helpref{wxMemoryOutputStream}{wxmemoutputstream}}{Memory output stream class}
7ff14117
RR
548\twocolitem{\helpref{wxDataInputStream}{wxdatainputstream}}{Platform-independent binary data input stream class}
549\twocolitem{\helpref{wxDataOutputStream}{wxdataoutputstream}}{Platform-independent binary data output stream class}
550\twocolitem{\helpref{wxTextInputStream}{wxtextinputstream}}{Platform-independent text data input stream class}
551\twocolitem{\helpref{wxTextOutputStream}{wxtextoutputstream}}{Platform-independent text data output stream class}
631f1bfe
JS
552\twocolitem{\helpref{wxFileInputStream}{wxfileinputstream}}{File input stream class}
553\twocolitem{\helpref{wxFileOutputStream}{wxfileoutputstream}}{File output stream class}
842d6c94
RR
554\twocolitem{\helpref{wxFFileInputStream}{wxffileinputstream}}{Another file input stream class}
555\twocolitem{\helpref{wxFFileOutputStream}{wxffileoutputstream}}{Another file output stream class}
e1265174 556\twocolitem{\helpref{wxTempFileOutputStream}{wxtempfileoutputstream}}{Stream to safely replace an existing file}
121fa06a
VZ
557\twocolitem{\helpref{wxStringInputStream}{wxstringinputstream}}{String input stream class}
558\twocolitem{\helpref{wxStringOutputStream}{wxstringoutputstream}}{String output stream class}
b34c7f3c
MW
559\twocolitem{\helpref{wxZlibInputStream}{wxzlibinputstream}}{Zlib and gzip (compression) input stream class}
560\twocolitem{\helpref{wxZlibOutputStream}{wxzliboutputstream}}{Zlib and gzip (compression) output stream class}
738bfca9 561\twocolitem{\helpref{wxZipInputStream}{wxzipinputstream}}{Input stream for reading from ZIP archives}
df467a9d 562\twocolitem{\helpref{wxZipOutputStream}{wxzipoutputstream}}{Output stream for writing from ZIP archives}
b34c7f3c
MW
563\twocolitem{\helpref{wxTarInputStream}{wxtarinputstream}}{Input stream for reading from tar archives}
564\twocolitem{\helpref{wxTarOutputStream}{wxtaroutputstream}}{Output stream for writing from tar archives}
631f1bfe
JS
565\twocolitem{\helpref{wxSocketInputStream}{wxsocketinputstream}}{Socket input stream class}
566\twocolitem{\helpref{wxSocketOutputStream}{wxsocketoutputstream}}{Socket output stream class}
567\end{twocollist}
568
238ddd26
RR
569{\large {\bf Threading classes}}
570
571\overview{Multithreading overview}{wxthreadoverview}
738bfca9 572
fc2171bd 573wxWidgets provides a set of classes to make use of the native thread
238ddd26
RR
574capabilities of the various platforms.
575
1c0c339c 576\twocolwidtha{6cm}
238ddd26
RR
577\begin{twocollist}\itemsep=0pt
578\twocolitem{\helpref{wxThread}{wxthread}}{Thread class}
78ee6a47 579\twocolitem{\helpref{wxThreadHelper}{wxthreadhelper}}{Manages background threads easily}
238ddd26
RR
580\twocolitem{\helpref{wxMutex}{wxmutex}}{Mutex class}
581\twocolitem{\helpref{wxMutexLocker}{wxmutexlocker}}{Mutex locker utility class}
582\twocolitem{\helpref{wxCriticalSection}{wxcriticalsection}}{Critical section class}
f6bcfd97 583\twocolitem{\helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}}{Critical section locker utility class}
88413fec 584\twocolitem{\helpref{wxCondition}{wxcondition}}{Condition class}
be809868 585\twocolitem{\helpref{wxSemaphore}{wxsemaphore}}{Semaphore class}
238ddd26
RR
586\end{twocollist}
587
588{\large {\bf HTML classes}}
589
fc2171bd 590wxWidgets provides a set of classes to display text in HTML format. These
238ddd26 591class include a help system based on the HTML widget.
738bfca9 592
1c0c339c 593\twocolwidtha{6cm}
738bfca9
VS
594\begin{twocollist}\itemsep=0pt
595\twocolitem{\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}}{HTML help controller class}
596\twocolitem{\helpref{wxHtmlWindow}{wxhtmlwindow}}{HTML window class}
e5436d59
VS
597\twocolitem{\helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting}}{Simple class for printing HTML}
598\twocolitem{\helpref{wxHtmlPrintout}{wxhtmlprintout}}{Generic HTML wxPrintout class}
738bfca9
VS
599\twocolitem{\helpref{wxHtmlParser}{wxhtmlparser}}{Generic HTML parser class}
600\twocolitem{\helpref{wxHtmlTagHandler}{wxhtmltaghandler}}{HTML tag handler, pluginable into wxHtmlParser}
601\twocolitem{\helpref{wxHtmlWinParser}{wxhtmlwinparser}}{HTML parser class for wxHtmlWindow}
602\twocolitem{\helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}}{HTML tag handler, pluginable into wxHtmlWinParser}
603\end{twocollist}
604
4aeaf419
JS
605{\large {\bf Rich text classes}}
606
607wxWidgets provides a set of generic classes to edit and print simple rich text with character
608and paragraph formatting.
609
610\twocolwidtha{6cm}
611\begin{twocollist}\itemsep=0pt
612\twocolitem{\helpref{wxRichTextCtrl}{wxrichtextctrl}}{A rich text control.}
613\twocolitem{\helpref{wxRichTextBuffer}{wxrichtextbuffer}}{The content of a rich text control.}
614\twocolitem{\helpref{wxRichTextAttr}{wxrichtextattr}}{Attributes specifying rich text styling.}
615\twocolitem{\helpref{wxRichTextCharacterStyleDefinition}{wxrichtextcharacterstyledefinition}}{Definition of character styling.}
616\twocolitem{\helpref{wxRichTextParagraphStyleDefinition}{wxrichtextparagraphstyledefinition}}{Definition of paragraph styling.}
617\twocolitem{\helpref{wxRichTextListStyleDefinition}{wxrichtextliststyledefinition}}{Definition of list styling.}
618\twocolitem{\helpref{wxRichTextStyleSheet}{wxrichtextstylesheet}}{A set of style definitions.}
619\twocolitem{\helpref{wxRichTextStyleComboCtrl}{wxrichtextstylecomboctrl}}{A drop-down control for applying styles.}
620\twocolitem{\helpref{wxRichTextStyleListBox}{wxrichtextstylelistbox}}{A listbox for applying styles.}
21fae46d 621\twocolitem{\helpref{wxRichTextStyleOrganiserDialog}{wxrichtextstyleorganiserdialog}}{A dialog that can be used for managing or browsing styles.}
4aeaf419
JS
622\twocolitem{\helpref{wxRichTextEvent}{wxrichtextevent}}{A rich text event.}
623\twocolitem{\helpref{wxRichTextRange}{wxrichtextrange}}{Specification for ranges in a rich text control or buffer.}
624\twocolitem{\helpref{wxRichTextFileHandler}{wxrichtextfilehandler}}{File handler base class.}
625\twocolitem{\helpref{wxRichTextHTMLHandler}{wxrichtexthtmlhandler}}{A handler for converting rich text to HTML.}
626\twocolitem{\helpref{wxRichTextXMLHandler}{wxrichtextxmlhandler}}{A handler for loading and saving rich text XML.}
627\twocolitem{\helpref{wxRichTextFormattingDialog}{wxrichtextformattingdialog}}{A dialog for rich text formatting.}
628\twocolitem{\helpref{wxRichTextPrinting}{wxrichtextprinting}}{A class for easy printing of rich text buffers.}
629\twocolitem{\helpref{wxRichTextPrintout}{wxrichtextprintout}}{A class used by wxRichTextPrinting.}
630\twocolitem{\helpref{wxRichTextHeaderFooterData}{wxrichtextheaderfooterdata}}{Header and footer data specification.}
631\end{twocollist}
632
88413fec
RR
633{\large {\bf Virtual file system classes}}
634
fc2171bd 635wxWidgets provides a set of classes that implement an extensible virtual file system,
88413fec
RR
636used internally by the HTML classes.
637
1c0c339c 638\twocolwidtha{6cm}
88413fec
RR
639\begin{twocollist}\itemsep=0pt
640\twocolitem{\helpref{wxFSFile}{wxfsfile}}{Represents a file in the virtual file system}
641\twocolitem{\helpref{wxFileSystem}{wxfilesystem}}{Main interface for the virtual file system}
642\twocolitem{\helpref{wxFileSystemHandler}{wxfilesystemhandler}}{Class used to announce file system type}
643\end{twocollist}
644
3193b86f
VZ
645{\large {\bf XML classes}}
646
647\twocolwidtha{6cm}
648\begin{twocollist}\itemsep=0pt
649\twocolitem{\helpref{wxXmlDocument}{wxxmldocument}}{A class to parse XML files.}
650\twocolitem{\helpref{wxXmlNode}{wxxmlnode}}{A class which represents XML nodes.}
288b6107 651\twocolitem{\helpref{wxXmlAttribute}{wxxmlattribute}}{A class which represents XML properties.}
3193b86f
VZ
652\end{twocollist}
653
d958c9bd
JS
654{\large {\bf XML-based resource system classes}}
655
3980000c 656\overview{XML-based resource system (XRC) overview}{xrcoverview}
d958c9bd
JS
657
658Resources allow your application to create controls and other user interface elements
659from specifications stored in an XML format.
660
1c0c339c 661\twocolwidtha{6cm}
d958c9bd
JS
662\begin{twocollist}\itemsep=0pt
663\twocolitem{\helpref{wxXmlResource}{wxxmlresource}}{The main class for working with resources.}
664\twocolitem{\helpref{wxXmlResourceHandler}{wxxmlresourcehandler}}{The base class for XML resource handlers.}
665\end{twocollist}
666
7cb74906
JS
667{\large {\bf Online help}}
668
1c0c339c 669\twocolwidtha{6cm}
7cb74906
JS
670\begin{twocollist}\itemsep=0pt
671\twocolitem{\helpref{wxHelpController}{wxhelpcontroller}}{Family of classes for controlling help windows}
672\twocolitem{\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}}{HTML help controller class}
673\twocolitem{\helpref{wxContextHelp}{wxcontexthelp}}{Class to put application into context-sensitive help mode}
674\twocolitem{\helpref{wxContextHelpButton}{wxcontexthelpbutton}}{Button class for putting application into context-sensitive help mode}
675\twocolitem{\helpref{wxHelpProvider}{wxhelpprovider}}{Abstract class for context-sensitive help provision}
676\twocolitem{\helpref{wxSimpleHelpProvider}{wxsimplehelpprovider}}{Class for simple context-sensitive help provision}
677\twocolitem{\helpref{wxHelpControllerHelpProvider}{wxhelpcontrollerhelpprovider}}{Class for context-sensitive help provision via a help controller}
678\twocolitem{\helpref{wxToolTip}{wxtooltip}}{Class implementing tooltips}
679\end{twocollist}
680
509cd921
VZ
681{\large {\bf Database classes}}
682
683\overview{Database classes overview}{odbcoverview}
684
fc2171bd 685wxWidgets provides a set of classes for accessing Microsoft's ODBC (Open Database Connectivity)
f7292ebe 686product, donated by Remstar. This is known as wxODBC.
509cd921 687
1c0c339c 688\twocolwidtha{6cm}
509cd921
VZ
689\begin{twocollist}\itemsep=0pt
690\twocolitem{\helpref{wxDb}{wxdb}}{ODBC database connection}
691\twocolitem{\helpref{wxDbTable}{wxdbtable}}{Provides access to a database table}
692\twocolitem{\helpref{wxDbInf}{wxdbinf}}{}
693\twocolitem{\helpref{wxDbTableInf}{wxdbtableinf}}{}
694\twocolitem{\helpref{wxDbColDef}{wxdbcoldef}}{}
695\twocolitem{\helpref{wxDbColInf}{wxdbcolinf}}{}
44bb263a 696\twocolitem{\helpref{wxDbColDataPtr}{wxdbcoldataptr}}{}
509cd921
VZ
697\twocolitem{\helpref{wxDbColFor}{wxdbcolfor}}{}
698\twocolitem{\helpref{wxDbConnectInf}{wxdbconnectinf}}{}
0f353563 699\twocolitem{\helpref{wxDbIdxDef}{wxdbidxdef}}{}
509cd921
VZ
700\end{twocollist}
701
a660d684
KB
702{\large {\bf Miscellaneous}}
703
1c0c339c 704\twocolwidtha{6cm}
a660d684
KB
705\begin{twocollist}\itemsep=0pt
706\twocolitem{\helpref{wxApp}{wxapp}}{Application class}
f6bcfd97
BP
707\twocolitem{\helpref{wxCaret}{wxcaret}}{A caret (cursor) object}
708\twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class}
709\twocolitem{\helpref{wxConfig}{wxconfigbase}}{Classes for configuration reading/writing (using either INI files or registry)}
710\twocolitem{\helpref{wxDllLoader}{wxdllloader}}{Class to work with shared libraries.}
43e8916f
MW
711\twocolitem{\helpref{wxGLCanvas}{wxglcanvas}}{Canvas that you can render OpenGL calls to.}
712\twocolitem{\helpref{wxGLContext}{wxglcontext}}{Class to ease sharing of OpenGL data resources.}
6fb26ea3 713\twocolitem{\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}}{An alternative window layout facility}
3972fb49 714\twocolitem{\helpref{wxProcess}{wxprocess}}{Process class}
a660d684 715\twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class}
5f445b31 716\twocolitem{\helpref{wxStopWatch}{wxstopwatch}}{Stop watch class}
88413fec 717\twocolitem{\helpref{wxMimeTypesManager}{wxmimetypesmanager}}{MIME-types manager class}
0cbff120
JS
718\twocolitem{\helpref{wxSystemSettings}{wxsystemsettings}}{System settings class for obtaining various global parameters}
719\twocolitem{\helpref{wxSystemOptions}{wxsystemoptions}}{System options class for run-time configuration}
238ddd26
RR
720\twocolitem{\helpref{wxAcceleratorTable}{wxacceleratortable}}{Accelerator table}
721\twocolitem{\helpref{wxAutomationObject}{wxautomationobject}}{OLE automation class}
5d9dba5b
VS
722\twocolitem{\helpref{wxFontMapper}{wxfontmapper}}{Font mapping, finding suitable font for given encoding}
723\twocolitem{\helpref{wxEncodingConverter}{wxencodingconverter}}{Encoding conversions}
f6bcfd97 724\twocolitem{\helpref{wxCalendarDateAttr}{wxcalendardateattr}}{Used with \helpref{wxCalendarCtrl}{wxcalendarctrl}}
e3c10211 725\twocolitem{\helpref{wxQuantize}{wxquantize}}{Class to perform quantization, or colour reduction}
68a602fc 726\twocolitem{\helpref{wxSingleInstanceChecker}{wxsingleinstancechecker}}{Check that only single program instance is running}
238ddd26 727\end{twocollist}