]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/html/index.htm
Tools
[wxWidgets.git] / docs / html / index.htm
index 493a111e022bc66a2bc4506ea23680699ab7e1d7..83f5405e6d29a1a9a3b1b094ab5dd67ee1c8a1ab 100644 (file)
@@ -5,41 +5,30 @@
 
 </HEAD>
 
-<BODY BGCOLOR="#FFFFFF" 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=left hspace=10 vspace=0>
 
-<P>
-
-Welcome to wxWindows 2, the premiere cross-platform GUI C++ framework. This is an index of
-the plain text and HTML documentation. Documentation is also available in Acrobat (PDF) and Windows Help,
-from the <a href="http://www.wxwindows.org">wxWindows Web site</a>.<P>
+Welcome to wxWindows 2, the premi&egrave;re cross-platform GUI C++ framework. 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>
 
 <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>
 
-<hr>
-
-<h3><a name="install">Installation and release notes</a></h3>
+<h3 align=center><a name="install"><hr>Installation and release notes<hr></a></h3>
 
 <ul>
 <li>ReadMe: <a href="../readme.txt"><b>General ReadMe</b></a>,
@@ -71,78 +60,190 @@ from the <a href="http://www.wxwindows.org">wxWindows Web site</a>.<P>
 <li>List of <a href="../symbols.txt">preprocessor symbols</a> used in wxWindows
 </ul>
 
-<hr>
+<h3 align=center><a name="manuals"><hr>wxWindows manuals<hr></a></h3>
+
+<table border=1 align=center>
+
+<tr>
+<td align=center bgcolor="#C4ECF9">
+<B>HTML</B>
+</td>
+<td align=center bgcolor="#C4ECF9">
+<B>WinHelp</B>
+</td>
+<td align=center bgcolor="#C4ECF9">
+<B>MS HTML Help</B>
+</td>
+<td align=center bgcolor="#C4ECF9">
+<B>PDF</B>
+</td>
+</tr>
+
+<tr>
+<td align=center>
+<a href="wx/wx.htm">Reference Manual</a>
+</td>
+
+<td align=center>
+<a href="../winhelp/wx.hlp">Reference Manual</a>
+</td>
+
+<td align=center>
+<a href="../htmlhelp/wx.chm">Reference Manual</a>
+</td>
+
+<td align=center>
+<a href="../pdf/wx.pdf">Reference Manual</a>
+</td>
+</tr>
+
+<tr>
+<td align=center>
+<a href="dialoged/dlged.htm">Dialog Editor Manual</a>
+</td>
+
+<td align=center>
+<a href="../winhelp/dialoged.hlp">Dialog Editor Manual</a>
+</td>
+
+<td align=center>
+<a href="../htmlhelp/dialoged.chm">Dialog Editor Manual</a>
+</td>
+
+<td align=center>
+<a href="../pdf/dialoged.pdf">Dialog Editor Manual</a>
+</td>
+</tr>
+
+<tr>
+<td align=center>
+<a href="tex2rtf/t2rtf.htm">Tex2RTF Manual</a>
+</td>
+
+<td align=center>
+<a href="../winhelp/tex2rtf.hlp">Tex2RTF Manual</a>
+</td>
+
+<td align=center>
+<a href="../htmlhelp/tex2rtf.chm">Tex2RTF Manual</a>
+</td>
 
+<td align=center>
+<a href="../pdf/tex2rtf.pdf">Tex2RTF Manual</a>
+</td>
+</tr>
 
-<h3><a name="manuals">wxWindows manuals</a></h3>
+<tr>
+<td align=center>
+<a href="odbc/odbc.htm">Remstar ODBC Classes</a>
+</td>
+
+<td align=center>
+<BR><BR>
+</td>
+
+<td align=center>
+<BR><BR>
+</td>
+
+<td align=center>
+<a href="../pdf/odbc.pdf">Remstar ODBC Classes</a>
+</td>
+</tr>
+
+</table>
+
+<h3 align=center><a name="technotes"><hr>Technical notes<hr></a></h3>
 
 <ul>
