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