docs/html/index.htm

   1 <HTML>
   2
   3 <HEAD>
   4 <TITLE>wxWindows Documentation</TITLE>
   5
   6 </HEAD>
   7
   8 <BODY BGCOLOR="#FFFFFF" TEXT=#000000 LINK=#FF0000 VLINK=#000000>
   9
  10 <font face="Arial, Lucida Sans, Helvetica">
  11
  12 <a name="top"></a>
  13
  14 <table width=100% border=4 cellpadding=5 cellspacing=0>
  15 <tr>
  16 <td bgcolor="#660000">
  17 <font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
  18 <IMG src="logo.gif" align=right>
  19 <!-- wxWindows Documentation -->
  20 </font>
  21 </td>
  22 </tr>
  23 </table>
  24
  25 <P>
  26
  27 Welcome to wxWindows 2, the premiere cross-platform GUI C++ framework. This is an index of
  28 the plain text and HTML documentation. Documentation is also available in Acrobat (PDF) and Windows Help,
  29 from the <a href="http://www.wxwindows.org">wxWindows Web site</a>.<P>
  30
  31 <CENTER>
  32 <FONT size=-1>
  33 [<a href="#install">Install</a>]
  34 [<a href="#manuals">Manuals</a>]
  35 [<a href="#thirdparty">3rd party tools</a>]
  36 [<a href="#samples">Samples</a>]
  37 </FONT>
  38 </CENTER>
  39
  40 <hr>
  41
  42 <h3><a name="install">Installation and release notes</a></h3>
  43
  44 <ul>
  45 <li>ReadMe: <a href="../readme.txt"><b>General ReadMe</b></a>,
  46 <a href="../gtk/readme.txt">wxGTK</a>,
  47 <a href="../motif/readme.txt">wxMotif</a>,
  48 <a href="../msw/readme.txt">wxMSW</a>
  49 <li>Installation: <a href="../gtk/install.txt">wxGTK</a>,
  50 <a href="../motif/install.txt">wxMotif</a>,
  51 <a href="../msw/install.txt">wxMSW</a>
  52 <li><a href="../changes.txt"><b>Change log</b></a>
  53 <li><a href="../bugs.txt"><b>Buglist</b></a>
  54 <li>Licence: <a href="../preamble.txt">Preamble</a>,
  55 <a href="../licence.txt">Licence</a>,
  56 <a href="../licendoc.txt">Documentation Licence</a>,
  57 <a href="../lgpl.txt">L-GPL</a>,
  58 <a href="../gpl.txt">GPL</a>
  59 <li><a href="faq.htm"><B>FAQ</B></a>:
  60   <ul>
  61   <li><a href="faqgen.htm">General questions</a>
  62   <li><a href="faqgtk.htm">wxWindows 2 for GTK</a>
  63   <li><a href="faqmsw.htm">wxWindows 2 for Windows</a>
  64   <li><a href="faqmot.htm">wxWindows 2 for Motif</a>
  65   <li><a href="faqmac.htm">wxWindows 2 for Mac</a>
  66   </ul>
  67 <li>ToDo: <a href="../todo.txt"><b>General ToDo</b></a>,
  68 <a href="../gtk/todo.txt">wxGTK</a>,
  69 <a href="../motif/todo.txt">wxMotif</a>,
  70 <a href="../msw/todo.txt">wxMSW</a>
  71 <li>List of <a href="../symbols.txt">preprocessor symbols</a> used in wxWindows
  72 </ul>
  73
  74 <hr>
  75
  76
  77 <h3><a name="manuals">wxWindows manuals</a></h3>
  78
  79 <ul>
  80 <li><a href="wx/wx.htm">Reference Manual</a>
  81 <li><a href="porting/port.htm">Porting Guide</a> (wxWindows 1.xx to 2)
  82 <li><a href="dialoged/dlged.htm">Dialog Editor</a>
  83 <li><a href="proplist/prop.htm">Property List Classes</a>
  84 <li><a href="wxtree/tree.htm">wxTreeLayout</a>
  85 <li><a href="odbc/odbc.htm">Remstar ODBC Classes</a>
  86 </ul>
  87
  88 <hr>
  89
  90 <h3><a name="thirdparty">Third-party tools</a></h3>
  91
  92 <ul>
  93 <li><a href="gettext/gettext.htm">gettext manual</a>
  94 <li><a href="gettext/xgettext.htm">xgettext manual</a>
  95 <li><a href="gettext/msgfmt.htm">msgfmt manual</a>
  96 </ul>
  97
  98 <hr>
  99
 100 <h3><a name="samples">Samples</a></h3>
 101
 102 <ul>
 103 <li><a href="../../samples/bombs">bombs</a>: minesweeper-like game.
 104 <li><a href="../../samples/checklst">checklst</a>: demonstrates wxCheckListBox on
 105 supported platforms (currently Windows and GTK only).
 106 <li><a href="../../samples/config">config</a>: demonstrates use of wxConfig, which
 107 defaults to wxRegConfig on WIN32, wxIniConfig on WIN16, and wxFileConfig on other platforms.
 108 <li><a href="../../samples/controls">controls</a>: sample showing a variety of controls, including
 109 wxNotebook.
 110 <li><a href="../../samples/db">db</a>: wxDB ODBC sample.
 111 <li><a href="../../samples/dde">dde</a>: shows the DDE protocol in action, both using real
 112 DDE on Windows, and TCP/IP on all platforms. Edit <a href="../../samples/dde/ddesetup.h">ddesetup.h</a>
 113 to switch between compilation modes. Currently the TCP/IP mode needs a bit of work.
 114 <li><a href="../../samples/dialogs">dialogs</a>: shows some of the common dialogs available -- wxFontDialog,
 115 wxColourDialog, wxFileDialog, wxDirDialog, wxMessageBox, wxTextEntryDialog, wxSingleChoiceDialog.
 116 For printing-related dialogs, see the printing sample.
 117 <li><a href="../../samples/dnd">dnd</a>: demonstrates drag and drop on supported platforms.
 118 <li><a href="../../samples/docview">docview</a>: demonstrates use of the document view classes,
 119 using wxFrame.
 120 <li><a href="../../samples/docvwmdi">docvwmdi</a>: : demonstrates use of the document view classes,
 121 using wxMDIParentFrame, wxMDIChildFrame.
 122 <li><a href="../../samples/dynamic">dynamic</a>: shows how to connect events to member functions
 123 dynamically.
 124 <li><a href="../../samples/forty">forty</a>: a great little card game by Chris Breeze. A
 125 fully-fledged application!
 126 <li><a href="../../samples/fractal">fractal</a>: fractal mountains by Andrew Davison.
 127 <li><a href="../../samples/grid">grid</a>: demonstrates the wxGrid class.
 128 <li><a href="../../samples/help">help</a>: shows how to use wxHelpController.
 129 <li><a href="../../samples/image">image</a>: shows off the cross-platform wxImage class.
 130 <li><a href="../../samples/internat">internat</a>: use of wxWindows' internationalization support.
 131 <li><a href="../../samples/joytest">joytest</a>: tests the wxJoystick class (currently Windows and GTK only).
 132 <li><a href="../../samples/layout">layout</a>: shows the constraint layout system in action.
 133 <li><a href="../../samples/listctrl">listctrl</a>: demonstrates the wxListCtrl (implemented natively on
 134 WIN32, and using a generic version on other platforms).
 135 <li><a href="../../samples/mdi">mdi</a>: shows off the MDI (Multiple Document Interface) classes. On Windows, the regular MDI
 136 scheme is used whereby child windows have full sizing and moving rights within the main
 137 window. On other platforms, tabbed windows are used, where the children are always maximized.
 138 <li><a href="../../samples/memcheck">memcheck</a>: demonstrates the memory checking/debugging facilities.
 139 <li><a href="../../samples/mfc">mfc</a>: shows how to use MFC and wxWindows code in the same application (Windows only).
 140 To compile this, you must edit include/wx/wxprec.h, comment out the windows.h inclusion, and recompile wxWindows.
 141 <li><a href="../../samples/minifram">minifram</a>: demonstrates a frame with a small title bar. On
 142 platforms that don't support it, a normal-sized title bar is displayed.
 143 <li><a href="../../samples/minimal">minimal</a>: just shows a frame, a menubar, and a statusbar. About as
 144 small a wxWindows application as you can get.
 145 <li><a href="../../samples/nativdlg">nativdlg</a>: shows how wxWindows can load a standard Windows
 146 dialog resource, translating the controls into wxWindows controls (Windows only).
 147 <li><a href="../../samples/notebook">notebook</a>: shows the wxNotebook (tabbed window) control.
 148 <li><a href="../../samples/oleauto">oleauto</a>: a little OLE automation controller (Windows only; requires
 149 Excel to be present).
 150 <li><a href="../../samples/ownerdrw">ownerdrw</a>: demonstrates owner-draw menus and controls (Windows only).
 151 <li><a href="../../samples/png">png</a>: demonstrates PNG loading.
 152 <li><a href="../../samples/printing">printing</a>: shows printing and previewing.
 153 <li><a href="../../samples/proplist">proplist</a>: demonstrates the property list classes (a VB-style property editor).
 154 <li><a href="../../samples/regtest">regtest</a>: tests the low-level Windows registry functions (Windows only).
 155 <li><a href="../../samples/resource">resource</a>: shows how to use wxWindows resources (.wxr files).
 156 <li><a href="../../samples/sashtest">sashtest</a>: demonstrates use of the wxSashWindow class to allow
 157 the user to resize subwindows.
 158 <li><a href="../../samples/splitter">splitter</a>: demonstrates the wxSplitterWindow class.
 159 <li><a href="../../samples/tab">tab</a>: demonstrates the generic tab window class. You should
 160 normally use wxNotebook instead, but the generic code is sometimes useful, for example for
 161 implementing wxNotebook on platforms with no native support.
 162 <li><a href="../../samples/taskbar">taskbar</a>: demonstrates the wxTaskBarIcon class, for
 163 adding icons to the system tray. Windows only, but may eventually be implemented for other desktop
 164 environments that use this metaphor.
 165 <li><a href="../../samples/thread">thread</a>: tests the family of classes for doing thread
 166 programming.
 167 <li><a href="../../samples/toolbar">toolbar</a>: demonstrates wxToolBar.
 168 <li><a href="../../samples/treectrl">treectrl</a>: demonstrates wxTreeCtrl.
 169 <li><a href="../../samples/typetest">typetest</a>: tests various data type classes, including
 170 wxTime, wxDate and wxVariant.
 171 <li><a href="../../samples/validate">validate</a>: shows simple use of validation.
 172 <li><a href="../../samples/wxpoem">wxpoem</a>: a little poetry display program.
 173 <li><a href="../../samples/wxsocket">wxsocket</a>: demonstrates the TCP/IP family of classes.
 174 </ul>
 175
 176 <hr>
 177
 178 </font>
 179
 180 </BODY>
 181
 182 </HTML>
 183