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