]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/html/index.htm
yet another variation on the same theme: wxMAKE_ART_ID_FROM_STR
[wxWidgets.git] / docs / html / index.htm
index be7235836167b60ed4b10cf3a2f43b43040d20fb..808bfe3bb28331ea85840f6749189a2c77f8926f 100644 (file)
@@ -5,52 +5,70 @@
 
 </HEAD>
 
-<!BODY BGCOLOR="#FFFFFF" TEXT=#000000 LINK=#FF0000 VLINK=#000000>
-<BODY BGCOLOR="#CCDDDFF" TEXT=#000000 LINK=#FF0000 VLINK=#000000>
+<BODY BGCOLOR=#FFFFFF TEXT=#000000 VLINK="#63659C" LINK="#313063" ALINK="#313063">
 
 <font face="Arial, Lucida Sans, Helvetica">
 
 <a name="top"></a>
 
-<table width=100% border=4 cellpadding=5 cellspacing=0>
-<tr>
-<td bgcolor="#660000">
-<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
-<IMG src="logo.gif" align=right>
-<!-- wxWindows Documentation -->
-</font>
-</td>
-</tr>
-</table>
+<IMG src="logo.gif" align=right hspace=10 vspace=0>
 
-<P>
+<b>Welcome to wxWindows 2, the premi&egrave;re cross-platform GUI C++ framework.</b><P>
 
-Welcome to wxWindows 2, the premi&egrave;re cross-platform GUI C++ framework. This is an index of
+This is an index of
 the plain text, HTML, Windows Help and Acrobat documentation: availability depends on what you've
-downloaded from the <a href="http://www.wxwindows.org">wxWindows Web site</a>.<P>
+downloaded from the <a href="http://www.wxwindows.org">wxWindows Web site</a>.<br clear=all><P>
 
 <CENTER>
 <FONT size=-1>
 [<a href="#install">Install</a>]
 [<a href="#manuals">Manuals</a>]
+[<a href="#technotes">Technical Notes</a>]
 [<a href="#thirdparty">3rd party tools</a>] 
 [<a href="#samples">Samples</a>]
+[<a href="#demos">Demos</a>]
 </FONT>
 </CENTER>
 
-<h3 align=center><a name="install"><hr>Installation and release notes<hr></a></h3>
+<P>
+
+<table width=100% border=0 cellpadding=3 cellspacing=0>
+<tr>
+<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
+<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
+<b><a name="install">Installation and release notes</a></b>
+</font>
+</td>
+</tr>
+</table>
+
+<P>
+
+Unless you installed a binary version of wxWindows using RPMs,
+you will probably have to compile the wxWindows library first.
+Please read the platform-specific readme.txt and install.txt
+for how to do this.
+
+<P>
 
 <ul>
 <li>ReadMe: <a href="../readme.txt"><b>General ReadMe</b></a>,
 <a href="../gtk/readme.txt">wxGTK</a>,
 <a href="../motif/readme.txt">wxMotif</a>,
-<a href="../msw/readme.txt">wxMSW</a>
-<li><a href="../release.txt"><b>Release notes</b></a>
+<a href="../x11/readme.txt">wxX11</a>,
+<a href="../x11/readme-nanox.txt">wxNanoX</a>,
+<a href="../msw/readme.txt">wxMSW</a>,
+<a href="../mac/readme.txt">wxMac</a>,
+<a href="../mgl/readme.txt">wxMGL</a>,
+<a href="../univ/readme.txt">Univ</a>
 <li>Installation: <a href="../gtk/install.txt">wxGTK</a>,
 <a href="../motif/install.txt">wxMotif</a>,
-<a href="../msw/install.txt">wxMSW</a>
-<li><a href="../changes.txt"><b>Change log</b></a>
-<li><a href="../bugs.txt"><b>Buglist</b></a>
+<a href="../x11/install.txt">wxX11</a>,
+<a href="../msw/install.txt">wxMSW</a>,
+<a href="../mac/install.txt">wxMac</a>,
+<a href="../mgl/install.txt">wxMGL</a>,
+<a href="../os2/install.txt">wxOS2</a>
+<li><a href="../changes.txt"><b>General change log</b></a>, <a href="../gtk/changes.txt">wxGTK change log</a>
 <li>Licence: <a href="../preamble.txt">Preamble</a>,
 <a href="../licence.txt">Licence</a>,
 <a href="../licendoc.txt">Documentation Licence</a>,
@@ -59,133 +77,242 @@ downloaded from the <a href="http://www.wxwindows.org">wxWindows Web site</a>.<P
 <li><a href="faq.htm"><B>FAQ</B></a>:
   <ul>
   <li><a href="faqgen.htm">General questions</a>
