<HTML>
<HEAD>
-<TITLE>wxWindows Documentation</TITLE>
+<TITLE>wxWidgets Documentation</TITLE>
</HEAD>
<IMG src="logo.gif" align=right hspace=10 vspace=0>
-<b>Welcome to wxWi
ndows 2, the première cross-platform GUI C++ framework.</b><P>
+<b>Welcome to wxWi
dgets, the première cross-platform GUI C++ framework.</b><P>
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.wxwi
ndows.org">wxWindows Web site</a>.<br clear=all><P>
+downloaded from the <a href="http://www.wxwi
dgets.org">wxWidgets 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>
<P>
-Unless you installed a binary version of wxWindows using RPMs,
-you will probably have to compile the wxWindows library first.
+Unless you installed a binary version of wxWidgets using RPMs,
+you will probably have to compile the wxWidgets library first.
Please read the platform-specific readme.txt and install.txt
for how to do this.
<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="../x11/readme.txt">wxX11</a>,
-<a href="../x11/readme-nanox.txt">wxNanoX</a>,
<a href="../msw/readme.txt">wxMSW</a>,
+<a href="../gtk/readme.txt">wxGTK</a>,
<a href="../mac/readme.txt">wxMac</a>,
+<a href="../cocoa/readme.txt">wxCocoa</a>,
<a href="../mgl/readme.txt">wxMGL</a>,
+<a href="../motif/readme.txt">wxMotif</a>,
+<a href="../x11/readme.txt">wxX11</a>,
<a href="../univ/readme.txt">Univ</a>
-<li>Installation: <a href="../gtk/install.txt">wxGTK</a>,
+<li>Installation:
+<a href="../msw/install.txt">wxMSW</a>,
+<a href="../gtk/install.txt">wxGTK</a>,
<a href="../motif/install.txt">wxMotif</a>,
<a href="../x11/install.txt">wxX11</a>,
-<a href="../msw/install.txt">wxMSW</a>,
<a href="../mac/install.txt">wxMac</a>,
+<a href="../cocoa/install.txt">wxCocoa</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><a href="../changes.txt"><b>General change log</b></a>
<li>Licence: <a href="../preamble.txt">Preamble</a>,
<a href="../licence.txt">Licence</a>,
<a href="../licendoc.txt">Documentation Licence</a>,
<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="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>
+ <li><a href="faqcmn.htm">Questions common to all platforms</a>
+ <li><a href="faqmsw.htm">wxWidgets for Windows</a>
+ <li><a href="faqgtk.htm">wxWidgets for GTK+</a>
+ <li><a href="faqmot.htm">wxWidgets for Motif</a>
+ <li><a href="faqx11.htm">wxWidgets for X11</a>
+ <li><a href="faqmac.htm">wxWidgets 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="../mac/todo.txt">wxMac</a>
-<li>List of <a href="../symbols.txt">preprocessor symbols</a> used in wxWindows
</ul>
Further platform-specific notes:
<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="manuals">wxWindows manuals</a></b>
+<b><a name="manuals">wxWidgets manuals</a></b>
</font>
</td>
</tr>
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>
<tr>
<td align=center>
-<a href="wx/wx.htm">wxWindows Reference</a>
-</td>
-
-<td align=center>
-<a href="../winhelp/wx.hlp">wxWindows Reference</a>
-</td>
-
-<td align=center>
-<a href="../htmlhelp/wx.chm">wxWindows Reference</a>
-</td>
-
-<td align=center>
-<a href="../htb/wx.htb">wxWindows Reference</a>
-</td>
-
-<td align=center>
-<a href="../pdf/wx.pdf">wxWindows Reference</a>
-</td>
-</tr>
-
-<tr>
-<td align=center>
-<a href="dialoged/dlged.htm">Dialog Editor</a>
+<a href="wx/wx_contents.html">wxWidgets Reference</a>
</td>
<td align=center>
-<a href="../winhelp/dialoged.hlp">Dialog Editor</a>
+<a href="../winhelp/wx.hlp">wxWidgets Reference</a>
</td>
<td align=center>
-<a href="../htmlhelp/dialoged.chm">Dialog Editor</a>
+<a href="../htmlhelp/wx.chm">wxWidgets Reference</a>
</td>
<td align=center>
-<a href="../htb/dialoged.htb">Dialog Editor</a>
+<a href="../htb/wx.htb">wxWidgets Reference</a>
</td>
<td align=center>
-<a href="../pdf/dialoged.pdf">Dialog Editor</a>
+<a href="../pdf/wx.pdf">wxWidgets Reference</a>
</td>
</tr>
</td>
</tr>
-<tr>
-<td align=center>
-<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="../htmlhelp/fl.chm">FL Library</a>
-</td>
-
-<td align=center>
-<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="ogl/ogl.htm">OGL Library</a>
-</td>
-
-<td align=center>
-<a href="../winhelp/ogl.hlp">OGL Library</a>
-
-</td>
-
-<td align=center>
-<a href="../htmlhelp/ogl.chm">OGL Library</a>
-</td>
-
-<td align=center>
-<a href="../htb/ogl.htb">OGL Library</a>
-</td>
-
-<td align=center>
-<a href="../pdf/ogl.pdf">OGL Library</a>
-</td>
-</tr>
-
</table>
<P>
<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>
-
-<P>
-
-<ul>
-<li><a href="gettext/index.html">gettext Manual</a>
+<li><a href="i18n.htm">Languages supported by wxWidgets</a>
</ul>
<P>
<P>
-Each of the following samples demonstrates one or more aspect of wxWi
ndows.<P>
+Each of the following samples demonstrates one or more aspect of wxWi
dgets.<P>
<ul>
-<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/access">access</a>: Active Accessiblity sample (Windows only).
+<li><a href="../../samples/animate">animate</a>: shows the wxAnimationCtrl class.
+<li><a href="../../samples/artprov">artprov</a>: shows how you can customize the look of standard
+wxWidgets dialogs by replacing default bitmaps/icons with your own versions.
+<li><a href="../../samples/aui">aui</a>: wxAui (docking subsystem) sample.
<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/collpane">collpane</a>: shows the wxCollapsiblePane class.
<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.
+defaults to wxRegConfig on WIN32 (optionally wxIniConfig), and wxFileConfig on other platforms.
<li><a href="../../samples/console">console</a>: demonstrates a console application using
-console-mode (no-GUI) compilation of wxWindows.
+console-mode (no-GUI) compilation of wxWidgets.
<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/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/db">db</a>: wxODBC sample.
+<li><a href="../../samples/debugrpt">debugrpt</a>: wxDebugReport sample.
<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/display">display</a>: wxDisplay 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,
using wxMDIParentFrame, wxMDIChildFrame.
+<li><a href="../../samples/dragimag">dragimag</a>: wxDragImage demo.
<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/editlbox">erase</a>: shows the wxEditableListBox class.
+<li><a href="../../samples/erase">erase</a>: Window erasing sample.
<li><a href="../../samples/event">event</a>: demonstrates event handling.
+<li><a href="../../samples/except">exept</a>: demonstrates exception 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.
<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/htlbox">htlbox</a>: demonstrates wxHtmlListBox.
<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/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/internat">internat</a>: use of wxWidgets' 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).
<li><a href="../../samples/menu">menu</a>: tests menus.
+<li><a href="../../samples/mediaplayer">mediaplayer</a>: demonstrates wxMediaCtrl, for playing movies and audio files in a window.
<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/mfc">mfc</a>: shows how to use MFC and wxWidgets 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 wxWidgets.
<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.
+small a wxWidgets 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/multimon">multimon</a>: demo showing how to use multiple monitors.
+<li><a href="../../samples/nativdlg">nativdlg</a>: shows how wxWidgets can load a standard Windows
+dialog resource, translating the controls into wxWidgets controls (Windows only).
<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).
<li><a href="../../samples/printing">printing</a>: shows printing and previewing.
<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/richedit">richedit</a>: a work-in-progress rich text editor with plain text and HTML export
-facilities.
--->
+<li><a href="../../samples/render">render</a>: shows how to use wxRenderer to implement controls consistent with the
+platform's native look.
+<li><a href="../../samples/richtext">richtext</a>: demonstrates wxRichTextCtrl.
<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
<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/shaped">shaped</a>: demonstrates non-rectangular windows using wxFrame::SetShape.
<li><a href="../../samples/sockets">sockets</a>: demonstrates the TCP/IP family of classes.
+<li><a href="../../samples/sound">sound</a>: demonstrates use of wxSound.
+<li><a href="../../samples/splash">splash</a>: demonstrates use of the wxSplashScreen class.
<li><a href="../../samples/splitter">splitter</a>: demonstrates the wxSplitterWindow class.
<li><a href="../../samples/statbar">statbar</a>: demonstrates the wxStatusBar class.
<li><a href="../../samples/taskbar">taskbar</a>: demonstrates the wxTaskBarIcon class, for
<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/vscroll">vscroll</a>: shows use of wxVScrolledWindow.
+<li><a href="../../samples/widgets">widgets</a>: shows a lot of control classes.
<li><a href="../../samples/wizard">wizard</a>: demonstrates the wxWizard class.
-</ul>
-
-The following are deprecated samples.
-
-<ul>
-<li><a href="../../contrib/deprecated/samples/resource">resource</a>: shows how to use old-style wxWindows resources (.wxr files).
-<li><a href="../../contrib/deprecated/samples/proplist">proplist</a>: demonstrates the property list classes (a VB-style property editor).
-<li><a href="../../contrib/deprecated/samples/treelay">treelay</a>: an algorithm for displaying tree hierarchies.
+<li><a href="../../samples/xrc">xrc</a>: demonstrates the XRC resource system.
</ul>
<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/life">life</a>: the game of Life by J. H. Conway, implemented in wxWidgets by Guillermo Rodriguez Garcia.
<li><a href="../../demos/poem">poem</a>: a little poetry display program.
</ul>
projects / wxWidgets.git / blobdiff