-<li><a href="wx/wx.htm">Reference Manual</a>
-<li><a href="porting/port.htm">Porting Guide</a> (wxWindows 1.xx to 2)
-<li><a href="dialoged/dlged.htm">Dialog Editor</a>
-<li><a href="proplist/prop.htm">Property List Classes</a>
-<li><a href="wxtree/tree.htm">wxTreeLayout</a>
-<li><a href="odbc/odbc.htm">Remstar ODBC Classes</a>
+<li><a href="../tech/index.txt">Index of technical notes</a>
+<li><a href="../tech/">Technical notes</a> in text form
+<li>Other documents:
+  <ul>
+  <li><a href="platform.htm">Platforms supported</a>
+  <li><a href="i18n.htm">Languages supported by wxWindows</a>
+  <li><a href="standard.htm">wxWindows programmer style guide</a>
+  <li><a href="news.htm">wxWindows news</a>
+  </ul>
 </ul>
 
-<hr>
-
-<h3><a name="thirdparty">Third-party tools</a></h3>
+<h3 align=center><a name="thirdparty"><hr>Third-party tools<hr></a></h3>
 
 <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>
 
-<hr>
+<h3 align=center><a name="samples"><hr>Samples<hr></a></h3>
 
-<h3><a name="samples">Samples</a></h3>
+Each of the following demonstrates one or more aspect of wxWindows.<P>
 
 <ul>
-<li><a href="../../samples/bombs">bombs</a>: minesweeper-like game.
+<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).
 <li><a href="../../samples/config">config</a>: demonstrates use of wxConfig, which
 defaults to wxRegConfig on WIN32, wxIniConfig on WIN16, and wxFileConfig on other platforms.
+<li><a href="../../samples/console">console</a>: demonstrates a console application using
+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/fractal">fractal</a>: fractal mountains by Andrew Davison.
-<li><a href="../../samples/grid">grid</a>: demonstrates the wxGrid class.
+<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/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 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.
+  <li><a href="../../samples/html/widget">widget</a>: demonstrates the use of controls in HTML pages.
+  <li><a href="../../samples/html/zip">zip</a>: shows how help files can be packaged in zip archives.
+  </ul>
 <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/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).
+<li><a href="../../samples/menu">menu</a>: tests menus.
 <li><a href="../../samples/mdi">mdi</a>: shows off the MDI (Multiple Document Interface) classes. On Windows, the regular MDI
 scheme is used whereby child windows have full sizing and moving rights within the main
 window. On other platforms, tabbed windows are used, where the children are always maximized.
 <li><a href="../../samples/memcheck">memcheck</a>: demonstrates the memory checking/debugging facilities.
 <li><a href="../../samples/mfc">mfc</a>: shows how to use MFC and wxWindows code in the same application (Windows only).
+To compile this, you must edit include/wx/wxprec.h, comment out the windows.h inclusion, and recompile wxWindows.
 <li><a href="../../samples/minifram">minifram</a>: demonstrates a frame with a small title bar. On
 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/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/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).
@@ -150,17 +251,26 @@ 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
+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.
+<li><a href="../../samples/text">text</a>: demonstrates single and multiline text controls,
+and clipboard operations.
 <li><a href="../../samples/thread">thread</a>: tests the family of classes for doing thread
 programming.
 <li><a href="../../samples/toolbar">toolbar</a>: demonstrates wxToolBar.
@@ -168,8 +278,20 @@ programming.
 <li><a href="../../samples/typetest">typetest</a>: tests various data type classes, including
 wxTime, wxDate and wxVariant.
 <li><a href="../../samples/validate">validate</a>: shows simple use of validation.
-<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.
+<li><a href="../../samples/wizard">wizard</a>: demonstrates the wxWizard class.
+</ul>
+
+<h3 align=center><a name="demos"><hr>Demos<hr></a></h3>
+
+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>
 
 <hr>