]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/html/index.htm
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Allow forward declaration of wxSlider in wxMSW (bug 1157614). Remove unused header...
[wxWidgets.git] / docs / html / index.htm
... / ...
CommitLineData
1<HTML>
2
3<HEAD>
4<TITLE>wxWidgets Documentation</TITLE>
5
6</HEAD>
7
8<BODY BGCOLOR=#FFFFFF TEXT=#000000 VLINK="#63659C" LINK="#313063" ALINK="#313063">
9
10<font face="Arial, Lucida Sans, Helvetica">
11
12<a name="top"></a>
13
14<IMG src="logo.gif" align=right hspace=10 vspace=0>
15
16<b>Welcome to wxWidgets 2, the premi&egrave;re cross-platform GUI C++ framework.</b><P>
17
18This is an index of
19the plain text, HTML, Windows Help and Acrobat documentation: availability depends on what you've
20downloaded from the <a href="http://www.wxwindows.org">wxWidgets Web site</a>.<br clear=all><P>
21
22<CENTER>
23<FONT size=-1>
24[<a href="#install">Install</a>]
25[<a href="#manuals">Manuals</a>]
26[<a href="#technotes">Technical Notes</a>]
27[<a href="#thirdparty">3rd party tools</a>]
28[<a href="#samples">Samples</a>]
29[<a href="#demos">Demos</a>]
30</FONT>
31</CENTER>
32
33<P>
34
35<table width=100% border=0 cellpadding=3 cellspacing=0>
36<tr>
37<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
38<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
39<b><a name="install">Installation and release notes</a></b>
40</font>
41</td>
42</tr>
43</table>
44
45<P>
46
47Unless you installed a binary version of wxWidgets using RPMs,
48you will probably have to compile the wxWidgets library first.
49Please read the platform-specific readme.txt and install.txt
50for how to do this.
51
52<P>
53
54<ul>
55<li>ReadMe: <a href="../readme.txt"><b>General ReadMe</b></a>,
56<a href="../gtk/readme.txt">wxGTK</a>,
57<a href="../motif/readme.txt">wxMotif</a>,
58<a href="../x11/readme.txt">wxX11</a>,
59<a href="../x11/readme-nanox.txt">wxNanoX</a>,
60<a href="../msw/readme.txt">wxMSW</a>,
61<a href="../mac/readme.txt">wxMac</a>,
62<a href="../mgl/readme.txt">wxMGL</a>,
63<a href="../univ/readme.txt">Univ</a>
64<li>Installation: <a href="../gtk/install.txt">wxGTK</a>,
65<a href="../motif/install.txt">wxMotif</a>,
66<a href="../x11/install.txt">wxX11</a>,
67<a href="../msw/install.txt">wxMSW</a>,
68<a href="../mac/install.txt">wxMac</a>,
69<a href="../mgl/install.txt">wxMGL</a>,
70<a href="../os2/install.txt">wxOS2</a>
71<li><a href="../changes.txt"><b>General change log</b></a>, <a href="../gtk/changes.txt">wxGTK change log</a>
72<li>Licence: <a href="../preamble.txt">Preamble</a>,
73<a href="../licence.txt">Licence</a>,
74<a href="../licendoc.txt">Documentation Licence</a>,
75<a href="../lgpl.txt">L-GPL</a>,
76<a href="../gpl.txt">GPL</a>
77<li><a href="faq.htm"><B>FAQ</B></a>:
78 <ul>
79 <li><a href="faqgen.htm">General questions</a>
80 <li><a href="faqgtk.htm">wxWidgets 2 for GTK+</a>
81 <li><a href="faqmsw.htm">wxWidgets 2 for Windows</a>
82 <li><a href="faqmot.htm">wxWidgets 2 for Motif</a>
83 <li><a href="faqx11.htm">wxWidgets 2 for X11</a>
84 <li><a href="faqmac.htm">wxWidgets 2 for Mac</a>
85 </ul>
86<li>ToDo: <a href="../todo.txt"><b>General ToDo</b></a>,
87<a href="../gtk/todo.txt">wxGTK</a>,
88<a href="../motif/todo.txt">wxMotif</a>,
89<a href="../msw/todo.txt">wxMSW</a>,
90<a href="../mac/todo.txt">wxMac</a>
91<li>List of <a href="../symbols.txt">preprocessor symbols</a> used in wxWidgets
92</ul>
93
94Further platform-specific notes:
95
96<ul>
97<li> wxMSW: <a href="../msw/winxp.txt">Windows XP</a>
98</ul>
99
100<P>
101
102<table width=100% border=0 cellpadding=3 cellspacing=0>
103<tr>
104<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
105<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
106<b><a name="manuals">wxWidgets manuals</a></b>
107</font>
108</td>
109</tr>
110</table>
111
112<P>
113
114To use manuals in wxHTML Help form (extension htb), you can use the <b>HelpView</b>
115application, either compiling it from utils/helpview in the distribution,
116or downloading a binary, for example from <a href="http://www.storylinescentral.com/helpview.htm">here</a>.<P>
117
118See also the <a href="../pdf/wxTutorial.pdf">wxWidgets Tutorial</a>
119by Franky Braem, in PDF format.<P>
120
121<P>
122
123<table border=0 cellpadding=5 cellspacing=0>
124
125<tr>
126<td align=center bgcolor="#E0E0E0">
127<B>HTML</B>
128</td>
129<td align=center bgcolor="#E0E0E0">
130<B>WinHelp</B>
131</td>
132<td align=center bgcolor="#E0E0E0">
133<B>MS HTML Help</B>
134</td>
135<td align=center bgcolor="#E0E0E0">
136<B>wxHTML Help</B>
137</td>
138<td align=center bgcolor="#E0E0E0">
139<B>PDF</B>
140</td>
141</tr>
142
143<tr>
144<td align=center>
145<a href="wx/wx_contents.html">wxWidgets Reference</a>
146</td>
147
148<td align=center>
149<a href="../winhelp/wx.hlp">wxWidgets Reference</a>
150</td>
151
152<td align=center>
153<a href="../htmlhelp/wx.chm">wxWidgets Reference</a>
154</td>
155
156<td align=center>
157<a href="../htb/wx.htb">wxWidgets Reference</a>
158</td>
159
160<td align=center>
161<a href="../pdf/wx.pdf">wxWidgets Reference</a>
162</td>
163</tr>
164
165<tr>
166<td align=center>
167<a href="tex2rtf/t2rtf.htm">Tex2RTF</a>
168</td>
169
170<td align=center>
171<a href="../winhelp/tex2rtf.hlp">Tex2RTF</a>
172</td>
173
174<td align=center>
175<a href="../htmlhelp/tex2rtf.chm">Tex2RTF</a>
176</td>
177
178<td align=center>
179<a href="../htb/tex2rtf.htb">Tex2RTF</a>
180</td>
181
182<td align=center>
183<a href="../pdf/tex2rtf.pdf">Tex2RTF</a>
184</td>
185</tr>
186
187<tr>
188<td align=center>
189<a href="fl/fl.htm">FL Library</a>
190</td>
191
192<td align=center>
193<a href="../winhelp/fl.hlp">FL Library</a>
194
195</td>
196
197<td align=center>
198<a href="../htmlhelp/fl.chm">FL Library</a>
199</td>
200
201<td align=center>
202<a href="../htb/fl.htb">FL Library</a>
203</td>
204
205<td align=center>
206<a href="../pdf/fl.pdf">FL Library</a>
207</td>
208</tr>
209
210<tr>
211<td align=center>
212<a href="ogl/ogl.htm">OGL Library</a>
213</td>
214
215<td align=center>
216<a href="../winhelp/ogl.hlp">OGL Library</a>
217
218</td>
219
220<td align=center>
221<a href="../htmlhelp/ogl.chm">OGL Library</a>
222</td>
223
224<td align=center>
225<a href="../htb/ogl.htb">OGL Library</a>
226</td>
227
228<td align=center>
229<a href="../pdf/ogl.pdf">OGL Library</a>
230</td>
231</tr>
232
233</table>
234
235<P>
236
237<table width=100% border=0 cellpadding=3 cellspacing=0>
238<tr>
239<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
240<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
241<b><a name="technotes">Technical notes</a></b>
242</font>
243</td>
244</tr>
245</table>
246
247<P>
248
249<ul>
250<li><a href="../tech/index.txt">Index of technical notes</a>
251<li><a href="../tech/">Technical notes</a>
252<li><a href="platform.htm">Platforms supported</a>
253<li><a href="i18n.htm">Languages supported by wxWidgets</a>
254</ul>
255
256<P>
257
258<table width=100% border=0 cellpadding=3 cellspacing=0>
259<tr>
260<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
261<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
262<b><a name="thirdparty">Thirty-party tools</a></b>
263</font>
264</td>
265</tr>
266</table>
267
268<P>
269
270<ul>
271<li><a href="gettext/index.html">gettext Manual</a>
272</ul>
273
274<P>
275
276<table width=100% border=0 cellpadding=3 cellspacing=0>
277<tr>
278<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
279<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
280<b><a name="samples">Samples</a></b>
281</font>
282</td>
283</tr>
284</table>
285
286<P>
287
288Each of the following samples demonstrates one or more aspect of wxWidgets.<P>
289
290<ul>
291<li><a href="../../samples/artprov">artprov</a>: shows how you can customize the look of standard
292wxWidgets dialogs by replacing default bitmaps/icons with your own versions.
293<li><a href="../../samples/calendar">calendar</a>: a sample to test the wxCalendarCtrl class.
294<li><a href="../../samples/caret">caret</a>: a sample to test the wxCaret class.
295<li><a href="../../samples/checklst">checklst</a>: demonstrates wxCheckListBox on
296supported platforms (currently Windows and GTK only).
297<li><a href="../../samples/config">config</a>: demonstrates use of wxConfig, which
298defaults to wxRegConfig on WIN32 (optionally wxIniConfig), and wxFileConfig on other platforms.
299<li><a href="../../samples/console">console</a>: demonstrates a console application using
300console-mode (no-GUI) compilation of wxWidgets.
301<li><a href="../../samples/controls">controls</a>: sample showing a variety of controls, including
302wxNotebook.
303<li><a href="../../samples/db">db</a>: wxDB ODBC sample.
304<li><a href="../../samples/dialogs">dialogs</a>: shows some of the common dialogs available -- wxFontDialog,
305wxColourDialog, wxFileDialog, wxDirDialog, wxMessageBox, wxTextEntryDialog, wxSingleChoiceDialog.
306For printing-related dialogs, see the printing sample.
307<li><a href="../../samples/dialup">dialup</a>: wxDialUpManager demo.
308<li><a href="../../samples/dnd">dnd</a>: demonstrates drag and drop on supported platforms.
309<li><a href="../../samples/docview">docview</a>: demonstrates use of the document view classes,
310using wxFrame.
311<li><a href="../../samples/docvwmdi">docvwmdi</a>: demonstrates use of the document view classes,
312using wxMDIParentFrame, wxMDIChildFrame.
313<li><a href="../../samples/dragimag">dragimag</a>: wxDragImage demo.
314<li><a href="../../samples/drawing">drawing</a>: tests device context drawing.
315<li><a href="../../samples/dynamic">dynamic</a>: shows how to connect events to member functions
316dynamically.
317<li><a href="../../samples/event">event</a>: demonstrates event handling.
318<li><a href="../../samples/exec">exec</a>: demonstrates wxExecute.
319<li><a href="../../samples/font">font</a>: tests fonts, font enumerator, font encodings.
320<li><a href="../../samples/grid">grid</a>: demonstrates the wxGrid class.
321<li><a href="../../samples/help">help</a>: shows how to use wxHelpController.
322<li><a href="../../samples/html">html</a>: a number of demos for the wxHTML class library, used inside
323applications and also as a help facility.
324 <ul>
325 <li><a href="../../samples/html/about">about</a>: shows use of a wxHTML widget inside an About box.
326 <li><a href="../../samples/html/help">help</a>: shows use of wxHtmlHelpController to display wxHTML help.
327 <li><a href="../../samples/html/helpview">helpview</a>: a stand-alone wxHTML help viewer for any .htb book.
328 <li><a href="../../samples/html/printing">printing</a>: shows how easy it is to preview and print HTML files.
329 <li><a href="../../samples/html/test">test</a>: general wxHTML test application.
330 <li><a href="../../samples/html/virtual">virtual</a>: demonstrates the virtual file system feature.
331 <li><a href="../../samples/html/widget">widget</a>: demonstrates the use of controls in HTML pages.
332 <li><a href="../../samples/html/zip">zip</a>: shows how help files can be packaged in zip archives.
333 </ul>
334<li><a href="../../samples/image">image</a>: shows off the cross-platform wxImage class.
335<li><a href="../../samples/ipc">ipc</a>: shows the DDE-like protocol in action, both using real
336DDE on Windows, and TCP/IP on all platforms. Edit <a href="../../samples/ipc/ddesetup.h">ddesetup.h</a>
337to switch between compilation modes.
338<li><a href="../../samples/internat">internat</a>: use of wxWidgets' internationalization support.
339<li><a href="../../samples/joytest">joytest</a>: tests the wxJoystick class (currently Windows and GTK only).
340<li><a href="../../samples/keyboard">keyboard</a>: tests keyboard support.
341<li><a href="../../samples/layout">layout</a>: shows the constraint layout system in action.
342<li><a href="../../samples/listctrl">listctrl</a>: demonstrates the wxListCtrl (implemented natively on
343WIN32, and using a generic version on other platforms).
344<li><a href="../../samples/menu">menu</a>: tests menus.
345<li><a href="../../samples/mdi">mdi</a>: shows off the MDI (Multiple Document Interface) classes. On Windows, the regular MDI
346scheme is used whereby child windows have full sizing and moving rights within the main
347window. On other platforms, tabbed windows are used, where the children are always maximized.
348<li><a href="../../samples/memcheck">memcheck</a>: demonstrates the memory checking/debugging facilities.
349<li><a href="../../samples/mfc">mfc</a>: shows how to use MFC and wxWidgets code in the same application (Windows only).
350To compile this, you must edit include/wx/wxprec.h, comment out the windows.h inclusion, and recompile wxWidgets.
351<li><a href="../../samples/minifram">minifram</a>: demonstrates a frame with a small title bar. On
352platforms that don't support it, a normal-sized title bar is displayed.
353<li><a href="../../samples/minimal">minimal</a>: just shows a frame, a menubar, and a statusbar. About as
354small a wxWidgets application as you can get.
355<li><a href="../../samples/mobile">mobile</a>: mini applications for embedded platforms.
356<li><a href="../../samples/nativdlg">nativdlg</a>: shows how wxWidgets can load a standard Windows
357dialog resource, translating the controls into wxWidgets controls (Windows only).
358<li><a href="../../samples/notebook">notebook</a>: shows the wxNotebook (tabbed window) control.
359<li><a href="../../samples/oleauto">oleauto</a>: a little OLE automation controller (Windows only; requires
360Excel to be present).
361<li><a href="../../samples/ownerdrw">ownerdrw</a>: demonstrates owner-draw menus and controls (Windows only).
362<li><a href="../../samples/png">png</a>: demonstrates PNG loading.
363<li><a href="../../samples/printing">printing</a>: shows printing and previewing.
364<li><a href="../../samples/propsize">propsize</a>: demonstrates proportional sizer classes.
365<li><a href="../../samples/regtest">regtest</a>: tests the low-level Windows registry functions (Windows only).
366<!-- <li><a href="../../samples/richedit">richedit</a>: a work-in-progress rich text editor with plain text and HTML export
367facilities.
368-->
369<li><a href="../../samples/rotate">rotate</a>: demonstrates interpolated and non-interpolated
370rotation of a wxImage.
371<li><a href="../../samples/sashtest">sashtest</a>: demonstrates use of the wxSashWindow class to allow
372the user to resize subwindows.
373<li><a href="../../samples/scroll">scroll</a>: demonstrates wxScrolledWindow.
374<li><a href="../../samples/scrollsub">scrollsub</a>: demonstrates the use of wxScrolledWindow to scroll
375an embedded window.
376<li><a href="../../samples/sockets">sockets</a>: demonstrates the TCP/IP family of classes.
377<li><a href="../../samples/splash">splash</a>: demonstrates use of the wxSplashScreen class.
378<li><a href="../../samples/splitter">splitter</a>: demonstrates the wxSplitterWindow class.
379<li><a href="../../samples/statbar">statbar</a>: demonstrates the wxStatusBar class.
380<li><a href="../../samples/taskbar">taskbar</a>: demonstrates the wxTaskBarIcon class, for
381adding icons to the system tray. Windows only, but may eventually be implemented for other desktop
382environments that use this metaphor.
383<li><a href="../../samples/text">text</a>: demonstrates single and multiline text controls,
384and clipboard operations.
385<li><a href="../../samples/thread">thread</a>: tests the family of classes for doing thread
386programming.
387<li><a href="../../samples/toolbar">toolbar</a>: demonstrates wxToolBar.
388<li><a href="../../samples/treectrl">treectrl</a>: demonstrates wxTreeCtrl.
389<li><a href="../../samples/typetest">typetest</a>: tests various data type classes, including
390wxTime, wxDate and wxVariant.
391<li><a href="../../samples/validate">validate</a>: shows simple use of validation.
392<li><a href="../../samples/wizard">wizard</a>: demonstrates the wxWizard class.
393<li><a href="../../samples/xrc">xrc</a>: demonstrates the XRC resource system.
394</ul>
395
396The following are deprecated samples.
397
398<ul>
399<li><a href="../../contrib/deprecated/samples/resource">resource</a>: shows how to use old-style wxWidgets resources (.wxr files).
400<li><a href="../../contrib/deprecated/samples/proplist">proplist</a>: demonstrates the property list classes (a VB-style property editor).
401<li><a href="../../contrib/deprecated/samples/treelay">treelay</a>: an algorithm for displaying tree hierarchies.
402</ul>
403
404
405<P>
406
407<table width=100% border=0 cellpadding=3 cellspacing=0>
408<tr>
409<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
410<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
411<b><a name="demos">Demos</a></b>
412</font>
413</td>
414</tr>
415</table>
416
417<P>
418
419The following are fully-fledged applications.<P>
420
421<ul>
422<li><a href="../../demos/bombs">bombs</a>: minesweeper-like game.
423<li><a href="../../demos/dbbrowse">dbbrowse</a>: ODBC database browser application.
424<li><a href="../../demos/forty">forty</a>: a great little card game by Chris Breeze.
425<li><a href="../../demos/fractal">fractal</a>: fractal mountains by Andrew Davison.
426<li><a href="../../demos/life">life</a>: the game of Life by J. H. Conway, implemented in wxWidgets by Guillermo Rodriguez Garcia.
427<li><a href="../../demos/poem">poem</a>: a little poetry display program.
428</ul>
429
430</font>
431
432</BODY>
433
434</HTML>
435
wxWidgets (Impactor)