]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/category.tex
Missing header.
[wxWidgets.git] / docs / latex / wx / category.tex
... / ...
CommitLineData
1\chapter{Classes by category}\label{classesbycat}
2\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
3\setfooter{\thepage}{}{}{}{}{\thepage}%
4
5A classification of wxWidgets classes by category.
6
7{\large {\bf Managed windows}}
8
9There are several types of window that are directly controlled by the
10window manager (such as MS Windows, or the Motif Window Manager).
11Frames and dialogs are similar in wxWidgets, but only dialogs may be modal.
12
13\twocolwidtha{6cm}
14\begin{twocollist}\itemsep=0pt
15\twocolitem{\helpref{wxTopLevelWindow}{wxtoplevelwindow}}{Any top level window, dialog or frame}
16\twocolitem{\helpref{wxDialog}{wxdialog}}{Dialog box}
17\twocolitem{\helpref{wxFrame}{wxframe}}{Normal frame}
18\twocolitem{\helpref{wxMDIChildFrame}{wxmdichildframe}}{MDI child frame}
19\twocolitem{\helpref{wxMDIParentFrame}{wxmdiparentframe}}{MDI parent frame}
20\twocolitem{\helpref{wxMiniFrame}{wxminiframe}}{A frame with a small title bar}
21\twocolitem{\helpref{wxSplashScreen}{wxsplashscreen}}{Splash screen class}
22\twocolitem{\helpref{wxPropertySheetDialog}{wxpropertysheetdialog}}{Property sheet dialog}
23%\twocolitem{\helpref{wxTabbedDialog}{wxtabbeddialog}}{Tabbed dialog
24%(deprecated, use wxNotebook instead)}
25\twocolitem{\helpref{wxTipWindow}{wxtipwindow}}{Shows text in a small window}
26\twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog}
27\end{twocollist}
28
29See also {\bf Common dialogs}.
30
31{\large {\bf Miscellaneous windows}}
32
33The following are a variety of classes that are derived from wxWindow.
34
35\twocolwidtha{6cm}
36\begin{twocollist}\itemsep=0pt
37\twocolitem{\helpref{wxPanel}{wxpanel}}{A window whose colour changes according to current user settings}
38\twocolitem{\helpref{wxScrolledWindow}{wxscrolledwindow}}{Window with automatically managed scrollbars}
39\twocolitem{\helpref{wxGrid}{wxgrid}}{A grid (table) window}
40\twocolitem{\helpref{wxSplitterWindow}{wxsplitterwindow}}{Window which can be split vertically or horizontally}
41\twocolitem{\helpref{wxStatusBar}{wxstatusbar}}{Implements the status bar on a frame}
42\twocolitem{\helpref{wxToolBar}{wxtoolbar}}{Toolbar class}
43%\twocolitem{\helpref{wxTabbedPanel}{wxtabbedpanel}}{Tabbed panel (to be replaced with wxNotebook)}
44\twocolitem{\helpref{wxNotebook}{wxnotebook}}{Notebook class}
45\twocolitem{\helpref{wxListbook}{wxlistbook}}{Similar to notebook but using list control}
46\twocolitem{\helpref{wxChoicebook}{wxchoicebook}}{Similar to notebook but using choice control}
47\twocolitem{\helpref{wxTreebook}{wxtreebook}}{Similar to notebook but using tree control}
48\twocolitem{\helpref{wxSashWindow}{wxsashwindow}}{Window with four optional sashes that can be dragged}
49\twocolitem{\helpref{wxSashLayoutWindow}{wxsashlayoutwindow}}{Window that can be involved in an IDE-like layout arrangement}
50\twocolitem{\helpref{wxVScrolledWindow}{wxvscrolledwindow}}{As wxScrolledWindow but supports lines of variable height}
51\twocolitem{\helpref{wxWizardPage}{wxwizardpage}}{A base class for the page in wizard dialog.}
52\twocolitem{\helpref{wxWizardPageSimple}{wxwizardpagesimple}}{A page in wizard dialog.}
53\end{twocollist}
54
55{\large {\bf Common dialogs}}
56
57\overview{Overview}{commondialogsoverview}
58
59Common dialogs are ready-made dialog classes which are frequently used
60in an application.
61
62\twocolwidtha{6cm}
63\begin{twocollist}\itemsep=0pt
64\twocolitem{\helpref{wxDialog}{wxdialog}}{Base class for common dialogs}
65\twocolitem{\helpref{wxColourDialog}{wxcolourdialog}}{Colour chooser dialog}
66\twocolitem{\helpref{wxDirDialog}{wxdirdialog}}{Directory selector dialog}
67\twocolitem{\helpref{wxFileDialog}{wxfiledialog}}{File selector dialog}
68\twocolitem{\helpref{wxFindReplaceDialog}{wxfindreplacedialog}}{Text search/replace dialog}
69\twocolitem{\helpref{wxMultiChoiceDialog}{wxmultichoicedialog}}{Dialog to get one or more selections from a list}
70\twocolitem{\helpref{wxSingleChoiceDialog}{wxsinglechoicedialog}}{Dialog to get a single selection from a list and return the string}
71\twocolitem{\helpref{wxTextEntryDialog}{wxtextentrydialog}}{Dialog to get a single line of text from the user}
72\twocolitem{\helpref{wxPasswordEntryDialog}{wxpasswordentrydialog}}{Dialog to get a password from the user}
73\twocolitem{\helpref{wxFontDialog}{wxfontdialog}}{Font chooser dialog}
74\twocolitem{\helpref{wxPageSetupDialog}{wxpagesetupdialog}}{Standard page setup dialog}
75\twocolitem{\helpref{wxPrintDialog}{wxprintdialog}}{Standard print dialog}
76\twocolitem{\helpref{wxProgressDialog}{wxprogressdialog}}{Progress indication dialog}
77\twocolitem{\helpref{wxMessageDialog}{wxmessagedialog}}{Simple message box dialog}
78\twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog.}
79\end{twocollist}
80
81{\large {\bf Controls}}
82
83Typically, these are small windows which provide interaction with the user. Controls
84that are not static can have \helpref{validators}{wxvalidator} associated with them.
85
86\twocolwidtha{6cm}
87\begin{twocollist}\itemsep=0pt
88\twocolitem{\helpref{wxControl}{wxcontrol}}{The base class for controls}
89\twocolitem{\helpref{wxButton}{wxbutton}}{Push button control, displaying text}
90\twocolitem{\helpref{wxBitmapButton}{wxbitmapbutton}}{Push button control, displaying a bitmap}
91\twocolitem{\helpref{wxToggleButton}{wxtogglebutton}}{A button which stays pressed when clicked by user.}
92\twocolitem{\helpref{wxCalendarCtrl}{wxcalendarctrl}}{Control showing an entire calendar month}
93\twocolitem{\helpref{wxCheckBox}{wxcheckbox}}{Checkbox control}
94\twocolitem{\helpref{wxCheckListBox}{wxchecklistbox}}{A listbox with a checkbox to the left of each item}
95\twocolitem{\helpref{wxChoice}{wxchoice}}{Choice control (a combobox without the editable area)}
96\twocolitem{\helpref{wxComboBox}{wxcombobox}}{A choice with an editable area}
97\twocolitem{\helpref{wxDatePickerCtrl}{wxdatepickerctrl}}{Small date picker control}
98\twocolitem{\helpref{wxGauge}{wxgauge}}{A control to represent a varying quantity, such as time remaining}
99\twocolitem{\helpref{wxGenericDirCtrl}{wxgenericdirctrl}}{A control for displaying a directory tree}
100\twocolitem{\helpref{wxHtmlListBox}{wxhtmllistbox}}{A listbox showing HTML content}
101\twocolitem{\helpref{wxStaticBox}{wxstaticbox}}{A static, or group box for visually grouping related controls}
102\twocolitem{\helpref{wxListBox}{wxlistbox}}{A list of strings for single or multiple selection}
103\twocolitem{\helpref{wxListCtrl}{wxlistctrl}}{A control for displaying lists of strings and/or icons, plus a multicolumn report view}
104\twocolitem{\helpref{wxListView}{wxlistview}}{A simpler interface ({\it fa\c{c}ade} for wxListCtrl in report mode}
105\twocolitem{\helpref{wxTextCtrl}{wxtextctrl}}{Single or multiline text editing control}
106\twocolitem{\helpref{wxTreeCtrl}{wxtreectrl}}{Tree (hierarchy) control}
107\twocolitem{\helpref{wxScrollBar}{wxscrollbar}}{Scrollbar control}
108\twocolitem{\helpref{wxSpinButton}{wxspinbutton}}{A spin or `up-down' control}
109\twocolitem{\helpref{wxSpinCtrl}{wxspinctrl}}{A spin control - i.e. spin button and text control}
110\twocolitem{\helpref{wxStaticText}{wxstatictext}}{One or more lines of non-editable text}
111\twocolitem{\helpref{wxStaticBitmap}{wxstaticbitmap}}{A control to display a bitmap}
112\twocolitem{\helpref{wxRadioBox}{wxradiobox}}{A group of radio buttons}
113\twocolitem{\helpref{wxRadioButton}{wxradiobutton}}{A round button to be used with others in a mutually exclusive way}
114\twocolitem{\helpref{wxSlider}{wxslider}}{A slider that can be dragged by the user}
115\twocolitem{\helpref{wxVListBox}{wxvlistbox}}{A listbox supporting variable height rows}
116\end{twocollist}
117
118{\large {\bf Menus}}
119
120\twocolwidtha{6cm}
121\begin{twocollist}\itemsep=0pt
122\twocolitem{\helpref{wxMenu}{wxmenu}}{Displays a series of menu items for selection}
123\twocolitem{\helpref{wxMenuBar}{wxmenubar}}{Contains a series of menus for use with a frame}
124\twocolitem{\helpref{wxMenuItem}{wxmenuitem}}{Represents a single menu item}
125\end{twocollist}
126
127{\large {\bf Window layout}}
128
129There are two different systems for laying out windows (and dialogs in particular).
130One is based upon so-called sizers and it requires less typing, thinking and calculating
131and will in almost all cases produce dialogs looking equally well on all platforms, the
132other is based on so-called constraints and is deprecated, though still available.
133
134\overview{Sizer overview}{sizeroverview} describes sizer-based layout.
135
136These are the classes relevant to sizer-based layout.
137
138\twocolwidtha{6cm}
139\begin{twocollist}\itemsep=0pt
140\twocolitem{\helpref{wxSizer}{wxsizer}}{Abstract base class}
141\twocolitem{\helpref{wxGridSizer}{wxgridsizer}}{A sizer for laying out windows in a grid with all fields having the same size}
142\twocolitem{\helpref{wxFlexGridSizer}{wxflexgridsizer}}{A sizer for laying out windows in a flexible grid}
143\twocolitem{\helpref{wxGridBagSizer}{wxgridbagsizer}}{Another grid sizer that lets you specify the cell an item is in, and items can span rows and/or columns.}
144\twocolitem{\helpref{wxBoxSizer}{wxboxsizer}}{A sizer for laying out windows in a row or column}
145\twocolitem{\helpref{wxStaticBoxSizer}{wxstaticboxsizer}}{Same as wxBoxSizer, but with a surrounding static box}
146\end{twocollist}
147
148\overview{Constraints overview}{constraintsoverview} describes constraints-based layout.
149
150These are the classes relevant to constraints-based window layout.
151
152\twocolwidtha{6cm}
153\begin{twocollist}\itemsep=0pt
154\twocolitem{\helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}}{Represents a single constraint dimension}
155\twocolitem{\helpref{wxLayoutConstraints}{wxlayoutconstraints}}{Represents the constraints for a window class}
156\end{twocollist}
157
158{\large {\bf Device contexts}}
159
160\overview{Overview}{dcoverview}
161
162Device contexts are surfaces that may be drawn on, and provide an
163abstraction that allows parameterisation of your drawing code
164by passing different device contexts.
165
166\twocolwidtha{6cm}
167\begin{twocollist}\itemsep=0pt
168\twocolitem{\helpref{wxBufferedDC}{wxbuffereddc}}{A helper device context for double buffered drawing.}
169\twocolitem{\helpref{wxBufferedPaintDC}{wxbufferedpaintdc}}{A helper device context for double buffered drawing inside \textbf{OnPaint}.}
170\twocolitem{\helpref{wxClientDC}{wxclientdc}}{A device context to access the client area outside {\bf OnPaint} events}
171\twocolitem{\helpref{wxPaintDC}{wxpaintdc}}{A device context to access the client area inside {\bf OnPaint} events}
172\twocolitem{\helpref{wxWindowDC}{wxwindowdc}}{A device context to access the non-client area}
173\twocolitem{\helpref{wxScreenDC}{wxscreendc}}{A device context to access the entire screen}
174\twocolitem{\helpref{wxDC}{wxdc}}{The device context base class}
175\twocolitem{\helpref{wxMemoryDC}{wxmemorydc}}{A device context for drawing into bitmaps}
176\twocolitem{\helpref{wxMetafileDC}{wxmetafiledc}}{A device context for drawing into metafiles}
177\twocolitem{\helpref{wxMirrorDC}{wxmirrordc}}{A proxy device context allowing for simple mirroring.}
178\twocolitem{\helpref{wxPostScriptDC}{wxpostscriptdc}}{A device context for drawing into PostScript files}
179\twocolitem{\helpref{wxPrinterDC}{wxprinterdc}}{A device context for drawing to printers}
180\end{twocollist}
181
182{\large {\bf Graphics device interface}}
183
184\overview{Bitmaps overview}{wxbitmapoverview}
185
186These classes are related to drawing on device contexts and windows.
187
188\twocolwidtha{6cm}
189\begin{twocollist}\itemsep=0pt
190\twocolitem{\helpref{wxColour}{wxcolour}}{Represents the red, blue and green elements of a colour}
191\twocolitem{\helpref{wxDCClipper}{wxdcclipper}}{Wraps the operations of setting and destroying the clipping region}
192\twocolitem{\helpref{wxBitmap}{wxbitmap}}{Represents a bitmap}
193\twocolitem{\helpref{wxBrush}{wxbrush}}{Used for filling areas on a device context}
194\twocolitem{\helpref{wxBrushList}{wxbrushlist}}{The list of previously-created brushes}
195\twocolitem{\helpref{wxCursor}{wxcursor}}{A small, transparent bitmap representing the cursor}
196\twocolitem{\helpref{wxFont}{wxfont}}{Represents fonts}
197\twocolitem{\helpref{wxFontList}{wxfontlist}}{The list of previously-created fonts}
198\twocolitem{\helpref{wxIcon}{wxicon}}{A small, transparent bitmap for assigning to frames and drawing on device contexts}
199\twocolitem{\helpref{wxImage}{wximage}}{A platform-independent image class}
200\twocolitem{\helpref{wxImageList}{wximagelist}}{A list of images, used with some controls}
201\twocolitem{\helpref{wxMask}{wxmask}}{Represents a mask to be used with a bitmap for transparent drawing}
202\twocolitem{\helpref{wxPen}{wxpen}}{Used for drawing lines on a device context}
203\twocolitem{\helpref{wxPenList}{wxpenlist}}{The list of previously-created pens}
204\twocolitem{\helpref{wxPalette}{wxpalette}}{Represents a table of indices into RGB values}
205\twocolitem{\helpref{wxRegion}{wxregion}}{Represents a simple or complex region on a window or device context}
206\twocolitem{\helpref{wxRendererNative}{wxrenderernative}}{Abstracts high-level drawing primitives}
207\end{twocollist}
208
209{\large {\bf Events}}
210
211\overview{Overview}{eventhandlingoverview}
212
213An event object contains information about a specific event. Event handlers
214(usually member functions) have a single, event argument.
215
216\twocolwidtha{6cm}
217\begin{twocollist}\itemsep=0pt
218\twocolitem{\helpref{wxActivateEvent}{wxactivateevent}}{A window or application activation event}
219\twocolitem{\helpref{wxCalendarEvent}{wxcalendarevent}}{Used with \helpref{wxCalendarCtrl}{wxcalendarctrl}}
220\twocolitem{\helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}}{Used to calculate window layout}
221\twocolitem{\helpref{wxClipboardTextEvent}{wxclipboardtextevent}}{A clipboard copy/cut/paste treebook event event}
222\twocolitem{\helpref{wxCloseEvent}{wxcloseevent}}{A close window or end session event}
223\twocolitem{\helpref{wxCommandEvent}{wxcommandevent}}{An event from a variety of standard controls}
224\twocolitem{\helpref{wxContextMenuEvent}{wxcontextmenuevent}}{An event generated when the user issues a context menu command}
225\twocolitem{\helpref{wxDateEvent}{wxdateevent}}{Used with \helpref{wxDatePickerCtrl}{wxdatepickerctrl}}
226\twocolitem{\helpref{wxDialUpEvent}{wxdialupevent}}{Event send by \helpref{wxDialUpManager}{wxdialupmanager}}
227\twocolitem{\helpref{wxDropFilesEvent}{wxdropfilesevent}}{A drop files event}
228\twocolitem{\helpref{wxEraseEvent}{wxeraseevent}}{An erase background event}
229\twocolitem{\helpref{wxEvent}{wxevent}}{The event base class}
230\twocolitem{\helpref{wxFindDialogEvent}{wxfinddialogevent}}{Event sent by
231\helpref{wxFindReplaceDialog}{wxfindreplacedialog}}
232\twocolitem{\helpref{wxFocusEvent}{wxfocusevent}}{A window focus event}
233\twocolitem{\helpref{wxKeyEvent}{wxkeyevent}}{A keypress event}
234\twocolitem{\helpref{wxIconizeEvent}{wxiconizeevent}}{An iconize/restore event}
235\twocolitem{\helpref{wxIdleEvent}{wxidleevent}}{An idle event}
236\twocolitem{\helpref{wxInitDialogEvent}{wxinitdialogevent}}{A dialog initialisation event}
237\twocolitem{\helpref{wxJoystickEvent}{wxjoystickevent}}{A joystick event}
238\twocolitem{\helpref{wxListEvent}{wxlistevent}}{A list control event}
239\twocolitem{\helpref{wxMaximizeEvent}{wxmaximizeevent}}{A maximize event}
240\twocolitem{\helpref{wxMenuEvent}{wxmenuevent}}{A menu event}
241\twocolitem{\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}}{A mouse capture changed event}
242\twocolitem{\helpref{wxMouseEvent}{wxmouseevent}}{A mouse event}
243\twocolitem{\helpref{wxMoveEvent}{wxmoveevent}}{A move event}
244\twocolitem{\helpref{wxNotebookEvent}{wxnotebookevent}}{A notebook control event}
245\twocolitem{\helpref{wxNotifyEvent}{wxnotifyevent}}{A notification event, which can be vetoed}
246\twocolitem{\helpref{wxPaintEvent}{wxpaintevent}}{A paint event}
247\twocolitem{\helpref{wxProcessEvent}{wxprocessevent}}{A process ending event}
248\twocolitem{\helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent}}{Used to query layout information}
249\twocolitem{\helpref{wxScrollEvent}{wxscrollevent}}{A scroll event from sliders, stand-alone scrollbars and spin buttons}
250\twocolitem{\helpref{wxScrollWinEvent}{wxscrollwinevent}}{A scroll event from scrolled windows}
251\twocolitem{\helpref{wxSizeEvent}{wxsizeevent}}{A size event}
252\twocolitem{\helpref{wxSocketEvent}{wxsocketevent}}{A socket event}
253\twocolitem{\helpref{wxSpinEvent}{wxspinevent}}{An event from \helpref{wxSpinButton}{wxspinbutton}}
254\twocolitem{\helpref{wxSplitterEvent}{wxsplitterevent}}{An event from \helpref{wxSplitterWindow}{wxsplitterwindow}}
255\twocolitem{\helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}}{A system colour change event}
256\twocolitem{\helpref{wxTimerEvent}{wxtimerevent}}{A timer expiration event}
257\twocolitem{\helpref{wxTreebookEvent}{wxtreebookevent}}{A treebook control event}
258\twocolitem{\helpref{wxTreeEvent}{wxtreeevent}}{A tree control event}
259\twocolitem{\helpref{wxUpdateUIEvent}{wxupdateuievent}}{A user interface update event}
260\twocolitem{\helpref{wxWindowCreateEvent}{wxwindowcreateevent}}{A window creation event}
261\twocolitem{\helpref{wxWindowDestroyEvent}{wxwindowdestroyevent}}{A window destruction event}
262\twocolitem{\helpref{wxWizardEvent}{wxwizardevent}}{A wizard event}
263\end{twocollist}
264
265{\large {\bf Validators}}
266
267\overview{Overview}{validatoroverview}
268
269These are the window validators, used for filtering and validating
270user input.
271
272\twocolwidtha{6cm}
273\begin{twocollist}\itemsep=0pt
274\twocolitem{\helpref{wxValidator}{wxvalidator}}{Base validator class}
275\twocolitem{\helpref{wxTextValidator}{wxtextvalidator}}{Text control validator class}
276\twocolitem{\helpref{wxGenericValidator}{wxgenericvalidator}}{Generic control validator class}
277\end{twocollist}
278
279{\large {\bf Data structures}}
280
281These are the data structure classes supported by wxWidgets.
282
283\twocolwidtha{6cm}
284\begin{twocollist}\itemsep=0pt
285\twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class}
286\twocolitem{\helpref{wxDateSpan}{wxdatespan}}{A logical time interval.}
287\twocolitem{\helpref{wxDateTime}{wxdatetime}}{A class for date/time manipulations}
288%\twocolitem{\helpref{wxExpr}{wxexpr}}{A class for flexible I/O}
289%\twocolitem{\helpref{wxExprDatabase}{wxexprdatabase}}{A class for flexible I/O}
290\twocolitem{\helpref{wxArray}{wxarray}}{A dynamic array implementation}
291\twocolitem{\helpref{wxArrayString}{wxarraystring}}{An efficient container for storing \helpref{wxString}{wxstring} objects}
292\twocolitem{\helpref{wxHashMap}{wxhashmap}}{A simple hash map implementation}
293\twocolitem{\helpref{wxHashSet}{wxhashset}}{A simple hash set implementation}
294\twocolitem{\helpref{wxHashTable}{wxhashtable}}{A simple hash table implementation (deprecated, use wxHashMap)}
295% \twocolitem{\helpref{wxHashTableLong}{wxhashtablelong}}{A wxHashTable version for storing long data}
296\twocolitem{\helpref{wxList}{wxlist}}{A simple linked list implementation}
297\twocolitem{\helpref{wxLongLong}{wxlonglong}}{A portable 64 bit integer type}
298\twocolitem{\helpref{wxNode}{wxnode}}{Represents a node in the wxList implementation}
299\twocolitem{\helpref{wxObject}{wxobject}}{The root class for most wxWidgets classes}
300\twocolitem{\helpref{wxPathList}{wxpathlist}}{A class to help search multiple paths}
301\twocolitem{\helpref{wxPoint}{wxpoint}}{Representation of a point}
302\twocolitem{\helpref{wxRect}{wxrect}}{A class representing a rectangle}
303\twocolitem{\helpref{wxRegEx}{wxregex}}{Regular expression support}
304\twocolitem{\helpref{wxRegion}{wxregion}}{A class representing a region}
305\twocolitem{\helpref{wxString}{wxstring}}{A string class}
306\twocolitem{\helpref{wxStringTokenizer}{wxstringtokenizer}}{A class for interpreting a string as a list of tokens or words}
307\twocolitem{\helpref{wxRealPoint}{wxrealpoint}}{Representation of a point using floating point numbers}
308\twocolitem{\helpref{wxSize}{wxsize}}{Representation of a size}
309\twocolitem{\helpref{wxTimeSpan}{wxtimespan}}{A time interval.}
310\twocolitem{\helpref{wxURI}{wxuri}}{Represents a Uniform Resource Identifier}
311\twocolitem{\helpref{wxVariant}{wxvariant}}{A class for storing arbitrary types that may change at run-time}
312\end{twocollist}
313
314{\large {\bf Run-time class information system}}
315
316\overview{Overview}{runtimeclassoverview}
317
318wxWidgets supports run-time manipulation of class information, and dynamic
319creation of objects given class names.
320
321\twocolwidtha{6cm}
322\begin{twocollist}\itemsep=0pt
323\twocolitem{\helpref{wxClassInfo}{wxclassinfo}}{Holds run-time class information}
324\twocolitem{\helpref{wxObject}{wxobject}}{Root class for classes with run-time information}
325\twocolitem{\helpref{RTTI macros}{rttimacros}}{Macros for manipulating run-time information}
326\end{twocollist}
327
328{\large {\bf Logging features}}
329
330\overview{Overview}{wxlogoverview}
331
332wxWidgets provides several classes and functions for message logging.
333Please see the \helpref{wxLog overview}{wxlogoverview} for more details.
334
335\twocolwidtha{6cm}
336\begin{twocollist}\itemsep=0pt
337\twocolitem{\helpref{wxLog}{wxlog}}{The base log class}
338\twocolitem{\helpref{wxLogStderr}{wxlogstderr}}{Log messages to a C STDIO stream}
339\twocolitem{\helpref{wxLogStream}{wxlogstream}}{Log messages to a C++ iostream}
340\twocolitem{\helpref{wxLogTextCtrl}{wxlogtextctrl}}{Log messages to a \helpref{wxTextCtrl}{wxtextctrl}}
341\twocolitem{\helpref{wxLogWindow}{wxlogwindow}}{Log messages to a log frame}
342\twocolitem{\helpref{wxLogGui}{wxloggui}}{Default log target for GUI programs}
343\twocolitem{\helpref{wxLogNull}{wxlognull}}{Temporarily suppress message logging}
344\twocolitem{\helpref{wxLogChain}{wxlogchain}}{Allows to chain two log targets}
345\twocolitem{\helpref{wxLogPassThrough}{wxlogpassthrough}}{Allows to filter the log messages}
346\twocolitem{\helpref{wxStreamToTextRedirector}{wxstreamtotextredirector}}{Allows
347to redirect output sent to {\tt cout} to a \helpref{wxTextCtrl}{wxtextctrl}}
348\twocolitem{\helpref{Log functions}{logfunctions}}{Error and warning logging functions}
349\end{twocollist}
350
351{\large {\bf Debugging features}}
352
353\overview{Overview}{debuggingoverview}
354
355wxWidgets supports some aspects of debugging an application through
356classes, functions and macros.
357
358\twocolwidtha{6cm}
359\begin{twocollist}\itemsep=0pt
360\twocolitem{\helpref{wxDebugContext}{wxdebugcontext}}{Provides memory-checking facilities}
361\twocolitem{\helpref{Debugging macros}{debugmacros}}{Debug macros for assertion and checking}
362\twocolitem{\helpref{WXDEBUG\_NEW}{debugnew}}{Use this macro to give further debugging information}
363\twocolitem{\helpref{wxDebugReport}{wxdebugreport}}{Base class for creating debug reports in case of a program crash.}
364\twocolitem{\helpref{wxDebugReportCompress}{wxdebugreportcompress}}{Class for creating compressed debug reports.}
365\twocolitem{\helpref{wxDebugReportUpload}{wxdebugreportupload}}{Class for uploading compressed debug reports via HTTP.}
366\twocolitem{\helpref{wxDebugReportPreview}{wxdebugreportpreview}}{Abstract base class for previewing the contents of a debug report.}
367\twocolitem{\helpref{wxDebugReportPreviewStd}{wxdebugreportpreviewstd}}{Standard implementation of wxDebugReportPreview.}
368\end{twocollist}
369
370{\large {\bf Networking classes}}
371
372wxWidgets provides its own classes for socket based networking.
373
374\twocolwidtha{6cm}
375\begin{twocollist}\itemsep=0pt
376\twocolitem{\helpref{wxDialUpManager}{wxdialupmanager}}{Provides functions to check the status of network connection and to establish one}
377\twocolitem{\helpref{wxIPV4address}{wxipv4address}}{Represents an Internet address}
378\twocolitem{\helpref{wxIPaddress}{wxipaddress}}{Represents an Internet address}
379\twocolitem{\helpref{wxSocketBase}{wxsocketbase}}{Represents a socket base object}
380\twocolitem{\helpref{wxSocketClient}{wxsocketclient}}{Represents a socket client}
381\twocolitem{\helpref{wxSocketServer}{wxsocketserver}}{Represents a socket server}
382\twocolitem{\helpref{wxSocketEvent}{wxsocketevent}}{A socket event}
383\twocolitem{\helpref{wxFTP}{wxftp}}{FTP protocol class}
384\twocolitem{\helpref{wxHTTP}{wxhttp}}{HTTP protocol class}
385\twocolitem{\helpref{wxURL}{wxurl}}{Represents a Universal Resource Locator}
386\end{twocollist}
387
388
389{\large {\bf Interprocess communication}}
390
391\overview{Overview}{ipcoverview}
392
393wxWidgets provides simple interprocess communications facilities
394based on Windows DDE, but available on most platforms using TCP.
395
396\twocolwidtha{6cm}
397\begin{twocollist}\itemsep=0pt
398\twocolitem{\helpref{wxClient}{wxclient}, \helpref{wxDDEClient}{wxddeclient}}{Represents a client}
399\twocolitem{\helpref{wxConnection}{wxconnection}, \helpref{wxDDEConnection}{wxddeconnection}}{Represents the connection between a client and a server}
400\twocolitem{\helpref{wxServer}{wxserver}, \helpref{wxDDEServer}{wxddeserver}}{Represents a server}
401%\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler}
402\end{twocollist}
403
404{\large {\bf Document/view framework}}
405
406\overview{Overview}{docviewoverview}
407
408wxWidgets supports a document/view framework which provides
409housekeeping for a document-centric application.
410
411\twocolwidtha{6cm}
412\begin{twocollist}\itemsep=0pt
413\twocolitem{\helpref{wxDocument}{wxdocument}}{Represents a document}
414\twocolitem{\helpref{wxView}{wxview}}{Represents a view}
415\twocolitem{\helpref{wxDocTemplate}{wxdoctemplate}}{Manages the relationship between a document class and a view class}
416\twocolitem{\helpref{wxDocManager}{wxdocmanager}}{Manages the documents and views in an application}
417\twocolitem{\helpref{wxDocChildFrame}{wxdocchildframe}}{A child frame for showing a document view}
418\twocolitem{\helpref{wxDocParentFrame}{wxdocparentframe}}{A parent frame to contain views}
419%\twocolitem{\helpref{wxMDIDocChildFrame}{wxmdidocchildframe}}{An MDI child frame for showing a document view}
420%\twocolitem{\helpref{wxMDIDocParentFrame}{wxmdidocparentframe}}{An MDI parent frame to contain views}
421\end{twocollist}
422
423{\large {\bf Printing framework}}
424
425\overview{Overview}{printingoverview}
426
427A printing and previewing framework is implemented to
428make it relatively straightforward to provide document printing
429facilities.
430
431\twocolwidtha{6cm}
432\begin{twocollist}\itemsep=0pt
433\twocolitem{\helpref{wxPreviewFrame}{wxpreviewframe}}{Frame for displaying a print preview}
434\twocolitem{\helpref{wxPreviewCanvas}{wxpreviewcanvas}}{Canvas for displaying a print preview}
435\twocolitem{\helpref{wxPreviewControlBar}{wxpreviewcontrolbar}}{Standard control bar for a print preview}
436\twocolitem{\helpref{wxPrintDialog}{wxprintdialog}}{Standard print dialog}
437\twocolitem{\helpref{wxPageSetupDialog}{wxpagesetupdialog}}{Standard page setup dialog}
438\twocolitem{\helpref{wxPrinter}{wxprinter}}{Class representing the printer}
439\twocolitem{\helpref{wxPrinterDC}{wxprinterdc}}{Printer device context}
440\twocolitem{\helpref{wxPrintout}{wxprintout}}{Class representing a particular printout}
441\twocolitem{\helpref{wxPrintPreview}{wxprintpreview}}{Class representing a print preview}
442\twocolitem{\helpref{wxPrintData}{wxprintdata}}{Represents information about the document being printed}
443\twocolitem{\helpref{wxPrintDialogData}{wxprintdialogdata}}{Represents information about the print dialog}
444\twocolitem{\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}}{Represents information about the page setup dialog}
445\end{twocollist}
446
447{\large {\bf Drag and drop and clipboard classes}}
448
449\overview{Drag and drop and clipboard overview}{wxdndoverview}
450
451\twocolwidtha{6cm}
452\begin{twocollist}\itemsep=0pt
453\twocolitem{\helpref{wxDataObject}{wxdataobject}}{Data object class}
454\twocolitem{\helpref{wxDataFormat}{wxdataformat}}{Represents a data format}
455\twocolitem{\helpref{wxTextDataObject}{wxtextdataobject}}{Text data object class}
456\twocolitem{\helpref{wxFileDataObject}{wxfiledataobject}}{File data object class}
457\twocolitem{\helpref{wxBitmapDataObject}{wxbitmapdataobject}}{Bitmap data object class}
458\twocolitem{\helpref{wxCustomDataObject}{wxcustomdataobject}}{Custom data object class}
459\twocolitem{\helpref{wxClipboard}{wxclipboard}}{Clipboard class}
460\twocolitem{\helpref{wxDropTarget}{wxdroptarget}}{Drop target class}
461\twocolitem{\helpref{wxFileDropTarget}{wxfiledroptarget}}{File drop target class}
462\twocolitem{\helpref{wxTextDropTarget}{wxtextdroptarget}}{Text drop target class}
463\twocolitem{\helpref{wxDropSource}{wxdropsource}}{Drop source class}
464\end{twocollist}
465
466{\large {\bf File related classes}}
467
468wxWidgets has several small classes to work with disk files, see \helpref{file classes
469overview}{wxfileoverview} for more details.
470
471\twocolwidtha{6cm}
472\begin{twocollist}\itemsep=0pt
473\twocolitem{\helpref{wxFileName}{wxfilename}}{Operations with the file name and attributes}
474\twocolitem{\helpref{wxDir}{wxdir}}{Class for enumerating files/subdirectories.}
475\twocolitem{\helpref{wxDirTraverser}{wxdirtraverser}}{Class used together with wxDir for recursively enumerating the files/subdirectories}
476\twocolitem{\helpref{wxFile}{wxfile}}{Low-level file input/output class.}
477\twocolitem{\helpref{wxFFile}{wxffile}}{Another low-level file input/output class.}
478\twocolitem{\helpref{wxTempFile}{wxtempfile}}{Class to safely replace an existing file}
479\twocolitem{\helpref{wxTextFile}{wxtextfile}}{Class for working with text files as with arrays of lines}
480\twocolitem{\helpref{wxStandardPaths}{wxstandardpaths}}{Paths for standard directories}
481\end{twocollist}
482
483{\large {\bf Stream classes}}
484
485wxWidgets has its own set of stream classes, as an alternative to often buggy standard stream
486libraries, and to provide enhanced functionality.
487
488\twocolwidtha{6cm}
489\begin{twocollist}\itemsep=0pt
490\twocolitem{\helpref{wxStreamBase}{wxstreambase}}{Stream base class}
491\twocolitem{\helpref{wxStreamBuffer}{wxstreambuffer}}{Stream buffer class}
492\twocolitem{\helpref{wxInputStream}{wxinputstream}}{Input stream class}
493\twocolitem{\helpref{wxOutputStream}{wxoutputstream}}{Output stream class}
494\twocolitem{\helpref{wxCountingOutputStream}{wxcountingoutputstream}}{Stream class for querying what size a stream would have.}
495\twocolitem{\helpref{wxFilterInputStream}{wxfilterinputstream}}{Filtered input stream class}
496\twocolitem{\helpref{wxFilterOutputStream}{wxfilteroutputstream}}{Filtered output stream class}
497\twocolitem{\helpref{wxBufferedInputStream}{wxbufferedinputstream}}{Buffered input stream class}
498\twocolitem{\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}}{Buffered output stream class}
499\twocolitem{\helpref{wxMemoryInputStream}{wxmeminputstream}}{Memory input stream class}
500\twocolitem{\helpref{wxMemoryOutputStream}{wxmemoutputstream}}{Memory output stream class}
501\twocolitem{\helpref{wxDataInputStream}{wxdatainputstream}}{Platform-independent binary data input stream class}
502\twocolitem{\helpref{wxDataOutputStream}{wxdataoutputstream}}{Platform-independent binary data output stream class}
503\twocolitem{\helpref{wxTextInputStream}{wxtextinputstream}}{Platform-independent text data input stream class}
504\twocolitem{\helpref{wxTextOutputStream}{wxtextoutputstream}}{Platform-independent text data output stream class}
505\twocolitem{\helpref{wxFileInputStream}{wxfileinputstream}}{File input stream class}
506\twocolitem{\helpref{wxFileOutputStream}{wxfileoutputstream}}{File output stream class}
507\twocolitem{\helpref{wxFFileInputStream}{wxffileinputstream}}{Another file input stream class}
508\twocolitem{\helpref{wxFFileOutputStream}{wxffileoutputstream}}{Another file output stream class}
509\twocolitem{\helpref{wxTempFileOutputStream}{wxtempfileoutputstream}}{Stream to safely replace an existing file}
510\twocolitem{\helpref{wxStringInputStream}{wxstringinputstream}}{String input stream class}
511\twocolitem{\helpref{wxStringOutputStream}{wxstringoutputstream}}{String output stream class}
512\twocolitem{\helpref{wxZlibInputStream}{wxzlibinputstream}}{Zlib (compression) input stream class}
513\twocolitem{\helpref{wxZlibOutputStream}{wxzliboutputstream}}{Zlib (compression) output stream class}
514\twocolitem{\helpref{wxZipInputStream}{wxzipinputstream}}{Input stream for reading from ZIP archives}
515\twocolitem{\helpref{wxZipOutputStream}{wxzipoutputstream}}{Output stream for writing from ZIP archives}
516\twocolitem{\helpref{wxSocketInputStream}{wxsocketinputstream}}{Socket input stream class}
517\twocolitem{\helpref{wxSocketOutputStream}{wxsocketoutputstream}}{Socket output stream class}
518\end{twocollist}
519
520{\large {\bf Threading classes}}
521
522\overview{Multithreading overview}{wxthreadoverview}
523
524wxWidgets provides a set of classes to make use of the native thread
525capabilities of the various platforms.
526
527\twocolwidtha{6cm}
528\begin{twocollist}\itemsep=0pt
529\twocolitem{\helpref{wxThread}{wxthread}}{Thread class}
530\twocolitem{\helpref{wxThreadHelper}{wxthreadhelper}}{Manages background threads easily}
531\twocolitem{\helpref{wxMutex}{wxmutex}}{Mutex class}
532\twocolitem{\helpref{wxMutexLocker}{wxmutexlocker}}{Mutex locker utility class}
533\twocolitem{\helpref{wxCriticalSection}{wxcriticalsection}}{Critical section class}
534\twocolitem{\helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}}{Critical section locker utility class}
535\twocolitem{\helpref{wxCondition}{wxcondition}}{Condition class}
536\twocolitem{\helpref{wxSemaphore}{wxsemaphore}}{Semaphore class}
537\end{twocollist}
538
539{\large {\bf HTML classes}}
540
541wxWidgets provides a set of classes to display text in HTML format. These
542class include a help system based on the HTML widget.
543
544\twocolwidtha{6cm}
545\begin{twocollist}\itemsep=0pt
546\twocolitem{\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}}{HTML help controller class}
547\twocolitem{\helpref{wxHtmlWindow}{wxhtmlwindow}}{HTML window class}
548\twocolitem{\helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting}}{Simple class for printing HTML}
549\twocolitem{\helpref{wxHtmlPrintout}{wxhtmlprintout}}{Generic HTML wxPrintout class}
550\twocolitem{\helpref{wxHtmlParser}{wxhtmlparser}}{Generic HTML parser class}
551\twocolitem{\helpref{wxHtmlTagHandler}{wxhtmltaghandler}}{HTML tag handler, pluginable into wxHtmlParser}
552\twocolitem{\helpref{wxHtmlWinParser}{wxhtmlwinparser}}{HTML parser class for wxHtmlWindow}
553\twocolitem{\helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}}{HTML tag handler, pluginable into wxHtmlWinParser}
554\end{twocollist}
555
556{\large {\bf Virtual file system classes}}
557
558wxWidgets provides a set of classes that implement an extensible virtual file system,
559used internally by the HTML classes.
560
561\twocolwidtha{6cm}
562\begin{twocollist}\itemsep=0pt
563\twocolitem{\helpref{wxFSFile}{wxfsfile}}{Represents a file in the virtual file system}
564\twocolitem{\helpref{wxFileSystem}{wxfilesystem}}{Main interface for the virtual file system}
565\twocolitem{\helpref{wxFileSystemHandler}{wxfilesystemhandler}}{Class used to announce file system type}
566\end{twocollist}
567
568{\large {\bf XML-based resource system classes}}
569
570\overview{XML-based resource system (XRC) overview}{xrcoverview}
571
572Resources allow your application to create controls and other user interface elements
573from specifications stored in an XML format.
574
575\twocolwidtha{6cm}
576\begin{twocollist}\itemsep=0pt
577\twocolitem{\helpref{wxXmlResource}{wxxmlresource}}{The main class for working with resources.}
578\twocolitem{\helpref{wxXmlResourceHandler}{wxxmlresourcehandler}}{The base class for XML resource handlers.}
579\end{twocollist}
580
581{\large {\bf Online help}}
582
583\twocolwidtha{6cm}
584\begin{twocollist}\itemsep=0pt
585\twocolitem{\helpref{wxHelpController}{wxhelpcontroller}}{Family of classes for controlling help windows}
586\twocolitem{\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}}{HTML help controller class}
587\twocolitem{\helpref{wxContextHelp}{wxcontexthelp}}{Class to put application into context-sensitive help mode}
588\twocolitem{\helpref{wxContextHelpButton}{wxcontexthelpbutton}}{Button class for putting application into context-sensitive help mode}
589\twocolitem{\helpref{wxHelpProvider}{wxhelpprovider}}{Abstract class for context-sensitive help provision}
590\twocolitem{\helpref{wxSimpleHelpProvider}{wxsimplehelpprovider}}{Class for simple context-sensitive help provision}
591\twocolitem{\helpref{wxHelpControllerHelpProvider}{wxhelpcontrollerhelpprovider}}{Class for context-sensitive help provision via a help controller}
592\twocolitem{\helpref{wxToolTip}{wxtooltip}}{Class implementing tooltips}
593\end{twocollist}
594
595{\large {\bf Database classes}}
596
597\overview{Database classes overview}{odbcoverview}
598
599wxWidgets provides a set of classes for accessing Microsoft's ODBC (Open Database Connectivity)
600product, donated by Remstar. This is known as wxODBC.
601
602\twocolwidtha{6cm}
603\begin{twocollist}\itemsep=0pt
604\twocolitem{\helpref{wxDb}{wxdb}}{ODBC database connection}
605\twocolitem{\helpref{wxDbTable}{wxdbtable}}{Provides access to a database table}
606\twocolitem{\helpref{wxDbInf}{wxdbinf}}{}
607\twocolitem{\helpref{wxDbTableInf}{wxdbtableinf}}{}
608\twocolitem{\helpref{wxDbColDef}{wxdbcoldef}}{}
609\twocolitem{\helpref{wxDbColInf}{wxdbcolinf}}{}
610\twocolitem{\helpref{wxDbColDataPtr}{wxdbcoldataptr}}{}
611\twocolitem{\helpref{wxDbColFor}{wxdbcolfor}}{}
612\twocolitem{\helpref{wxDbConnectInf}{wxdbconnectinf}}{}
613\twocolitem{\helpref{wxDbIdxDef}{wxdbidxdef}}{}
614\end{twocollist}
615
616{\large {\bf Miscellaneous}}
617
618\twocolwidtha{6cm}
619\begin{twocollist}\itemsep=0pt
620\twocolitem{\helpref{wxApp}{wxapp}}{Application class}
621\twocolitem{\helpref{wxCaret}{wxcaret}}{A caret (cursor) object}
622\twocolitem{\helpref{wxCmdLineParser}{wxcmdlineparser}}{Command line parser class}
623\twocolitem{\helpref{wxConfig}{wxconfigbase}}{Classes for configuration reading/writing (using either INI files or registry)}
624\twocolitem{\helpref{wxDllLoader}{wxdllloader}}{Class to work with shared libraries.}
625\twocolitem{\helpref{wxGLCanvas}{wxglcanvas}}{Canvas that you can render OpenGL calls to.}
626\twocolitem{\helpref{wxGLContext}{wxglcontext}}{Class to ease sharing of OpenGL data resources.}
627\twocolitem{\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}}{An alternative window layout facility}
628\twocolitem{\helpref{wxProcess}{wxprocess}}{Process class}
629\twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class}
630\twocolitem{\helpref{wxStopWatch}{wxstopwatch}}{Stop watch class}
631\twocolitem{\helpref{wxMimeTypesManager}{wxmimetypesmanager}}{MIME-types manager class}
632\twocolitem{\helpref{wxSystemSettings}{wxsystemsettings}}{System settings class for obtaining various global parameters}
633\twocolitem{\helpref{wxSystemOptions}{wxsystemoptions}}{System options class for run-time configuration}
634\twocolitem{\helpref{wxAcceleratorTable}{wxacceleratortable}}{Accelerator table}
635\twocolitem{\helpref{wxAutomationObject}{wxautomationobject}}{OLE automation class}
636\twocolitem{\helpref{wxFontMapper}{wxfontmapper}}{Font mapping, finding suitable font for given encoding}
637\twocolitem{\helpref{wxEncodingConverter}{wxencodingconverter}}{Encoding conversions}
638\twocolitem{\helpref{wxCalendarDateAttr}{wxcalendardateattr}}{Used with \helpref{wxCalendarCtrl}{wxcalendarctrl}}
639\twocolitem{\helpref{wxQuantize}{wxquantize}}{Class to perform quantization, or colour reduction}
640\twocolitem{\helpref{wxSingleInstanceChecker}{wxsingleinstancechecker}}{Check that only single program instance is running}
641\end{twocollist}