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