-  <li><a href="faqgtk.htm">wxWindows 2 for GTK</a>
+  <li><a href="faqgtk.htm">wxWindows 2 for GTK+</a>
   <li><a href="faqmsw.htm">wxWindows 2 for Windows</a>
   <li><a href="faqmot.htm">wxWindows 2 for Motif</a>
+  <li><a href="faqx11.htm">wxWindows 2 for X11</a>
   <li><a href="faqmac.htm">wxWindows 2 for Mac</a>
   </ul>
 <li>ToDo: <a href="../todo.txt"><b>General ToDo</b></a>,
 <a href="../gtk/todo.txt">wxGTK</a>,
 <a href="../motif/todo.txt">wxMotif</a>,
-<a href="../msw/todo.txt">wxMSW</a>
+<a href="../msw/todo.txt">wxMSW</a>,
+<a href="../mac/todo.txt">wxMac</a>
 <li>List of <a href="../symbols.txt">preprocessor symbols</a> used in wxWindows
 </ul>
 
-<h3 align=center><a name="manuals"><hr>wxWindows manuals<hr></a></h3>
+Further platform-specific notes:
 
-<table border=1 align=center>
+<ul>
+<li> wxMSW: <a href="../msw/winxp.txt">Windows XP</a>
+</ul>
 
+<P>
+
+<table width=100% border=0 cellpadding=3 cellspacing=0>
 <tr>
-<td align=center bgcolor="#FFFF00">
+<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
+<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
+<b><a name="manuals">wxWindows manuals</a></b>
+</font>
+</td>
+</tr>
+</table>
+
+<P>
+
+To use manuals in wxHTML Help form (extension htb), you can use the <b>HelpView</b>
+application, either compiling it from utils/helpview in the distribution,
+or downloading a binary, for example from <a href="http://www.storylinescentral.com/helpview.htm">here</a>.<P>
+
+See also the <a href="../pdf/wxTutorial.pdf">wxWindows Tutorial</a>
+by Franky Braem, in PDF format.<P>
+
+<P>
+
+<table border=0 cellpadding=5 cellspacing=0>
+
+<tr>
+<td align=center bgcolor="#E0E0E0">
 <B>HTML</B>
 </td>
-<td align=center bgcolor="#FFFF00">
+<td align=center bgcolor="#E0E0E0">
 <B>WinHelp</B>
 </td>
-<td align=center bgcolor="#FFFF00">
+<td align=center bgcolor="#E0E0E0">
+<B>MS HTML Help</B>
+</td>
+<td align=center bgcolor="#E0E0E0">
+<B>wxHTML Help</B>
+</td>
+<td align=center bgcolor="#E0E0E0">
 <B>PDF</B>
 </td>
 </tr>
 
 <tr>
 <td align=center>
-<a href="wx/wx.htm">Reference Manual</a>
+<a href="wx/wx.htm">wxWindows Reference</a>
 </td>
 
 <td align=center>
-<a href="../winhelp/wx.hlp">Reference Manual</a>
+<a href="../winhelp/wx.hlp">wxWindows Reference</a>
 </td>
 
 <td align=center>
-<a href="../pdf/wx.pdf">Reference Manual</a>
+<a href="../htmlhelp/wx.chm">wxWindows Reference</a>
 </td>
-</tr>
 
-<tr>
 <td align=center>
-<a href="porting/port.htm">Porting Guide</a>
+<a href="../htb/wx.htb">wxWindows Reference</a>
 </td>
 
 <td align=center>
-<a href="../winhelp/porting.hlp">Porting Guide</a>
+<a href="../pdf/wx.pdf">wxWindows Reference</a>
 </td>
+</tr>
 
+<tr>
 <td align=center>
-<a href="../pdf/porting.pdf">Porting Guide</a>
+<a href="dialoged/dlged.htm">Dialog Editor</a>
+</td>
+
+<td align=center>
+<a href="../winhelp/dialoged.hlp">Dialog Editor</a>
 </td>
-</tr>
 
-<tr>
 <td align=center>
-<a href="dialoged/dlged.htm">Dialog Editor Manual</a>
+<a href="../htmlhelp/dialoged.chm">Dialog Editor</a>
 </td>
 
 <td align=center>
-<a href="../winhelp/dialoged.hlp">Dialog Editor Manual</a>
+<a href="../htb/dialoged.htb">Dialog Editor</a>
 </td>
 
 <td align=center>
-<a href="../pdf/dialoged.pdf">Dialog Editor Manual</a>
+<a href="../pdf/dialoged.pdf">Dialog Editor</a>
 </td>
 </tr>
 
 <tr>
 <td align=center>
