2016-03-03 16:17:22 -05:00
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
1999-01-27 05:01:14 -05:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
<!--
|
|
|
|
|
Name: index.htm
|
|
|
|
|
Purpose: Gateway to wxWidgets Documentation and Resources
|
|
|
|
|
Author: wxWidgets team
|
2010-07-13 09:29:13 -04:00
|
|
|
Licence: wxWindows licence
|
2008-05-08 15:42:25 -04:00
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<title>wxWidgets Documentation</title>
|
|
|
|
|
<style type="text/css">
|
2008-03-29 20:55:17 -04:00
|
|
|
<!--
|
2008-05-08 15:42:25 -04:00
|
|
|
body { font-family: sans-serif; }
|
|
|
|
|
h1 { font-size: 140%; }
|
|
|
|
|
li { line-height: 150%; }
|
2008-03-29 20:55:17 -04:00
|
|
|
-->
|
2008-05-08 15:42:25 -04:00
|
|
|
</style>
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<a name="top"/>
|
|
|
|
|
|
|
|
|
|
<p><center>
|
|
|
|
|
<img src="doxygen/images/main_wxlogo.png" alt="wxWidgets: Cross-Platform GUI Toolkit" />
|
|
|
|
|
</center></p>
|
|
|
|
|
|
|
|
|
|
<!-- INSTALLATION AND RELEASE NOTES -->
|
|
|
|
|
|
|
|
|
|
<h1>Installation and Release Notes</h1>
|
|
|
|
|
|
|
|
|
|
<p>Unless you installed a binary version of wxWidgets (e.g. under Linux
|
|
|
|
|
using your distro's package manager), you will probably have to
|
|
|
|
|
<strong>compile</strong> the wxWidgets library before you can start use
|
|
|
|
|
it.</p>
|
|
|
|
|
<p>Please read the platform-specific <tt>readme.txt</tt> and
|
|
|
|
|
<tt>install.txt</tt> for how to do this:</p>
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Readme:
|
|
|
|
|
<a href="readme.txt"><b>General ReadMe</b></a>,
|
|
|
|
|
<a href="msw/readme.txt">wxMSW</a> (<a href="msw/winxp.txt">wxMSW for WinXP</a>),
|
|
|
|
|
<a href="gtk/readme.txt">wxGTK</a>,
|
2016-02-04 10:58:20 -05:00
|
|
|
<a href="osx/readme.txt">wxOSX</a>,
|
2008-05-08 15:42:25 -04:00
|
|
|
<a href="motif/readme.txt">wxMotif</a>,
|
2014-08-23 21:50:11 -04:00
|
|
|
<a href="qt/readme.txt">wxQt</a>
|
2008-05-08 15:42:25 -04:00
|
|
|
<a href="x11/readme.txt">wxX11</a>,
|
2016-02-11 05:51:55 -05:00
|
|
|
<a href="univ/readme.txt">Univ</a>,
|
|
|
|
|
<a href="ios/readme.txt">wxiOS</a>
|
2008-03-29 20:55:17 -04:00
|
|
|
</li>
|
|
|
|
|
<li>Installation:
|
2018-12-10 12:59:03 -05:00
|
|
|
<a href="msw/install.md">wxMSW</a>,
|
|
|
|
|
<a href="gtk/install.md">wxGTK</a>,
|
|
|
|
|
<a href="motif/install.md">wxMotif</a>,
|
|
|
|
|
<a href="x11/install.md">wxX11</a>,
|
|
|
|
|
<a href="osx/install.md">wxOSX</a>,
|
|
|
|
|
<a href="qt/install.md">wxQt</a>,
|
2008-03-29 20:55:17 -04:00
|
|
|
</li>
|
2008-05-08 15:42:25 -04:00
|
|
|
<li><a href="changes.txt"><b>General change log</b></a></li>
|
2008-03-29 20:55:17 -04:00
|
|
|
<li>Licence:
|
2008-05-08 15:42:25 -04:00
|
|
|
<a href="preamble.txt">Preamble</a>,
|
|
|
|
|
<a href="licence.txt">Licence</a>,
|
|
|
|
|
<a href="licendoc.txt">Documentation Licence</a>,
|
|
|
|
|
<a href="lgpl.txt">L-GPL</a>,
|
|
|
|
|
<a href="gpl.txt">GPL</a>
|
2008-03-29 20:55:17 -04:00
|
|
|
</li>
|
2008-05-08 15:42:25 -04:00
|
|
|
</ul>
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
<!-- FIXME: FAQs are very out-of-date; should be moved in the wx docs or
|
|
|
|
|
to the website or to the wiki...
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
<li><a href="faq.htm"><b>FAQ</b></a>:</font>
|
2008-03-29 20:55:17 -04:00
|
|
|
<ul>
|
2008-05-08 15:42:25 -04:00
|
|
|
<li><a href="faqgen.htm">General questions</a></font></li>
|
|
|
|
|
<li><a href="faqcmn.htm">Questions common to all platforms</a></font></li>
|
|
|
|
|
<li><a href="faqmsw.htm">wxWidgets for Windows</a></font></li>
|
|
|
|
|
<li><a href="faqgtk.htm">wxWidgets for GTK+</a></font></li>
|
|
|
|
|
<li><a href="faqmot.htm">wxWidgets for Motif</a></font></li>
|
|
|
|
|
<li><a href="faqx11.htm">wxWidgets for X11</a></font></li>
|
|
|
|
|
<li><a href="faqmac.htm">wxWidgets for Mac</a></font></li>
|
2008-03-29 20:55:17 -04:00
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
-->
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
<!-- DOCUMENTATION -->
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
<h1>Documentation</h1>
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
<p>The wxWidgets manual is available in various formats; the availability of
|
|
|
|
|
the following formats depends on what you've downloaded from the
|
2015-10-30 22:06:09 -04:00
|
|
|
<a href="https://www.wxwidgets.org">wxWidgets website</a>:</p>
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
<ul>
|
|
|
|
|
<li><a href="doxygen/out/html/index.html">HTML</a></li>
|
|
|
|
|
<li><a href="doxygen/out/wx.chm">MS HTML Help (CHM)</a></li>
|
|
|
|
|
<li><a href="doxygen/out/wx.htb">wxHTML Help (HTB)</a></li>
|
|
|
|
|
<li><a href="doxygen/out/rtf/refman.rtf">Rich Text Format (RTF)</a></li>
|
|
|
|
|
<li><a href="doxygen/out/wx.pdf">Portable Document Format (PDF)</a></li>
|
|
|
|
|
</ul>
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
<p>To use the manual in the <b>wxHTML Help</b> format (extension
|
|
|
|
|
<tt>htb</tt>), you can use the <b>HelpView</b> application, compiling it
|
|
|
|
|
from the <tt>utils/helpview</tt> folder in the wxWidgets
|
|
|
|
|
distribution.</p>
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
<p>Also note that beyond the wxWidgets manual there are various other
|
|
|
|
|
<strong>resources</strong> which can help to learn wxWidgets
|
|
|
|
|
programming:</p>
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
<ul>
|
2015-10-30 22:06:09 -04:00
|
|
|
<li><a href="https://www.wxwidgets.org">The wxWidgets website</a>: Contains
|
2008-05-08 15:42:25 -04:00
|
|
|
FAQs, tutorials, info about the mailing lists, and in general
|
|
|
|
|
everything related to the wxWidgets world is linked here.</li>
|
2015-10-30 22:06:09 -04:00
|
|
|
<li><a href="https://forums.wxwidgets.org/">The wxWidgets forum</a>:
|
2008-05-08 15:42:25 -04:00
|
|
|
Provides a discussion board about various wxWidgets topics (contains
|
|
|
|
|
also <em>localized</em> forums).</li>
|
2015-10-30 22:06:09 -04:00
|
|
|
<li><a href="https://wiki.wxwidgets.org/">The wxWiki</a>: A user-editable
|
2008-05-08 15:42:25 -04:00
|
|
|
website with lots of tutorials, links to external tools, resources,
|
|
|
|
|
etc.</li>
|
|
|
|
|
</ul>
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2015-02-23 19:53:00 -05:00
|
|
|
<!-- CONTRIBUTOR NOTES -->
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2015-02-23 19:53:00 -05:00
|
|
|
<h1>Contributor Notes</h1>
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2015-02-23 19:53:00 -05:00
|
|
|
<p>Contributor notes contain information useful only to wxWidgets developers
|
2020-07-13 11:38:47 -04:00
|
|
|
for the maintenance of the project:</p>
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
<ul>
|
2015-02-23 19:53:00 -05:00
|
|
|
<li><a href="contributing/">Index of Contributor Notes</a></li>
|
2008-05-08 15:42:25 -04:00
|
|
|
</ul>
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
<p>Todo List for wxWidgets:</p>
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
<ul>
|
2015-10-30 22:06:09 -04:00
|
|
|
<li><a href="https://wiki.wxwidgets.org/Development:_Todo_List">wxWiki Todo List</a></li>
|
2008-05-08 15:42:25 -04:00
|
|
|
<li><a href="doxygen/out/html/todo.html">Documentation Todo List</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<!-- DEMOS -->
|
|
|
|
|
|
|
|
|
|
<h1>Demos</h1>
|
|
|
|
|
|
|
|
|
|
<p>The following are fully-fledged applications which demonstrate some
|
|
|
|
|
features of wxWidgets (for a list of the 70+ samples please look at the
|
|
|
|
|
manual):</p>
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="../demos/bombs">bombs</a>: minesweeper-like game.</li>
|
|
|
|
|
<li><a href="../demos/forty">forty</a>: a great little card game by Chris Breeze.</li>
|
|
|
|
|
<li><a href="../demos/fractal">fractal</a>: fractal mountains by Andrew Davison.</li>
|
|
|
|
|
<li><a href="../demos/life">life</a>: the game of Life by J. H. Conway,
|
|
|
|
|
implemented in wxWidgets by Guillermo Rodriguez Garcia.</li>
|
|
|
|
|
<li><a href="../demos/poem">poem</a>: a little poetry display program.</li>
|
|
|
|
|
</ul>
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
</body>
|
2008-03-29 20:55:17 -04:00
|
|
|
|
2008-05-08 15:42:25 -04:00
|
|
|
<!-- kate: space-indent on; indent-width 2; indent-mode xml; -->
|
2008-03-29 20:55:17 -04:00
|
|
|
|
|
|
|
|
</html>
|
