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