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