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