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