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