]> 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
Some doc corrections; Watcom C++ corrections; VC++ 4 corrections
[wxWidgets.git] / docs / html / index.htm
CommitLineData
ddcc5f5b
JS		 1<HTML>
2
3<HEAD>
4<TITLE>wxWindows Documentation</TITLE>
5
6</HEAD>
7
b69f1bd1
JS		 8<!BODY BGCOLOR="#FFFFFF" TEXT=#000000 LINK=#FF0000 VLINK=#000000>
9<BODY BGCOLOR="#CCDDDFF" TEXT=#000000 LINK=#FF0000 VLINK=#000000>
ddcc5f5b
JS		 10
11<font face="Arial, Lucida Sans, Helvetica">
12
13<a name="top"></a>
14
15<table width=100% border=4 cellpadding=5 cellspacing=0>
16<tr>
17<td bgcolor="#660000">
18<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
19<IMG src="logo.gif" align=right>
20<!-- wxWindows Documentation -->
21</font>
22</td>
23</tr>
24</table>
25
26<P>
27
b69f1bd1
JS		 28Welcome to wxWindows 2, the premi&egrave;re cross-platform GUI C++ framework. This is an index of
29the plain text, HTML, Windows Help and Acrobat documentation: availability depends on what you've
30downloaded from the <a href="http://www.wxwindows.org">wxWindows Web site</a>.<P>
ddcc5f5b 31
7921cf2b
JS		 32<CENTER>
33<FONT size=-1>
34[<a href="#install">Install</a>]
35[<a href="#manuals">Manuals</a>]
36[<a href="#thirdparty">3rd party tools</a>]
37[<a href="#samples">Samples</a>]
1cf4526d 38[<a href="#demos">Demos</a>]
7921cf2b
JS		 39</FONT>
40</CENTER>
41
b69f1bd1 42<h3 align=center><a name="install"><hr>Installation and release notes<hr></a></h3>
ddcc5f5b
JS		 43
44<ul>
2dc5505e
JS		 45<li>ReadMe: <a href="../readme.txt"><b>General ReadMe</b></a>,
46<a href="../gtk/readme.txt">wxGTK</a>,
ddcc5f5b
JS		 47<a href="../motif/readme.txt">wxMotif</a>,
48<a href="../msw/readme.txt">wxMSW</a>
4f02408e 49<li><a href="../release.txt"><b>Release notes</b></a>
ddcc5f5b
JS		 50<li>Installation: <a href="../gtk/install.txt">wxGTK</a>,
51<a href="../motif/install.txt">wxMotif</a>,
52<a href="../msw/install.txt">wxMSW</a>
2dc5505e
JS		 53<li><a href="../changes.txt"><b>Change log</b></a>
54<li><a href="../bugs.txt"><b>Buglist</b></a>
55<li>Licence: <a href="../preamble.txt">Preamble</a>,
56<a href="../licence.txt">Licence</a>,
57<a href="../licendoc.txt">Documentation Licence</a>,
58<a href="../lgpl.txt">L-GPL</a>,
59<a href="../gpl.txt">GPL</a>
ce3ed50d
JS		 60<li><a href="faq.htm"><B>FAQ</B></a>:
61 <ul>
62 <li><a href="faqgen.htm">General questions</a>
63 <li><a href="faqgtk.htm">wxWindows 2 for GTK</a>
64 <li><a href="faqmsw.htm">wxWindows 2 for Windows</a>
65 <li><a href="faqmot.htm">wxWindows 2 for Motif</a>
66 <li><a href="faqmac.htm">wxWindows 2 for Mac</a>
67 </ul>
2dc5505e
JS		 68<li>ToDo: <a href="../todo.txt"><b>General ToDo</b></a>,
69<a href="../gtk/todo.txt">wxGTK</a>,
ddcc5f5b
JS		 70<a href="../motif/todo.txt">wxMotif</a>,
71<a href="../msw/todo.txt">wxMSW</a>
72<li>List of <a href="../symbols.txt">preprocessor symbols</a> used in wxWindows
73</ul>
74
b69f1bd1 75<h3 align=center><a name="manuals"><hr>wxWindows manuals<hr></a></h3>
7921cf2b 76
b69f1bd1 77<table border=1 align=center>
7921cf2b 78
b69f1bd1
JS		 79<tr>
80<td align=center bgcolor="#FFFF00">
81<B>HTML</B>
82</td>
83<td align=center bgcolor="#FFFF00">
84<B>WinHelp</B>
85</td>
86<td align=center bgcolor="#FFFF00">
87<B>PDF</B>
88</td>
89</tr>
ddcc5f5b 90
b69f1bd1
JS		 91<tr>
92<td align=center>
93<a href="wx/wx.htm">Reference Manual</a>
94</td>
95
96<td align=center>
97<a href="../winhelp/wx.hlp">Reference Manual</a>
98</td>
99
100<td align=center>
101<a href="../pdf/wx.pdf">Reference Manual</a>
102</td>
103</tr>
104
b69f1bd1
JS		 105<tr>
106<td align=center>
107<a href="dialoged/dlged.htm">Dialog Editor Manual</a>
108</td>
109
110<td align=center>
111<a href="../winhelp/dialoged.hlp">Dialog Editor Manual</a>
112</td>
113
114<td align=center>
115<a href="../pdf/dialoged.pdf">Dialog Editor Manual</a>
116</td>
117</tr>
118
b69f1bd1
JS		 119<tr>
120<td align=center>
121<a href="wxtree/tree.htm">wxTreeLayout Class</a>
122</td>
123
124<td align=center>
125<a href="../winhelp/wxtree.hlp">wxTreeLayout Class</a>
126</td>
127
128<td align=center>
129<a href="../pdf/wxtree.pdf">wxTreeLayout Class</a>
130</td>
131</tr>
132
133<tr>
134<td align=center>
135<a href="odbc/odbc.htm">Remstar ODBC Classes</a>
136</td>
137
138<td align=center>
139<BR><BR>
140</td>
141
142<td align=center>
143<a href="../pdf/odbc.pdf">Remstar ODBC Classes</a>
144</td>
145</tr>
146
147</table>
148
149
150<h3 align=center><a name="thirdparty"><hr>Third-party tools<hr></a></h3>
ddcc5f5b
JS		 151
152<ul>
b69f1bd1
JS		 153<li><a href="gettext/gettext.htm">gettext Manual</a>
154<li><a href="gettext/xgettext.htm">xgettext Manual</a>
155<li><a href="gettext/msgfmt.htm">msgfmt Manual</a>
ddcc5f5b
JS		 156</ul>
157
b69f1bd1 158<h3 align=center><a name="samples"><hr>Samples<hr></a></h3>
7921cf2b 159
457e6c54
JS		 160Each of the following demonstrates one or more aspect of wxWindows.<P>
161
7921cf2b 162<ul>
1cf4526d 163<li><a href="../../samples/calendar">calendar</a>: a sample to test the wxCalendarCtrl class.
edc26c4c 164<li><a href="../../samples/caret">caret</a>: a sample to test the wxCaret class.
7921cf2b
JS		 165<li><a href="../../samples/checklst">checklst</a>: demonstrates wxCheckListBox on
166supported platforms (currently Windows and GTK only).
167<li><a href="../../samples/config">config</a>: demonstrates use of wxConfig, which
168defaults to wxRegConfig on WIN32, wxIniConfig on WIN16, and wxFileConfig on other platforms.
1a7f3062
JS		 169<li><a href="../../samples/console">console</a>: demonstrates a console application using
170console-mode (no-GUI) compilation of wxWindows.
7921cf2b
JS		 171<li><a href="../../samples/controls">controls</a>: sample showing a variety of controls, including
172wxNotebook.
173<li><a href="../../samples/db">db</a>: wxDB ODBC sample.
1cf4526d
JS		 174<li><a href="../../samples/ipc">ipc</a>: shows the DDE-like protocol in action, both using real
175DDE on Windows, and TCP/IP on all platforms. Edit <a href="../../samples/ipc/ddesetup.h">ddesetup.h</a>
176to switch between compilation modes.
7921cf2b
JS		 177<li><a href="../../samples/dialogs">dialogs</a>: shows some of the common dialogs available -- wxFontDialog,
178wxColourDialog, wxFileDialog, wxDirDialog, wxMessageBox, wxTextEntryDialog, wxSingleChoiceDialog.
179For printing-related dialogs, see the printing sample.
180<li><a href="../../samples/dnd">dnd</a>: demonstrates drag and drop on supported platforms.
181<li><a href="../../samples/docview">docview</a>: demonstrates use of the document view classes,
182using wxFrame.
183<li><a href="../../samples/docvwmdi">docvwmdi</a>: : demonstrates use of the document view classes,
184using wxMDIParentFrame, wxMDIChildFrame.
25f47127 185<li><a href="../../samples/drawing">drawing</a>: tests device context drawing.
7921cf2b
JS		 186<li><a href="../../samples/dynamic">dynamic</a>: shows how to connect events to member functions
187dynamically.
76a4f50d 188<li><a href="../../samples/exec">exec</a>: demonstrates wxExecute.
ad556aa9 189<li><a href="../../samples/font">font</a>: tests fonts, font enumerator, font encodings.
7921cf2b
JS		 190<li><a href="../../samples/grid">grid</a>: demonstrates the wxGrid class.
191<li><a href="../../samples/help">help</a>: shows how to use wxHelpController.
edc26c4c
JS		 192<li><a href="../../samples/html">html</a>: a number of demos for the wxHTML class library, used inside
193applications and also as a help facility.
9ffdee80
JS		 194 <ul>
195 <li><a href="../../samples/html/about">about</a>: shows use of a wxHTML widget inside an About box.
196 <li><a href="../../samples/html/help">help</a>: shows use of wxHtmlHelpController to display wxHTML help.
197 <li><a href="../../samples/html/helpview">helpview</a>: a stand-alone wxHTML help viewer.
198 <li><a href="../../samples/html/printing">printing</a>: shows how easy it is to preview and print HTML files.
199 <li><a href="../../samples/html/test">test</a>: general wxHTML test application.
200 <li><a href="../../samples/html/virtual">virtual</a>: demonstrates the virtual file system feature.
201 <li><a href="../../samples/html/widget">widget</a>: demonstrates the use of controls in HTML pages.
202 <li><a href="../../samples/html/zip">zip</a>: shows how help files can be packaged in zip archives.
203 </ul>
7921cf2b
JS		 204<li><a href="../../samples/image">image</a>: shows off the cross-platform wxImage class.
205<li><a href="../../samples/internat">internat</a>: use of wxWindows' internationalization support.
206<li><a href="../../samples/joytest">joytest</a>: tests the wxJoystick class (currently Windows and GTK only).
207<li><a href="../../samples/layout">layout</a>: shows the constraint layout system in action.
208<li><a href="../../samples/listctrl">listctrl</a>: demonstrates the wxListCtrl (implemented natively on
209WIN32, and using a generic version on other platforms).
ad556aa9 210<li><a href="../../samples/menu">menu</a>: tests menus.
7921cf2b
JS		 211<li><a href="../../samples/mdi">mdi</a>: shows off the MDI (Multiple Document Interface) classes. On Windows, the regular MDI
212scheme is used whereby child windows have full sizing and moving rights within the main
213window. On other platforms, tabbed windows are used, where the children are always maximized.
214<li><a href="../../samples/memcheck">memcheck</a>: demonstrates the memory checking/debugging facilities.
215<li><a href="../../samples/mfc">mfc</a>: shows how to use MFC and wxWindows code in the same application (Windows only).
818e52c2 216To compile this, you must edit include/wx/wxprec.h, comment out the windows.h inclusion, and recompile wxWindows.
7921cf2b
JS		 217<li><a href="../../samples/minifram">minifram</a>: demonstrates a frame with a small title bar. On
218platforms that don't support it, a normal-sized title bar is displayed.
219<li><a href="../../samples/minimal">minimal</a>: just shows a frame, a menubar, and a statusbar. About as
220small a wxWindows application as you can get.
221<li><a href="../../samples/nativdlg">nativdlg</a>: shows how wxWindows can load a standard Windows
222dialog resource, translating the controls into wxWindows controls (Windows only).
1cf4526d 223<li><a href="../../samples/dialup">dialup</a>: wxDialUpManager demo.
ad556aa9 224<li><a href="../../samples/newgrid">newgrid</a>: demonstrates the new wxGrid implementation, by Michael Bedward.
7921cf2b
JS		 225<li><a href="../../samples/notebook">notebook</a>: shows the wxNotebook (tabbed window) control.
226<li><a href="../../samples/oleauto">oleauto</a>: a little OLE automation controller (Windows only; requires
227Excel to be present).
228<li><a href="../../samples/ownerdrw">ownerdrw</a>: demonstrates owner-draw menus and controls (Windows only).
229<li><a href="../../samples/png">png</a>: demonstrates PNG loading.
230<li><a href="../../samples/printing">printing</a>: shows printing and previewing.
231<li><a href="../../samples/proplist">proplist</a>: demonstrates the property list classes (a VB-style property editor).
232<li><a href="../../samples/regtest">regtest</a>: tests the low-level Windows registry functions (Windows only).
233<li><a href="../../samples/resource">resource</a>: shows how to use wxWindows resources (.wxr files).
edc26c4c
JS		 234<li><a href="../../samples/richedit">richedit</a>: a work-in-progress rich text editor with plain text and HTML export
235facilities.
457e6c54
JS		 236<li><a href="../../samples/rotate">rotate</a>: demonstrates interpolated and non-interpolated
237rotation of a wxImage.
7921cf2b
JS		 238<li><a href="../../samples/sashtest">sashtest</a>: demonstrates use of the wxSashWindow class to allow
239the user to resize subwindows.
ad556aa9
JS		 240<li><a href="../../samples/scroll">scroll</a>: demonstrates wxScrolledWindow.
241<li><a href="../../samples/scrollsub">scrollsub</a>: demonstrates the use of wxScrolledWindow to scroll
242an embedded window.
1cf4526d 243<li><a href="../../samples/sockets">sockets</a>: demonstrates the TCP/IP family of classes.
7921cf2b
JS		 244<li><a href="../../samples/splitter">splitter</a>: demonstrates the wxSplitterWindow class.
245<li><a href="../../samples/tab">tab</a>: demonstrates the generic tab window class. You should
246normally use wxNotebook instead, but the generic code is sometimes useful, for example for
247implementing wxNotebook on platforms with no native support.
248<li><a href="../../samples/taskbar">taskbar</a>: demonstrates the wxTaskBarIcon class, for
249adding icons to the system tray. Windows only, but may eventually be implemented for other desktop
250environments that use this metaphor.
edc26c4c
JS		 251<li><a href="../../samples/text">text</a>: demonstrates single and multiline text controls,
252and clipboard operations.
7921cf2b
JS		 253<li><a href="../../samples/thread">thread</a>: tests the family of classes for doing thread
254programming.
255<li><a href="../../samples/toolbar">toolbar</a>: demonstrates wxToolBar.
256<li><a href="../../samples/treectrl">treectrl</a>: demonstrates wxTreeCtrl.
257<li><a href="../../samples/typetest">typetest</a>: tests various data type classes, including
258wxTime, wxDate and wxVariant.
259<li><a href="../../samples/validate">validate</a>: shows simple use of validation.
2723cfeb 260<li><a href="../../samples/wizard">wizard</a>: demonstrates the wxWizard class.
1cf4526d
JS		 261</ul>
262
263<h3 align=center><a name="demos"><hr>Demos<hr></a></h3>
264
457e6c54
JS		 265The following are fully-fledged applications.<P>
266
1cf4526d
JS		 267<ul>
268<li><a href="../../demos/bombs">bombs</a>: minesweeper-like game.
457e6c54
JS		 269<li><a href="../../demos/dbbrowse">dbbrowse</a>: ODBC database browser application.
270<li><a href="../../demos/forty">forty</a>: a great little card game by Chris Breeze.
1cf4526d
JS		 271<li><a href="../../demos/fractal">fractal</a>: fractal mountains by Andrew Davison.
272<li><a href="../../demos/life">life</a>: the game of Life by J. H. Conway, implemented in wxWindows by Guillermo Rodriguez Garcia.
273<li><a href="../../demos/poem">poem</a>: a little poetry display program.
7921cf2b
JS		 274</ul>
275
276<hr>
277
ddcc5f5b
JS		 278</font>
279
280</BODY>
281
282</HTML>
283
wxWidgets (Impactor)