]> git.saurik.com Git - wxWidgets.git/blame - docs/html/index.htm
projects / wxWidgets.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
don't crash if used in iconv-like fashion
[wxWidgets.git] / docs / html / index.htm
CommitLineData
ddcc5f5b
JS		 1<HTML>
2
3<HEAD>
4<TITLE>wxWindows Documentation</TITLE>
5
6</HEAD>
7
b59da6c2 8<BODY BGCOLOR=#FFFFFF TEXT=#000000 VLINK="#63659C" LINK="#313063" ALINK="#313063">
ddcc5f5b
JS		 9
10<font face="Arial, Lucida Sans, Helvetica">
11
12<a name="top"></a>
13
e492150d 14<IMG src="logo.gif" align=right hspace=10 vspace=0>
ddcc5f5b 15
b69f1bd1
JS		 16Welcome to wxWindows 2, the premi&egrave;re cross-platform GUI C++ framework. This is an index of
17the plain text, HTML, Windows Help and Acrobat documentation: availability depends on what you've
e492150d 18downloaded from the <a href="http://www.wxwindows.org">wxWindows Web site</a>.<br clear=all><P>
ddcc5f5b 19
7921cf2b
JS		 20<CENTER>
21<FONT size=-1>
22[<a href="#install">Install</a>]
23[<a href="#manuals">Manuals</a>]
66f55ec6 24[<a href="#technotes">Technical Notes</a>]
7921cf2b
JS		 25[<a href="#thirdparty">3rd party tools</a>]
26[<a href="#samples">Samples</a>]
1cf4526d 27[<a href="#demos">Demos</a>]
7921cf2b
JS		 28</FONT>
29</CENTER>
30
e492150d
JS		 31<P>
32
33<table width=100% border=0 cellpadding=3 cellspacing=0>
34<tr>
35<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
36<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
37<b><a name="install">Installation and release notes</a></b>
38</font>
39</td>
40</tr>
41</table>
42
43<P>
ddcc5f5b
JS		 44
45<ul>
2dc5505e
JS		 46<li>ReadMe: <a href="../readme.txt"><b>General ReadMe</b></a>,
47<a href="../gtk/readme.txt">wxGTK</a>,
ddcc5f5b 48<a href="../motif/readme.txt">wxMotif</a>,
69477ac4 49<a href="../x11/readme.txt">wxX11</a>,
e492150d
JS		 50<a href="../x11/readme-nanox.txt">wxNanoX</a>,
51<a href="../msw/readme.txt">wxMSW</a>,
52<a href="../mac/readme.txt">wxMac</a>,
53<a href="../mgl/readme.txt">wxMGL</a>,
54<a href="../univ/readme.txt">Univ</a>
ddcc5f5b
JS		 55<li>Installation: <a href="../gtk/install.txt">wxGTK</a>,
56<a href="../motif/install.txt">wxMotif</a>,
69477ac4 57<a href="../x11/install.txt">wxX11</a>,
e492150d
JS		 58<a href="../msw/install.txt">wxMSW</a>,
59<a href="../mac/install.txt">wxMac</a>,
60<a href="../mgl/install.txt">wxMGL</a>,
61<a href="../os2/install.txt">wxOS2</a>
62<li><a href="../changes.txt"><b>General change log</b></a>, <a href="../gtk/changes.txt">wxGTK change log</a>
2dc5505e
JS		 63<li>Licence: <a href="../preamble.txt">Preamble</a>,
64<a href="../licence.txt">Licence</a>,
65<a href="../licendoc.txt">Documentation Licence</a>,
66<a href="../lgpl.txt">L-GPL</a>,
67<a href="../gpl.txt">GPL</a>
ce3ed50d
JS		 68<li><a href="faq.htm"><B>FAQ</B></a>:
69 <ul>
70 <li><a href="faqgen.htm">General questions</a>
69477ac4 71 <li><a href="faqgtk.htm">wxWindows 2 for GTK+</a>
ce3ed50d
JS		 72 <li><a href="faqmsw.htm">wxWindows 2 for Windows</a>
73 <li><a href="faqmot.htm">wxWindows 2 for Motif</a>
69477ac4 74 <li><a href="faqx11.htm">wxWindows 2 for X11</a>
ce3ed50d
JS		 75 <li><a href="faqmac.htm">wxWindows 2 for Mac</a>
76 </ul>
2dc5505e
JS		 77<li>ToDo: <a href="../todo.txt"><b>General ToDo</b></a>,
78<a href="../gtk/todo.txt">wxGTK</a>,
ddcc5f5b
JS		 79<a href="../motif/todo.txt">wxMotif</a>,
80<a href="../msw/todo.txt">wxMSW</a>
81<li>List of <a href="../symbols.txt">preprocessor symbols</a> used in wxWindows
82</ul>
83
e492150d
JS		 84Further platform-specific notes:
85
86<ul>
87<li> wxMSW: <a href="../msw/winxp.txt">Windows XP</a>
88</ul>
89
90<P>
91
92<table width=100% border=0 cellpadding=3 cellspacing=0>
93<tr>
94<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
95<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
96<b><a name="manuals">wxWindows manuals</a></b>
97</font>
98</td>
99</tr>
100</table>
101
102<P>
103
104To use manuals in wxHTML Help form (extension htb), you can use the <b>HelpView</b>
105application, either compiling it from utils/helpview in the distribution,
106or downloading a binary, for example from <a href="http://www.storylinescentral.com/helpview.htm">here</a>.<P>
107
108See also the <a href="../pdf/wxTutorial.pdf">wxWindows Tutorial</a>
109by Franky Braem, in PDF format.<P>
110
111<P>
7921cf2b 112
e492150d 113<table border=0 cellpadding=5 cellspacing=0>
7921cf2b 114
b69f1bd1 115<tr>
e492150d 116<td align=center bgcolor="#E0E0E0">
b69f1bd1
JS		 117<B>HTML</B>
118</td>
e492150d 119<td align=center bgcolor="#E0E0E0">
b69f1bd1
JS		 120<B>WinHelp</B>
121</td>
e492150d 122<td align=center bgcolor="#E0E0E0">
f6bcfd97
BP		 123<B>MS HTML Help</B>
124</td>
e492150d
JS		 125<td align=center bgcolor="#E0E0E0">
126<B>wxHTML Help</B>
127</td>
128<td align=center bgcolor="#E0E0E0">
b69f1bd1
JS		 129<B>PDF</B>
130</td>
131</tr>
ddcc5f5b 132
b69f1bd1
JS		 133<tr>
134<td align=center>
e492150d
JS		 135<a href="wx/wx.htm">wxWindows Reference</a>
136</td>
137
138<td align=center>
139<a href="../winhelp/wx.hlp">wxWindows Reference</a>
140</td>
141
142<td align=center>
143<a href="../htmlhelp/wx.chm">wxWindows Reference</a>
144</td>
145
146<td align=center>
147<a href="../htb/wx.htb">wxWindows Reference</a>
148</td>
149
150<td align=center>
151<a href="../pdf/wx.pdf">wxWindows Reference</a>
152</td>
153</tr>
154
155<tr>
156<td align=center>
157<a href="dialoged/dlged.htm">Dialog Editor</a>
158</td>
159
160<td align=center>
161<a href="../winhelp/dialoged.hlp">Dialog Editor</a>
b69f1bd1
JS		 162</td>
163
164<td align=center>
e492150d 165<a href="../htmlhelp/dialoged.chm">Dialog Editor</a>
b69f1bd1
JS		 166</td>
167
f6bcfd97 168<td align=center>
e492150d 169<a href="../htb/dialoged.htb">Dialog Editor</a>
f6bcfd97
BP		 170</td>
171
b69f1bd1 172<td align=center>
e492150d 173<a href="../pdf/dialoged.pdf">Dialog Editor</a>
b69f1bd1
JS		 174</td>
175</tr>
176
b69f1bd1
JS		 177<tr>
178<td align=center>
e492150d 179<a href="tex2rtf/t2rtf.htm">Tex2RTF</a>
b69f1bd1
JS		 180</td>
181
182<td align=center>
e492150d 183<a href="../winhelp/tex2rtf.hlp">Tex2RTF</a>
b69f1bd1
JS		 184</td>
185
f6bcfd97 186<td align=center>
e492150d 187<a href="../htmlhelp/tex2rtf.chm">Tex2RTF</a>
f6bcfd97
BP		 188</td>
189
b69f1bd1 190<td align=center>
e492150d
JS		 191<a href="../htb/tex2rtf.htb">Tex2RTF</a>
192</td>
193
194<td align=center>
195<a href="../pdf/tex2rtf.pdf">Tex2RTF</a>
b69f1bd1
JS		 196</td>
197</tr>
198
f6bcfd97
BP		 199<tr>
200<td align=center>
e492150d 201<a href="fl/fl.htm">FL Library</a>
f6bcfd97
BP		 202</td>
203
204<td align=center>
e492150d
JS		 205<a href="../winhelp/fl.hlp">FL Library</a>
206
f6bcfd97
BP		 207</td>
208
209<td align=center>
e492150d 210<a href="../htmlhelp/fl.chm">FL Library</a>
f6bcfd97
BP		 211</td>
212
213<td align=center>
e492150d
JS		 214<a href="../htb/fl.htb">FL Library</a>
215</td>
216
217<td align=center>
218<a href="../pdf/fl.pdf">FL Library</a>
f6bcfd97
BP		 219</td>
220</tr>
221
b69f1bd1
JS		 222<tr>
223<td align=center>
e492150d
JS		 224<a href="ogl/ogl.htm">OGL Library</a>
225</td>
226
227<td align=center>
228<a href="../winhelp/ogl.hlp">OGL Library</a>
229
b69f1bd1
JS		 230</td>
231
232<td align=center>
e492150d 233<a href="../htmlhelp/ogl.chm">OGL Library</a>
b69f1bd1
JS		 234</td>
235
f6bcfd97 236<td align=center>
e492150d 237<a href="../htb/ogl.htb">OGL Library</a>
f6bcfd97
BP		 238</td>
239
b69f1bd1 240<td align=center>
e492150d 241<a href="../pdf/ogl.pdf">OGL Library</a>
b69f1bd1
JS		 242</td>
243</tr>
244
245</table>
246
e492150d
JS		 247<P>
248
249<table width=100% border=0 cellpadding=3 cellspacing=0>
250<tr>
251<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
252<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
253<b><a name="technotes">Technical notes</a></b>
254</font>
255</td>
256</tr>
257</table>
258
259<P>
66f55ec6
JS		 260
261<ul>
9ba09ba5 262<li><a href="../tech/index.txt">Index of technical notes</a>
e492150d
JS		 263<li><a href="../tech/">Technical notes</a>
264<li><a href="platform.htm">Platforms supported</a>
265<li><a href="i18n.htm">Languages supported by wxWindows</a>
66f55ec6 266</ul>
b69f1bd1 267
e492150d
JS		 268<P>
269
270<table width=100% border=0 cellpadding=3 cellspacing=0>
271<tr>
272<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
273<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
274<b><a name="thirdparty">Thirty-party tools</a></b>
275</font>
276</td>
277</tr>
278</table>
279
280<P>
ddcc5f5b
JS		 281
282<ul>
f6bcfd97 283<li><a href="gettext/index.html">gettext Manual</a>
ddcc5f5b
JS		 284</ul>
285
e492150d
JS		 286<P>
287
288<table width=100% border=0 cellpadding=3 cellspacing=0>
289<tr>
290<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
291<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
292<b><a name="samples">Samples</a></b>
293</font>
294</td>
295</tr>
296</table>
297
298<P>
7921cf2b 299
457e6c54
JS		 300Each of the following demonstrates one or more aspect of wxWindows.<P>
301
7921cf2b 302<ul>
69477ac4
JS		 303<li><a href="../../samples/calendar">artprov</a>: shows how you can customize the look of standard
304wxWindows dialogs by replacing default bitmaps/icons with your own versions.
1cf4526d 305<li><a href="../../samples/calendar">calendar</a>: a sample to test the wxCalendarCtrl class.
edc26c4c 306<li><a href="../../samples/caret">caret</a>: a sample to test the wxCaret class.
7921cf2b
JS		 307<li><a href="../../samples/checklst">checklst</a>: demonstrates wxCheckListBox on
308supported platforms (currently Windows and GTK only).
309<li><a href="../../samples/config">config</a>: demonstrates use of wxConfig, which
310defaults to wxRegConfig on WIN32, wxIniConfig on WIN16, and wxFileConfig on other platforms.
1a7f3062
JS		 311<li><a href="../../samples/console">console</a>: demonstrates a console application using
312console-mode (no-GUI) compilation of wxWindows.
7921cf2b
JS		 313<li><a href="../../samples/controls">controls</a>: sample showing a variety of controls, including
314wxNotebook.
315<li><a href="../../samples/db">db</a>: wxDB ODBC sample.
1cf4526d
JS		 316<li><a href="../../samples/ipc">ipc</a>: shows the DDE-like protocol in action, both using real
317DDE on Windows, and TCP/IP on all platforms. Edit <a href="../../samples/ipc/ddesetup.h">ddesetup.h</a>
318to switch between compilation modes.
7921cf2b
JS		 319<li><a href="../../samples/dialogs">dialogs</a>: shows some of the common dialogs available -- wxFontDialog,
320wxColourDialog, wxFileDialog, wxDirDialog, wxMessageBox, wxTextEntryDialog, wxSingleChoiceDialog.
321For printing-related dialogs, see the printing sample.
7b28757f
JS		 322<li><a href="../../samples/dragimag">dragimag</a>: wxDragImage demo.
323<li><a href="../../samples/dialup">dialup</a>: wxDialUpManager demo.
7921cf2b
JS		 324<li><a href="../../samples/dnd">dnd</a>: demonstrates drag and drop on supported platforms.
325<li><a href="../../samples/docview">docview</a>: demonstrates use of the document view classes,
326using wxFrame.
7b28757f 327<li><a href="../../samples/docvwmdi">docvwmdi</a>: demonstrates use of the document view classes,
7921cf2b 328using wxMDIParentFrame, wxMDIChildFrame.
25f47127 329<li><a href="../../samples/drawing">drawing</a>: tests device context drawing.
7921cf2b
JS		 330<li><a href="../../samples/dynamic">dynamic</a>: shows how to connect events to member functions
331dynamically.
d35b028e 332<li><a href="../../samples/event">event</a>: demonstrates event handling.
76a4f50d 333<li><a href="../../samples/exec">exec</a>: demonstrates wxExecute.
ad556aa9 334<li><a href="../../samples/font">font</a>: tests fonts, font enumerator, font encodings.
0d3a69ec
JS		 335<li><a href="../../samples/grid">grid</a>: demonstrates the wxGrid class. This demo should work
336when the old grid implementation is compiled into wxWindows, and also with the new implementation.
337Please see newgrid below for a full demo of the new implementation's capabilities.
7921cf2b 338<li><a href="../../samples/help">help</a>: shows how to use wxHelpController.
edc26c4c
JS		 339<li><a href="../../samples/html">html</a>: a number of demos for the wxHTML class library, used inside
340applications and also as a help facility.
9ffdee80
JS		 341 <ul>
342 <li><a href="../../samples/html/about">about</a>: shows use of a wxHTML widget inside an About box.
343 <li><a href="../../samples/html/help">help</a>: shows use of wxHtmlHelpController to display wxHTML help.
0d3a69ec 344 <li><a href="../../samples/html/helpview">helpview</a>: a stand-alone wxHTML help viewer for any .htb book.
9ffdee80
JS		 345 <li><a href="../../samples/html/printing">printing</a>: shows how easy it is to preview and print HTML files.
346 <li><a href="../../samples/html/test">test</a>: general wxHTML test application.
347 <li><a href="../../samples/html/virtual">virtual</a>: demonstrates the virtual file system feature.
348 <li><a href="../../samples/html/widget">widget</a>: demonstrates the use of controls in HTML pages.
349 <li><a href="../../samples/html/zip">zip</a>: shows how help files can be packaged in zip archives.
350 </ul>
7921cf2b
JS		 351<li><a href="../../samples/image">image</a>: shows off the cross-platform wxImage class.
352<li><a href="../../samples/internat">internat</a>: use of wxWindows' internationalization support.
353<li><a href="../../samples/joytest">joytest</a>: tests the wxJoystick class (currently Windows and GTK only).
e492150d 354<li><a href="../../samples/keyboard">keyboard</a>: tests keyboard support.
7921cf2b
JS		 355<li><a href="../../samples/layout">layout</a>: shows the constraint layout system in action.
356<li><a href="../../samples/listctrl">listctrl</a>: demonstrates the wxListCtrl (implemented natively on
357WIN32, and using a generic version on other platforms).
ad556aa9 358<li><a href="../../samples/menu">menu</a>: tests menus.
7921cf2b
JS		 359<li><a href="../../samples/mdi">mdi</a>: shows off the MDI (Multiple Document Interface) classes. On Windows, the regular MDI
360scheme is used whereby child windows have full sizing and moving rights within the main
361window. On other platforms, tabbed windows are used, where the children are always maximized.
362<li><a href="../../samples/memcheck">memcheck</a>: demonstrates the memory checking/debugging facilities.
363<li><a href="../../samples/mfc">mfc</a>: shows how to use MFC and wxWindows code in the same application (Windows only).
818e52c2 364To compile this, you must edit include/wx/wxprec.h, comment out the windows.h inclusion, and recompile wxWindows.
7921cf2b
JS		 365<li><a href="../../samples/minifram">minifram</a>: demonstrates a frame with a small title bar. On
366platforms that don't support it, a normal-sized title bar is displayed.
367<li><a href="../../samples/minimal">minimal</a>: just shows a frame, a menubar, and a statusbar. About as
368small a wxWindows application as you can get.
e492150d 369<li><a href="../../samples/mobile">mobile</a>: mini applications for embedded platforms.
7921cf2b
JS		 370<li><a href="../../samples/nativdlg">nativdlg</a>: shows how wxWindows can load a standard Windows
371dialog resource, translating the controls into wxWindows controls (Windows only).
0d3a69ec 372<li><a href="../../samples/newgrid">newgrid</a>: demonstrates the new wxGrid implementation, by Michael Bedward and others.
7921cf2b
JS		 373<li><a href="../../samples/notebook">notebook</a>: shows the wxNotebook (tabbed window) control.
374<li><a href="../../samples/oleauto">oleauto</a>: a little OLE automation controller (Windows only; requires
375Excel to be present).
376<li><a href="../../samples/ownerdrw">ownerdrw</a>: demonstrates owner-draw menus and controls (Windows only).
377<li><a href="../../samples/png">png</a>: demonstrates PNG loading.
378<li><a href="../../samples/printing">printing</a>: shows printing and previewing.
379<li><a href="../../samples/proplist">proplist</a>: demonstrates the property list classes (a VB-style property editor).
c3b177ae 380<li><a href="../../samples/propsize">propsize</a>: demonstrates proportional sizer classes.
7921cf2b
JS		 381<li><a href="../../samples/regtest">regtest</a>: tests the low-level Windows registry functions (Windows only).
382<li><a href="../../samples/resource">resource</a>: shows how to use wxWindows resources (.wxr files).
e492150d 383<!-- <li><a href="../../samples/richedit">richedit</a>: a work-in-progress rich text editor with plain text and HTML export
edc26c4c 384facilities.
e492150d 385-->
457e6c54
JS		 386<li><a href="../../samples/rotate">rotate</a>: demonstrates interpolated and non-interpolated
387rotation of a wxImage.
7921cf2b
JS		 388<li><a href="../../samples/sashtest">sashtest</a>: demonstrates use of the wxSashWindow class to allow
389the user to resize subwindows.
ad556aa9
JS		 390<li><a href="../../samples/scroll">scroll</a>: demonstrates wxScrolledWindow.
391<li><a href="../../samples/scrollsub">scrollsub</a>: demonstrates the use of wxScrolledWindow to scroll
392an embedded window.
1cf4526d 393<li><a href="../../samples/sockets">sockets</a>: demonstrates the TCP/IP family of classes.
7921cf2b 394<li><a href="../../samples/splitter">splitter</a>: demonstrates the wxSplitterWindow class.
0d3a69ec 395<li><a href="../../samples/statbar">statbar</a>: demonstrates the wxStatusBar class.
7921cf2b
JS		 396<li><a href="../../samples/taskbar">taskbar</a>: demonstrates the wxTaskBarIcon class, for
397adding icons to the system tray. Windows only, but may eventually be implemented for other desktop
398environments that use this metaphor.
edc26c4c
JS		 399<li><a href="../../samples/text">text</a>: demonstrates single and multiline text controls,
400and clipboard operations.
7921cf2b
JS		 401<li><a href="../../samples/thread">thread</a>: tests the family of classes for doing thread
402programming.
403<li><a href="../../samples/toolbar">toolbar</a>: demonstrates wxToolBar.
404<li><a href="../../samples/treectrl">treectrl</a>: demonstrates wxTreeCtrl.
405<li><a href="../../samples/typetest">typetest</a>: tests various data type classes, including
406wxTime, wxDate and wxVariant.
407<li><a href="../../samples/validate">validate</a>: shows simple use of validation.
2723cfeb 408<li><a href="../../samples/wizard">wizard</a>: demonstrates the wxWizard class.
1cf4526d
JS		 409</ul>
410
e492150d
JS		 411<P>
412
413<table width=100% border=0 cellpadding=3 cellspacing=0>
414<tr>
415<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
416<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
417<b><a name="demos">Demos</a></b>
418</font>
419</td>
420</tr>
421</table>
422
423<P>
1cf4526d 424
457e6c54
JS		 425The following are fully-fledged applications.<P>
426
1cf4526d
JS		 427<ul>
428<li><a href="../../demos/bombs">bombs</a>: minesweeper-like game.
457e6c54
JS		 429<li><a href="../../demos/dbbrowse">dbbrowse</a>: ODBC database browser application.
430<li><a href="../../demos/forty">forty</a>: a great little card game by Chris Breeze.
1cf4526d
JS		 431<li><a href="../../demos/fractal">fractal</a>: fractal mountains by Andrew Davison.
432<li><a href="../../demos/life">life</a>: the game of Life by J. H. Conway, implemented in wxWindows by Guillermo Rodriguez Garcia.
433<li><a href="../../demos/poem">poem</a>: a little poetry display program.
7921cf2b
JS		 434</ul>
435
ddcc5f5b
JS		 436</font>
437
438</BODY>
439
440</HTML>
441
wxWidgets (Impactor)