-<a href="proplist/prop.htm">Property List Classes</a>
+<a href="tex2rtf/t2rtf.htm">Tex2RTF</a>
+</td>
+
+<td align=center>
+<a href="../winhelp/tex2rtf.hlp">Tex2RTF</a>
 </td>
 
 <td align=center>
-<a href="../winhelp/proplist.hlp">Property List Classes</a>
+<a href="../htmlhelp/tex2rtf.chm">Tex2RTF</a>
 </td>
 
 <td align=center>
-<a href="../pdf/proplist.pdf">Property List Classes</a>
+<a href="../htb/tex2rtf.htb">Tex2RTF</a>
+</td>
+
+<td align=center>
+<a href="../pdf/tex2rtf.pdf">Tex2RTF</a>
 </td>
 </tr>
 
 <tr>
 <td align=center>
-<a href="wxtree/tree.htm">wxTreeLayout Class</a>
+<a href="fl/fl.htm">FL Library</a>
+</td>
+
+<td align=center>
+<a href="../winhelp/fl.hlp">FL Library</a>
+
 </td>
 
 <td align=center>
-<a href="../winhelp/wxtree.hlp">wxTreeLayout Class</a>
+<a href="../htmlhelp/fl.chm">FL Library</a>
 </td>
 
 <td align=center>
-<a href="../pdf/wxtree.pdf">wxTreeLayout Class</a>
+<a href="../htb/fl.htb">FL Library</a>
+</td>
+
+<td align=center>
+<a href="../pdf/fl.pdf">FL Library</a>
 </td>
 </tr>
 
 <tr>
 <td align=center>
-<a href="odbc/odbc.htm">Remstar ODBC Classes</a>
+<a href="ogl/ogl.htm">OGL Library</a>
+</td>
+
+<td align=center>
+<a href="../winhelp/ogl.hlp">OGL Library</a>
+
 </td>
 
 <td align=center>
-<BR><BR>
+<a href="../htmlhelp/ogl.chm">OGL Library</a>
 </td>
 
 <td align=center>
-<a href="../pdf/odbc.pdf">Remstar ODBC Classes</a>
+<a href="../htb/ogl.htb">OGL Library</a>
+</td>
+
+<td align=center>
+<a href="../pdf/ogl.pdf">OGL Library</a>
 </td>
 </tr>
 
 </table>
 
+<P>
+
+<table width=100% border=0 cellpadding=3 cellspacing=0>
+<tr>
+<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
+<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
+<b><a name="technotes">Technical notes</a></b>
+</font>
+</td>
+</tr>
+</table>
+
+<P>
+
+<ul>
+<li><a href="../tech/index.txt">Index of technical notes</a>
+<li><a href="../tech/">Technical notes</a>
+<li><a href="platform.htm">Platforms supported</a>
+<li><a href="i18n.htm">Languages supported by wxWindows</a>
+</ul>
+
+<P>
+
+<table width=100% border=0 cellpadding=3 cellspacing=0>
+<tr>
+<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
+<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
+<b><a name="thirdparty">Thirty-party tools</a></b>
+</font>
+</td>
+</tr>
+</table>
 
-<h3 align=center><a name="thirdparty"><hr>Third-party tools<hr></a></h3>
+<P>
 
 <ul>
-<li><a href="gettext/gettext.htm">gettext Manual</a>
-<li><a href="gettext/xgettext.htm">xgettext Manual</a>
-<li><a href="gettext/msgfmt.htm">msgfmt Manual</a>
+<li><a href="gettext/index.html">gettext Manual</a>
 </ul>
 
-<h3 align=center><a name="samples"><hr>Samples<hr></a></h3>
+<P>
+
+<table width=100% border=0 cellpadding=3 cellspacing=0>
+<tr>
+<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
+<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
+<b><a name="samples">Samples</a></b>
+</font>
+</td>
+</tr>
+</table>
+
+<P>
+
+Each of the following samples demonstrates one or more aspect of wxWindows.<P>
 
 <ul>
-<li><a href="../../samples/bombs">bombs</a>: minesweeper-like game.
+<li><a href="../../samples/calendar">artprov</a>: shows how you can customize the look of standard
+wxWindows dialogs by replacing default bitmaps/icons with your own versions.
+<li><a href="../../samples/calendar">calendar</a>: a sample to test the wxCalendarCtrl class.
 <li><a href="../../samples/caret">caret</a>: a sample to test the wxCaret class.
 <li><a href="../../samples/checklst">checklst</a>: demonstrates wxCheckListBox on
 supported platforms (currently Windows and GTK only).
