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