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