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