]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/html/index.htm
Applied patch [ 1039940 ] Prevent redefinition of MM_xxx mapping mode constants
[wxWidgets.git] / docs / html / index.htm
index ddf36853ebed83e8a1765554b232a35f36a33a34..b3006734003abb75401c426dc1515b6737921b0a 100644 (file)
@@ -1,7 +1,7 @@
 <HTML>
 
 <HEAD>
 <HTML>
 
 <HEAD>
-<TITLE>wxWindows Documentation</TITLE>
+<TITLE>wxWidgets Documentation</TITLE>
 
 </HEAD>
 
 
 </HEAD>
 
 
 <IMG src="logo.gif" align=right hspace=10 vspace=0>
 
 
 <IMG src="logo.gif" align=right hspace=10 vspace=0>
 
-Welcome to wxWindows 2, the premi&egrave;re cross-platform GUI C++ framework. This is an index of
+<b>Welcome to wxWidgets 2, the premi&egrave;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
 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>.<br clear=all><P>
+downloaded from the <a href="http://www.wxwindows.org">wxWidgets Web site</a>.<br clear=all><P>
 
 <CENTER>
 <FONT size=-1>
 
 <CENTER>
 <FONT size=-1>
@@ -42,6 +44,13 @@ downloaded from the <a href="http://www.wxwindows.org">wxWindows Web site</a>.<b
 
 <P>
 
 
 <P>
 
+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.
+
+<P>
+
 <ul>
 <li>ReadMe: <a href="../readme.txt"><b>General ReadMe</b></a>,
 <a href="../gtk/readme.txt">wxGTK</a>,
 <ul>
 <li>ReadMe: <a href="../readme.txt"><b>General ReadMe</b></a>,
 <a href="../gtk/readme.txt">wxGTK</a>,
@@ -68,17 +77,18 @@ downloaded from the <a href="http://www.wxwindows.org">wxWindows Web site</a>.<b
 <li><a href="faq.htm"><B>FAQ</B></a>:
   <ul>
   <li><a href="faqgen.htm">General questions</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="faqgtk.htm">wxWidgets 2 for GTK+</a>
+  <li><a href="faqmsw.htm">wxWidgets 2 for Windows</a>
+  <li><a href="faqmot.htm">wxWidgets 2 for Motif</a>
+  <li><a href="faqx11.htm">wxWidgets 2 for X11</a>
+  <li><a href="faqmac.htm">wxWidgets 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>,
   </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>
-<li>List of <a href="../symbols.txt">preprocessor symbols</a> used in wxWindows
+<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 wxWidgets
 </ul>
 
 Further platform-specific notes:
 </ul>
 
 Further platform-specific notes:
@@ -93,7 +103,7 @@ 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">
 <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>
 </font>
 </td>
 </tr>
@@ -105,7 +115,7 @@ To use manuals in wxHTML Help form (extension htb), you can use the <b>HelpView<
 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>
 
 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>
+See also the <a href="../pdf/wxTutorial.pdf">wxWidgets Tutorial</a>
 by Franky Braem, in PDF format.<P>
 
 <P>
 by Franky Braem, in PDF format.<P>
 
 <P>
@@ -132,45 +142,23 @@ by Franky Braem, in PDF format.<P>
 
 <tr>
 <td align=center>
 
 <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>
 </td>
 
 <td align=center>
-<a href="../winhelp/dialoged.hlp">Dialog Editor</a>
+<a href="../winhelp/wx.hlp">wxWidgets Reference</a>
 </td>
 
 <td align=center>
 </td>
 
 <td align=center>
-<a href="../htmlhelp/dialoged.chm">Dialog Editor</a>
+<a href="../htmlhelp/wx.chm">wxWidgets Reference</a>
 </td>
 
 <td align=center>
 </td>
 
 <td align=center>
-<a href="../htb/dialoged.htb">Dialog Editor</a>
+<a href="../htb/wx.htb">wxWidgets Reference</a>
 </td>
 
 <td align=center>
 </td>
 
 <td align=center>
-<a href="../pdf/dialoged.pdf">Dialog Editor</a>
+<a href="../pdf/wx.pdf">wxWidgets Reference</a>
 </td>
 </tr>
 
 </td>
 </tr>
 
@@ -262,7 +250,7 @@ by Franky Braem, in PDF format.<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="../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>
+<li><a href="i18n.htm">Languages supported by wxWidgets</a>
 </ul>
 
 <P>
 </ul>
 
 <P>
@@ -297,44 +285,39 @@ by Franky Braem, in PDF format.<P>
 
 <P>
 
 
 <P>
 
-Each of the following demonstrates one or more aspect of wxWindows.<P>
+Each of the following samples demonstrates one or more aspect of wxWidgets.<P>
 
 <ul>
 
 <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/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/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
 <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.
+defaults to wxRegConfig on WIN32 (optionally wxIniConfig), and wxFileConfig on other platforms.
 <li><a href="../../samples/console">console</a>: demonstrates a console application using
 <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/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/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/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,
 using wxMDIParentFrame, wxMDIChildFrame.
 <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,
 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/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/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/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/grid">grid</a>: demonstrates the wxGrid class.
 <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.
 <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.
@@ -349,7 +332,10 @@ applications and also as a help facility.
   <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/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/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/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.
@@ -360,26 +346,23 @@ WIN32, and using a generic version on other platforms).
 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.
 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
 <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/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/newgrid">newgrid</a>: demonstrates the new wxGrid implementation, by Michael Bedward and others.
+<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/ownerdrw">ownerdrw</a>: demonstrates owner-draw menus and controls (Windows only).
 <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/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/ownerdrw">ownerdrw</a>: demonstrates owner-draw menus and controls (Windows only).
 <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/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/richedit">richedit</a>: a work-in-progress rich text editor with plain text and HTML export
 facilities.
 -->
@@ -391,6 +374,7 @@ the user to resize subwindows.
 <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/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/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/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
@@ -406,8 +390,18 @@ 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.
 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/xrc">xrc</a>: demonstrates the XRC resource system.
+</ul>
+
+The following are deprecated samples.
+
+<ul>
+<li><a href="../../contrib/deprecated/samples/resource">resource</a>: shows how to use old-style wxWidgets 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.
 </ul>
 
 </ul>
 
+
 <P>
 
 <table width=100% border=0 cellpadding=3 cellspacing=0>
 <P>
 
 <table width=100% border=0 cellpadding=3 cellspacing=0>
@@ -429,7 +423,7 @@ The following are fully-fledged applications.<P>
 <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/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>
 
 <li><a href="../../demos/poem">poem</a>: a little poetry display program.
 </ul>