@@ -196,32 +323,35 @@ console-mode (no-GUI) compilation of wxWindows.
 <li><a href="../../samples/controls">controls</a>: sample showing a variety of controls, including
 wxNotebook.
 <li><a href="../../samples/db">db</a>: wxDB ODBC sample.
-<li><a href="../../samples/dde">dde</a>: shows the DDE protocol in action, both using real
-DDE on Windows, and TCP/IP on all platforms. Edit <a href="../../samples/dde/ddesetup.h">ddesetup.h</a>
-to switch between compilation modes. Currently the TCP/IP mode needs a bit of work.
+<li><a href="../../samples/ipc">ipc</a>: shows the DDE-like protocol in action, both using real
+DDE on Windows, and TCP/IP on all platforms. Edit <a href="../../samples/ipc/ddesetup.h">ddesetup.h</a>
+to switch between compilation modes.
 <li><a href="../../samples/dialogs">dialogs</a>: shows some of the common dialogs available -- wxFontDialog,
 wxColourDialog, wxFileDialog, wxDirDialog, wxMessageBox, wxTextEntryDialog, wxSingleChoiceDialog.
 For printing-related dialogs, see the printing sample.
+<li><a href="../../samples/dragimag">dragimag</a>: wxDragImage demo.
+<li><a href="../../samples/dialup">dialup</a>: wxDialUpManager demo.
 <li><a href="../../samples/dnd">dnd</a>: demonstrates drag and drop on supported platforms.
 <li><a href="../../samples/docview">docview</a>: demonstrates use of the document view classes,
 using wxFrame.
-<li><a href="../../samples/docvwmdi">docvwmdi</a>: demonstrates use of the document view classes,
+<li><a href="../../samples/docvwmdi">docvwmdi</a>: demonstrates use of the document view classes,
 using wxMDIParentFrame, wxMDIChildFrame.
 <li><a href="../../samples/drawing">drawing</a>: tests device context drawing.
 <li><a href="../../samples/dynamic">dynamic</a>: shows how to connect events to member functions
 dynamically.
-<li><a href="../../samples/forty">forty</a>: a great little card game by Chris Breeze. A
-fully-fledged application!
+<li><a href="../../samples/event">event</a>: demonstrates event handling.
+<li><a href="../../samples/exec">exec</a>: demonstrates wxExecute.
 <li><a href="../../samples/font">font</a>: tests fonts, font enumerator, font encodings.
-<li><a href="../../samples/fractal">fractal</a>: fractal mountains by Andrew Davison.
-<li><a href="../../samples/grid">grid</a>: demonstrates the wxGrid class.
+<li><a href="../../samples/grid">grid</a>: demonstrates the wxGrid class. This demo should work
+when the old grid implementation is compiled into wxWindows, and also with the new implementation.
+Please see newgrid below for a full demo of the new implementation's capabilities.
 <li><a href="../../samples/help">help</a>: shows how to use wxHelpController.
 <li><a href="../../samples/html">html</a>: a number of demos for the wxHTML class library, used inside
 applications and also as a help facility.
   <ul>
   <li><a href="../../samples/html/about">about</a>: shows use of a wxHTML widget inside an About box.
   <li><a href="../../samples/html/help">help</a>: shows use of wxHtmlHelpController to display wxHTML help.
-  <li><a href="../../samples/html/helpview">helpview</a>: a stand-alone wxHTML help viewer.
+  <li><a href="../../samples/html/helpview">helpview</a>: a stand-alone wxHTML help viewer for any .htb book.
   <li><a href="../../samples/html/printing">printing</a>: shows how easy it is to preview and print HTML files.
   <li><a href="../../samples/html/test">test</a>: general wxHTML test application.
   <li><a href="../../samples/html/virtual">virtual</a>: demonstrates the virtual file system feature.
@@ -231,6 +361,7 @@ applications and also as a help facility.
 <li><a href="../../samples/image">image</a>: shows off the cross-platform wxImage class.
 <li><a href="../../samples/internat">internat</a>: use of wxWindows' internationalization support.
 <li><a href="../../samples/joytest">joytest</a>: tests the wxJoystick class (currently Windows and GTK only).
+<li><a href="../../samples/keyboard">keyboard</a>: tests keyboard support.
 <li><a href="../../samples/layout">layout</a>: shows the constraint layout system in action.
 <li><a href="../../samples/listctrl">listctrl</a>: demonstrates the wxListCtrl (implemented natively on
 WIN32, and using a generic version on other platforms).
