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