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