@@ -245,10 +376,10 @@ To compile this, you must edit include/wx/wxprec.h, comment out the windows.h in
 platforms that don't support it, a normal-sized title bar is displayed.
 <li><a href="../../samples/minimal">minimal</a>: just shows a frame, a menubar, and a statusbar. About as
 small a wxWindows application as you can get.
+<li><a href="../../samples/mobile">mobile</a>: mini applications for embedded platforms.
 <li><a href="../../samples/nativdlg">nativdlg</a>: shows how wxWindows can load a standard Windows
 dialog resource, translating the controls into wxWindows controls (Windows only).
-<li><a href="../../samples/nettest">nettest</a>: wxDialUpManager demo.
-<li><a href="../../samples/newgrid">newgrid</a>: demonstrates the new wxGrid implementation, by Michael Bedward.
+<li><a href="../../samples/newgrid">newgrid</a>: demonstrates the new wxGrid implementation, by Michael Bedward and others.
 <li><a href="../../samples/notebook">notebook</a>: shows the wxNotebook (tabbed window) control.
 <li><a href="../../samples/oleauto">oleauto</a>: a little OLE automation controller (Windows only; requires
 Excel to be present).
@@ -256,19 +387,22 @@ Excel to be present).
 <li><a href="../../samples/png">png</a>: demonstrates PNG loading.
 <li><a href="../../samples/printing">printing</a>: shows printing and previewing.
 <li><a href="../../samples/proplist">proplist</a>: demonstrates the property list classes (a VB-style property editor).
+<li><a href="../../samples/propsize">propsize</a>: demonstrates proportional sizer classes.
 <li><a href="../../samples/regtest">regtest</a>: tests the low-level Windows registry functions (Windows only).
 <li><a href="../../samples/resource">resource</a>: shows how to use wxWindows resources (.wxr files).
-<li><a href="../../samples/richedit">richedit</a>: a work-in-progress rich text editor with plain text and HTML export
+<!-- <li><a href="../../samples/richedit">richedit</a>: a work-in-progress rich text editor with plain text and HTML export
 facilities.
+-->
+<li><a href="../../samples/rotate">rotate</a>: demonstrates interpolated and non-interpolated
+rotation of a wxImage.
 <li><a href="../../samples/sashtest">sashtest</a>: demonstrates use of the wxSashWindow class to allow
 the user to resize subwindows.
 <li><a href="../../samples/scroll">scroll</a>: demonstrates wxScrolledWindow.
 <li><a href="../../samples/scrollsub">scrollsub</a>: demonstrates the use of wxScrolledWindow to scroll
 an embedded window.
+<li><a href="../../samples/sockets">sockets</a>: demonstrates the TCP/IP family of classes.
 <li><a href="../../samples/splitter">splitter</a>: demonstrates the wxSplitterWindow class.
-<li><a href="../../samples/tab">tab</a>: demonstrates the generic tab window class. You should
-normally use wxNotebook instead, but the generic code is sometimes useful, for example for
-implementing wxNotebook on platforms with no native support.
+<li><a href="../../samples/statbar">statbar</a>: demonstrates the wxStatusBar class.
 <li><a href="../../samples/taskbar">taskbar</a>: demonstrates the wxTaskBarIcon class, for
 adding icons to the system tray. Windows only, but may eventually be implemented for other desktop
 environments that use this metaphor.
@@ -282,11 +416,32 @@ programming.
 wxTime, wxDate and wxVariant.
 <li><a href="../../samples/validate">validate</a>: shows simple use of validation.
 <li><a href="../../samples/wizard">wizard</a>: demonstrates the wxWizard class.
-<li><a href="../../samples/wxpoem">wxpoem</a>: a little poetry display program.
-<li><a href="../../samples/wxsocket">wxsocket</a>: demonstrates the TCP/IP family of classes.
 </ul>
 
-<hr>
+<P>
+
+<table width=100% border=0 cellpadding=3 cellspacing=0>
+<tr>
+<td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
+<font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
+<b><a name="demos">Demos</a></b>
+</font>
+</td>
+</tr>
+</table>
+
+<P>
+
+The following are fully-fledged applications.<P>
+
+<ul>
+<li><a href="../../demos/bombs">bombs</a>: minesweeper-like game.
+<li><a href="../../demos/dbbrowse">dbbrowse</a>: ODBC database browser application.
+<li><a href="../../demos/forty">forty</a>: a great little card game by Chris Breeze.
+<li><a href="../../demos/fractal">fractal</a>: fractal mountains by Andrew Davison.
+<li><a href="../../demos/life">life</a>: the game of Life by J. H. Conway, implemented in wxWindows by Guillermo Rodriguez Garcia.
+<li><a href="../../demos/poem">poem</a>: a little poetry display program.
+</ul>
 
 </font>