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