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