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 <BODY BGCOLOR="#CCDDDFF" TEXT=#000000 LINK=#FF0000 VLINK=#000000>
  10
  11 <font face="Arial, Lucida Sans, Helvetica">
  12
  13 <a name="top"></a>
  14
  15 <table width=100% border=4 cellpadding=5 cellspacing=0>
  16 <tr>
  17 <td bgcolor="#660000">
  18 <font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
  19 <IMG src="logo.gif" align=right>
  20 <!-- wxWindows Documentation -->
  21 </font>
  22 </td>
  23 </tr>
  24 </table>
  25
  26 <P>
  27
  28 Welcome to wxWindows 2, the premi&egrave;re cross-platform GUI C++ framework. This is an index of
  29 the plain text, HTML, Windows Help and Acrobat documentation: availability depends on what you've
  30 downloaded from the <a href="http://www.wxwindows.org">wxWindows Web site</a>.<P>
  31
  32 <CENTER>
  33 <FONT size=-1>
  34 [<a href="#install">Install</a>]
  35 [<a href="#manuals">Manuals</a>]
  36 [<a href="#thirdparty">3rd party tools</a>]
  37 [<a href="#samples">Samples</a>]
  38 </FONT>
  39 </CENTER>
  40
  41 <h3 align=center><a name="install"><hr>Installation and release notes<hr></a></h3>
  42
  43 <ul>
  44 <li>ReadMe: <a href="../readme.txt"><b>General ReadMe</b></a>,
  45 <a href="../gtk/readme.txt">wxGTK</a>,
  46 <a href="../motif/readme.txt">wxMotif</a>,
  47 <a href="../msw/readme.txt">wxMSW</a>
  48 <li><a href="../release.txt"><b>Release notes</b></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 <h3 align=center><a name="manuals"><hr>wxWindows manuals<hr></a></h3>
  75
  76 <table border=1 align=center>
  77
  78 <tr>
  79 <td align=center bgcolor="#FFFF00">
  80 <B>HTML</B>
  81 </td>
  82 <td align=center bgcolor="#FFFF00">
  83 <B>WinHelp</B>
  84 </td>
  85 <td align=center bgcolor="#FFFF00">
  86 <B>PDF</B>
  87 </td>
  88 </tr>
  89
  90 <tr>
  91 <td align=center>
  92 <a href="wx/wx.htm">Reference Manual</a>
  93 </td>
  94
  95 <td align=center>
  96 <a href="../winhelp/wx.hlp">Reference Manual</a>
  97 </td>
  98
  99 <td align=center>
 100 <a href="../pdf/wx.pdf">Reference Manual</a>
 101 </td>
 102 </tr>
 103
 104 <tr>
 105 <td align=center>
 106 <a href="porting/port.htm">Porting Guide</a>
 107 </td>
 108
 109 <td align=center>
 110 <a href="../winhelp/porting.hlp">Porting Guide</a>
 111 </td>
 112
 113 <td align=center>
 114 <a href="../pdf/porting.pdf">Porting Guide</a>
 115 </td>
 116 </tr>
 117
 118 <tr>
 119 <td align=center>
 120 <a href="dialoged/dlged.htm">Dialog Editor Manual</a>
 121 </td>
 122
 123 <td align=center>
 124 <a href="../winhelp/dialoged.hlp">Dialog Editor Manual</a>
 125 </td>
 126
 127 <td align=center>
 128 <a href="../pdf/dialoged.pdf">Dialog Editor Manual</a>
 129 </td>
 130 </tr>
 131
 132 <tr>
 133 <td align=center>
 134 <a href="proplist/prop.htm">Property List Classes</a>
 135 </td>
 136
 137 <td align=center>
 138 <a href="../winhelp/proplist.hlp">Property List Classes</a>
 139 </td>
 140
 141 <td align=center>
 142 <a href="../pdf/proplist.pdf">Property List Classes</a>
 143 </td>
 144 </tr>
 145
 146 <tr>
 147 <td align=center>
 148 <a href="wxtree/tree.htm">wxTreeLayout Class</a>
 149 </td>
 150
 151 <td align=center>
 152 <a href="../winhelp/wxtree.hlp">wxTreeLayout Class</a>
 153 </td>
 154
 155 <td align=center>
 156 <a href="../pdf/wxtree.pdf">wxTreeLayout Class</a>
 157 </td>
 158 </tr>
 159
 160 <tr>
 161 <td align=center>
 162 <a href="odbc/odbc.htm">Remstar ODBC Classes</a>
 163 </td>
 164
 165 <td align=center>
 166 <BR><BR>
 167 </td>
 168
 169 <td align=center>
 170 <a href="../pdf/odbc.pdf">Remstar ODBC Classes</a>
 171 </td>
 172 </tr>
 173
 174 </table>
 175
 176
 177 <h3 align=center><a name="thirdparty"><hr>Third-party tools<hr></a></h3>
 178
 179 <ul>
 180 <li><a href="gettext/gettext.htm">gettext Manual</a>
 181 <li><a href="gettext/xgettext.htm">xgettext Manual</a>
 182 <li><a href="gettext/msgfmt.htm">msgfmt Manual</a>
 183 </ul>
 184
 185 <h3 align=center><a name="samples"><hr>Samples<hr></a></h3>
 186
 187 <ul>
 188 <li><a href="../../samples/bombs">bombs</a>: minesweeper-like game.
 189 <li><a href="../../samples/caret">caret</a>: a sample to test the wxCaret class.
 190 <li><a href="../../samples/checklst">checklst</a>: demonstrates wxCheckListBox on
 191 supported platforms (currently Windows and GTK only).
 192 <li><a href="../../samples/config">config</a>: demonstrates use of wxConfig, which
 193 defaults to wxRegConfig on WIN32, wxIniConfig on WIN16, and wxFileConfig on other platforms.
 194 <li><a href="../../samples/console">console</a>: demonstrates a console application using
 195 console-mode (no-GUI) compilation of wxWindows.
 196 <li><a href="../../samples/controls">controls</a>: sample showing a variety of controls, including
 197 wxNotebook.
 198 <li><a href="../../samples/db">db</a>: wxDB ODBC sample.
 199 <li><a href="../../samples/dde">dde</a>: shows the DDE protocol in action, both using real
 200 DDE on Windows, and TCP/IP on all platforms. Edit <a href="../../samples/dde/ddesetup.h">ddesetup.h</a>
 201 to switch between compilation modes. Currently the TCP/IP mode needs a bit of work.
 202 <li><a href="../../samples/dialogs">dialogs</a>: shows some of the common dialogs available -- wxFontDialog,
 203 wxColourDialog, wxFileDialog, wxDirDialog, wxMessageBox, wxTextEntryDialog, wxSingleChoiceDialog.
 204 For printing-related dialogs, see the printing sample.
 205 <li><a href="../../samples/dnd">dnd</a>: demonstrates drag and drop on supported platforms.
 206 <li><a href="../../samples/docview">docview</a>: demonstrates use of the document view classes,
 207 using wxFrame.
 208 <li><a href="../../samples/docvwmdi">docvwmdi</a>: : demonstrates use of the document view classes,
 209 using wxMDIParentFrame, wxMDIChildFrame.
 210 <li><a href="../../samples/drawing">drawing</a>: tests device context drawing.
 211 <li><a href="../../samples/dynamic">dynamic</a>: shows how to connect events to member functions
 212 dynamically.
 213 <li><a href="../../samples/forty">forty</a>: a great little card game by Chris Breeze. A
 214 fully-fledged application!
 215 <li><a href="../../samples/font">font</a>: tests fonts, font enumerator, font encodings.
 216 <li><a href="../../samples/fractal">fractal</a>: fractal mountains by Andrew Davison.
 217 <li><a href="../../samples/grid">grid</a>: demonstrates the wxGrid class.
 218 <li><a href="../../samples/help">help</a>: shows how to use wxHelpController.
 219 <li><a href="../../samples/html">html</a>: a number of demos for the wxHTML class library, used inside
 220 applications and also as a help facility.
 221   <ul>
 222   <li><a href="../../samples/html/about">about</a>: shows use of a wxHTML widget inside an About box.
 223   <li><a href="../../samples/html/help">help</a>: shows use of wxHtmlHelpController to display wxHTML help.
 224   <li><a href="../../samples/html/helpview">helpview</a>: a stand-alone wxHTML help viewer.
 225   <li><a href="../../samples/html/printing">printing</a>: shows how easy it is to preview and print HTML files.
 226   <li><a href="../../samples/html/test">test</a>: general wxHTML test application.
 227   <li><a href="../../samples/html/virtual">virtual</a>: demonstrates the virtual file system feature.
 228   <li><a href="../../samples/html/widget">widget</a>: demonstrates the use of controls in HTML pages.
 229   <li><a href="../../samples/html/zip">zip</a>: shows how help files can be packaged in zip archives.
 230   </ul>
 231 <li><a href="../../samples/image">image</a>: shows off the cross-platform wxImage class.
 232 <li><a href="../../samples/internat">internat</a>: use of wxWindows' internationalization support.
 233 <li><a href="../../samples/joytest">joytest</a>: tests the wxJoystick class (currently Windows and GTK only).
 234 <li><a href="../../samples/layout">layout</a>: shows the constraint layout system in action.
 235 <li><a href="../../samples/listctrl">listctrl</a>: demonstrates the wxListCtrl (implemented natively on
 236 WIN32, and using a generic version on other platforms).
 237 <li><a href="../../samples/menu">menu</a>: tests menus.
 238 <li><a href="../../samples/mdi">mdi</a>: shows off the MDI (Multiple Document Interface) classes. On Windows, the regular MDI
 239 scheme is used whereby child windows have full sizing and moving rights within the main
 240 window. On other platforms, tabbed windows are used, where the children are always maximized.
 241 <li><a href="../../samples/memcheck">memcheck</a>: demonstrates the memory checking/debugging facilities.
 242 <li><a href="../../samples/mfc">mfc</a>: shows how to use MFC and wxWindows code in the same application (Windows only).
 243 To compile this, you must edit include/wx/wxprec.h, comment out the windows.h inclusion, and recompile wxWindows.
 244 <li><a href="../../samples/minifram">minifram</a>: demonstrates a frame with a small title bar. On
 245 platforms that don't support it, a normal-sized title bar is displayed.
 246 <li><a href="../../samples/minimal">minimal</a>: just shows a frame, a menubar, and a statusbar. About as
 247 small a wxWindows application as you can get.
 248 <li><a href="../../samples/nativdlg">nativdlg</a>: shows how wxWindows can load a standard Windows
 249 dialog resource, translating the controls into wxWindows controls (Windows only).
 250 <li><a href="../../samples/nettest">nettest</a>: wxDialUpManager demo.
 251 <li><a href="../../samples/newgrid">newgrid</a>: demonstrates the new wxGrid implementation, by Michael Bedward.
 252 <li><a href="../../samples/notebook">notebook</a>: shows the wxNotebook (tabbed window) control.
 253 <li><a href="../../samples/oleauto">oleauto</a>: a little OLE automation controller (Windows only; requires
 254 Excel to be present).
 255 <li><a href="../../samples/ownerdrw">ownerdrw</a>: demonstrates owner-draw menus and controls (Windows only).
 256 <li><a href="../../samples/png">png</a>: demonstrates PNG loading.
 257 <li><a href="../../samples/printing">printing</a>: shows printing and previewing.
 258 <li><a href="../../samples/proplist">proplist</a>: demonstrates the property list classes (a VB-style property editor).
 259 <li><a href="../../samples/regtest">regtest</a>: tests the low-level Windows registry functions (Windows only).
 260 <li><a href="../../samples/resource">resource</a>: shows how to use wxWindows resources (.wxr files).
 261 <li><a href="../../samples/richedit">richedit</a>: a work-in-progress rich text editor with plain text and HTML export
 262 facilities.
 263 <li><a href="../../samples/sashtest">sashtest</a>: demonstrates use of the wxSashWindow class to allow
 264 the user to resize subwindows.
 265 <li><a href="../../samples/scroll">scroll</a>: demonstrates wxScrolledWindow.
 266 <li><a href="../../samples/scrollsub">scrollsub</a>: demonstrates the use of wxScrolledWindow to scroll
 267 an embedded window.
 268 <li><a href="../../samples/splitter">splitter</a>: demonstrates the wxSplitterWindow class.
 269 <li><a href="../../samples/tab">tab</a>: demonstrates the generic tab window class. You should
 270 normally use wxNotebook instead, but the generic code is sometimes useful, for example for
 271 implementing wxNotebook on platforms with no native support.
 272 <li><a href="../../samples/taskbar">taskbar</a>: demonstrates the wxTaskBarIcon class, for
 273 adding icons to the system tray. Windows only, but may eventually be implemented for other desktop
 274 environments that use this metaphor.
 275 <li><a href="../../samples/text">text</a>: demonstrates single and multiline text controls,
 276 and clipboard operations.
 277 <li><a href="../../samples/thread">thread</a>: tests the family of classes for doing thread
 278 programming.
 279 <li><a href="../../samples/toolbar">toolbar</a>: demonstrates wxToolBar.
 280 <li><a href="../../samples/treectrl">treectrl</a>: demonstrates wxTreeCtrl.
 281 <li><a href="../../samples/typetest">typetest</a>: tests various data type classes, including
 282 wxTime, wxDate and wxVariant.
 283 <li><a href="../../samples/validate">validate</a>: shows simple use of validation.
 284 <li><a href="../../samples/wizard">wizard</a>: demonstrates the wxWizard class.
 285 <li><a href="../../samples/wxpoem">wxpoem</a>: a little poetry display program.
 286 <li><a href="../../samples/wxsocket">wxsocket</a>: demonstrates the TCP/IP family of classes.
 287 </ul>
 288
 289 <hr>
 290
 291 </font>
 292
 293 </BODY>
 294
 295 </HTML>
 296