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