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