docs/html/index.htm

   1 <HTML>
   2
   3 <HEAD>
   4 <TITLE>wxWindows Documentation</TITLE>
   5
   6 </HEAD>
   7
   8 <BODY BGCOLOR=#FFFFFF TEXT=#000000 VLINK="#63659C" LINK="#313063" ALINK="#313063">
   9
  10 <font face="Arial, Lucida Sans, Helvetica">
  11
  12 <a name="top"></a>
  13
  14 <IMG src="logo.gif" align=right hspace=10 vspace=0>
  15
  16 <b>Welcome to wxWindows 2, the premi&egrave;re cross-platform GUI C++ framework.</b><P>
  17
  18 This is an index of
  19 the plain text, HTML, Windows Help and Acrobat documentation: availability depends on what you've
  20 downloaded from the <a href="http://www.wxwindows.org">wxWindows Web site</a>.<br clear=all><P>
  21
  22 <CENTER>
  23 <FONT size=-1>
  24 [<a href="#install">Install</a>]
  25 [<a href="#manuals">Manuals</a>]
  26 [<a href="#technotes">Technical Notes</a>]
  27 [<a href="#thirdparty">3rd party tools</a>]
  28 [<a href="#samples">Samples</a>]
  29 [<a href="#demos">Demos</a>]
  30 </FONT>
  31 </CENTER>
  32
  33 <P>
  34
  35 <table width=100% border=0 cellpadding=3 cellspacing=0>
  36 <tr>
  37 <td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
  38 <font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
  39 <b><a name="install">Installation and release notes</a></b>
  40 </font>
  41 </td>
  42 </tr>
  43 </table>
  44
  45 <P>
  46
  47 Unless you installed a binary version of wxWindows using RPMs,
  48 you will probably have to compile the wxWindows library first.
  49 Please read the platform-specific readme.txt and install.txt
  50 for how to do this.
  51
  52 <P>
  53
  54 <ul>
  55 <li>ReadMe: <a href="../readme.txt"><b>General ReadMe</b></a>,
  56 <a href="../gtk/readme.txt">wxGTK</a>,
  57 <a href="../motif/readme.txt">wxMotif</a>,
  58 <a href="../x11/readme.txt">wxX11</a>,
  59 <a href="../x11/readme-nanox.txt">wxNanoX</a>,
  60 <a href="../msw/readme.txt">wxMSW</a>,
  61 <a href="../mac/readme.txt">wxMac</a>,
  62 <a href="../mgl/readme.txt">wxMGL</a>,
  63 <a href="../univ/readme.txt">Univ</a>
  64 <li>Installation: <a href="../gtk/install.txt">wxGTK</a>,
  65 <a href="../motif/install.txt">wxMotif</a>,
  66 <a href="../x11/install.txt">wxX11</a>,
  67 <a href="../msw/install.txt">wxMSW</a>,
  68 <a href="../mac/install.txt">wxMac</a>,
  69 <a href="../mgl/install.txt">wxMGL</a>,
  70 <a href="../os2/install.txt">wxOS2</a>
  71 <li><a href="../changes.txt"><b>General change log</b></a>, <a href="../gtk/changes.txt">wxGTK change log</a>
  72 <li>Licence: <a href="../preamble.txt">Preamble</a>,
  73 <a href="../licence.txt">Licence</a>,
  74 <a href="../licendoc.txt">Documentation Licence</a>,
  75 <a href="../lgpl.txt">L-GPL</a>,
  76 <a href="../gpl.txt">GPL</a>
  77 <li><a href="faq.htm"><B>FAQ</B></a>:
  78   <ul>
  79   <li><a href="faqgen.htm">General questions</a>
  80   <li><a href="faqgtk.htm">wxWindows 2 for GTK+</a>
  81   <li><a href="faqmsw.htm">wxWindows 2 for Windows</a>
  82   <li><a href="faqmot.htm">wxWindows 2 for Motif</a>
  83   <li><a href="faqx11.htm">wxWindows 2 for X11</a>
  84   <li><a href="faqmac.htm">wxWindows 2 for Mac</a>
  85   </ul>
  86 <li>ToDo: <a href="../todo.txt"><b>General ToDo</b></a>,
  87 <a href="../gtk/todo.txt">wxGTK</a>,
  88 <a href="../motif/todo.txt">wxMotif</a>,
  89 <a href="../msw/todo.txt">wxMSW</a>,
  90 <a href="../mac/todo.txt">wxMac</a>
  91 <li>List of <a href="../symbols.txt">preprocessor symbols</a> used in wxWindows
  92 </ul>
  93
  94 Further platform-specific notes:
  95
  96 <ul>
  97 <li> wxMSW: <a href="../msw/winxp.txt">Windows XP</a>
  98 </ul>
  99
 100 <P>
 101
 102 <table width=100% border=0 cellpadding=3 cellspacing=0>
 103 <tr>
 104 <td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
 105 <font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
 106 <b><a name="manuals">wxWindows manuals</a></b>
 107 </font>
 108 </td>
 109 </tr>
 110 </table>
 111
 112 <P>
 113
 114 To use manuals in wxHTML Help form (extension htb), you can use the <b>HelpView</b>
 115 application, either compiling it from utils/helpview in the distribution,
 116 or downloading a binary, for example from <a href="http://www.storylinescentral.com/helpview.htm">here</a>.<P>
 117
 118 See also the <a href="../pdf/wxTutorial.pdf">wxWindows Tutorial</a>
 119 by Franky Braem, in PDF format.<P>
 120
 121 <P>
 122
 123 <table border=0 cellpadding=5 cellspacing=0>
 124
 125 <tr>
 126 <td align=center bgcolor="#E0E0E0">
 127 <B>HTML</B>
 128 </td>
 129 <td align=center bgcolor="#E0E0E0">
 130 <B>WinHelp</B>
 131 </td>
 132 <td align=center bgcolor="#E0E0E0">
 133 <B>MS HTML Help</B>
 134 </td>
 135 <td align=center bgcolor="#E0E0E0">
 136 <B>wxHTML Help</B>
 137 </td>
 138 <td align=center bgcolor="#E0E0E0">
 139 <B>PDF</B>
 140 </td>
 141 </tr>
 142
 143 <tr>
 144 <td align=center>
 145 <a href="wx/wx.htm">wxWindows Reference</a>
 146 </td>
 147
 148 <td align=center>
 149 <a href="../winhelp/wx.hlp">wxWindows Reference</a>
 150 </td>
 151
 152 <td align=center>
 153 <a href="../htmlhelp/wx.chm">wxWindows Reference</a>
 154 </td>
 155
 156 <td align=center>
 157 <a href="../htb/wx.htb">wxWindows Reference</a>
 158 </td>
 159
 160 <td align=center>
 161 <a href="../pdf/wx.pdf">wxWindows Reference</a>
 162 </td>
 163 </tr>
 164
 165 <tr>
 166 <td align=center>
 167 <a href="dialoged/dlged.htm">Dialog Editor</a>
 168 </td>
 169
 170 <td align=center>
 171 <a href="../winhelp/dialoged.hlp">Dialog Editor</a>
 172 </td>
 173
 174 <td align=center>
 175 <a href="../htmlhelp/dialoged.chm">Dialog Editor</a>
 176 </td>
 177
 178 <td align=center>
 179 <a href="../htb/dialoged.htb">Dialog Editor</a>
 180 </td>
 181
 182 <td align=center>
 183 <a href="../pdf/dialoged.pdf">Dialog Editor</a>
 184 </td>
 185 </tr>
 186
 187 <tr>
 188 <td align=center>
 189 <a href="tex2rtf/t2rtf.htm">Tex2RTF</a>
 190 </td>
 191
 192 <td align=center>
 193 <a href="../winhelp/tex2rtf.hlp">Tex2RTF</a>
 194 </td>
 195
 196 <td align=center>
 197 <a href="../htmlhelp/tex2rtf.chm">Tex2RTF</a>
 198 </td>
 199
 200 <td align=center>
 201 <a href="../htb/tex2rtf.htb">Tex2RTF</a>
 202 </td>
 203
 204 <td align=center>
 205 <a href="../pdf/tex2rtf.pdf">Tex2RTF</a>
 206 </td>
 207 </tr>
 208
 209 <tr>
 210 <td align=center>
 211 <a href="fl/fl.htm">FL Library</a>
 212 </td>
 213
 214 <td align=center>
 215 <a href="../winhelp/fl.hlp">FL Library</a>
 216
 217 </td>
 218
 219 <td align=center>
 220 <a href="../htmlhelp/fl.chm">FL Library</a>
 221 </td>
 222
 223 <td align=center>
 224 <a href="../htb/fl.htb">FL Library</a>
 225 </td>
 226
 227 <td align=center>
 228 <a href="../pdf/fl.pdf">FL Library</a>
 229 </td>
 230 </tr>
 231
 232 <tr>
 233 <td align=center>
 234 <a href="ogl/ogl.htm">OGL Library</a>
 235 </td>
 236
 237 <td align=center>
 238 <a href="../winhelp/ogl.hlp">OGL Library</a>
 239
 240 </td>
 241
 242 <td align=center>
 243 <a href="../htmlhelp/ogl.chm">OGL Library</a>
 244 </td>
 245
 246 <td align=center>
 247 <a href="../htb/ogl.htb">OGL Library</a>
 248 </td>
 249
 250 <td align=center>
 251 <a href="../pdf/ogl.pdf">OGL Library</a>
 252 </td>
 253 </tr>
 254
 255 </table>
 256
 257 <P>
 258
 259 <table width=100% border=0 cellpadding=3 cellspacing=0>
 260 <tr>
 261 <td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
 262 <font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
 263 <b><a name="technotes">Technical notes</a></b>
 264 </font>
 265 </td>
 266 </tr>
 267 </table>
 268
 269 <P>
 270
 271 <ul>
 272 <li><a href="../tech/index.txt">Index of technical notes</a>
 273 <li><a href="../tech/">Technical notes</a>
 274 <li><a href="platform.htm">Platforms supported</a>
 275 <li><a href="i18n.htm">Languages supported by wxWindows</a>
 276 </ul>
 277
 278 <P>
 279
 280 <table width=100% border=0 cellpadding=3 cellspacing=0>
 281 <tr>
 282 <td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
 283 <font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
 284 <b><a name="thirdparty">Thirty-party tools</a></b>
 285 </font>
 286 </td>
 287 </tr>
 288 </table>
 289
 290 <P>
 291
 292 <ul>
 293 <li><a href="gettext/index.html">gettext Manual</a>
 294 </ul>
 295
 296 <P>
 297
 298 <table width=100% border=0 cellpadding=3 cellspacing=0>
 299 <tr>
 300 <td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
 301 <font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
 302 <b><a name="samples">Samples</a></b>
 303 </font>
 304 </td>
 305 </tr>
 306 </table>
 307
 308 <P>
 309
 310 Each of the following samples demonstrates one or more aspect of wxWindows.<P>
 311
 312 <ul>
 313 <li><a href="../../samples/calendar">artprov</a>: shows how you can customize the look of standard
 314 wxWindows dialogs by replacing default bitmaps/icons with your own versions.
 315 <li><a href="../../samples/calendar">calendar</a>: a sample to test the wxCalendarCtrl class.
 316 <li><a href="../../samples/caret">caret</a>: a sample to test the wxCaret class.
 317 <li><a href="../../samples/checklst">checklst</a>: demonstrates wxCheckListBox on
 318 supported platforms (currently Windows and GTK only).
 319 <li><a href="../../samples/config">config</a>: demonstrates use of wxConfig, which
 320 defaults to wxRegConfig on WIN32, wxIniConfig on WIN16, and wxFileConfig on other platforms.
 321 <li><a href="../../samples/console">console</a>: demonstrates a console application using
 322 console-mode (no-GUI) compilation of wxWindows.
 323 <li><a href="../../samples/controls">controls</a>: sample showing a variety of controls, including
 324 wxNotebook.
 325 <li><a href="../../samples/db">db</a>: wxDB ODBC sample.
 326 <li><a href="../../samples/ipc">ipc</a>: shows the DDE-like protocol in action, both using real
 327 DDE on Windows, and TCP/IP on all platforms. Edit <a href="../../samples/ipc/ddesetup.h">ddesetup.h</a>
 328 to switch between compilation modes.
 329 <li><a href="../../samples/dialogs">dialogs</a>: shows some of the common dialogs available -- wxFontDialog,
 330 wxColourDialog, wxFileDialog, wxDirDialog, wxMessageBox, wxTextEntryDialog, wxSingleChoiceDialog.
 331 For printing-related dialogs, see the printing sample.
 332 <li><a href="../../samples/dragimag">dragimag</a>: wxDragImage demo.
 333 <li><a href="../../samples/dialup">dialup</a>: wxDialUpManager demo.
 334 <li><a href="../../samples/dnd">dnd</a>: demonstrates drag and drop on supported platforms.
 335 <li><a href="../../samples/docview">docview</a>: demonstrates use of the document view classes,
 336 using wxFrame.
 337 <li><a href="../../samples/docvwmdi">docvwmdi</a>: demonstrates use of the document view classes,
 338 using wxMDIParentFrame, wxMDIChildFrame.
 339 <li><a href="../../samples/drawing">drawing</a>: tests device context drawing.
 340 <li><a href="../../samples/dynamic">dynamic</a>: shows how to connect events to member functions
 341 dynamically.
 342 <li><a href="../../samples/event">event</a>: demonstrates event handling.
 343 <li><a href="../../samples/exec">exec</a>: demonstrates wxExecute.
 344 <li><a href="../../samples/font">font</a>: tests fonts, font enumerator, font encodings.
 345 <li><a href="../../samples/grid">grid</a>: demonstrates the wxGrid class.
 346 <li><a href="../../samples/help">help</a>: shows how to use wxHelpController.
 347 <li><a href="../../samples/html">html</a>: a number of demos for the wxHTML class library, used inside
 348 applications and also as a help facility.
 349   <ul>
 350   <li><a href="../../samples/html/about">about</a>: shows use of a wxHTML widget inside an About box.
 351   <li><a href="../../samples/html/help">help</a>: shows use of wxHtmlHelpController to display wxHTML help.
 352   <li><a href="../../samples/html/helpview">helpview</a>: a stand-alone wxHTML help viewer for any .htb book.
 353   <li><a href="../../samples/html/printing">printing</a>: shows how easy it is to preview and print HTML files.
 354   <li><a href="../../samples/html/test">test</a>: general wxHTML test application.
 355   <li><a href="../../samples/html/virtual">virtual</a>: demonstrates the virtual file system feature.
 356   <li><a href="../../samples/html/widget">widget</a>: demonstrates the use of controls in HTML pages.
 357   <li><a href="../../samples/html/zip">zip</a>: shows how help files can be packaged in zip archives.
 358   </ul>
 359 <li><a href="../../samples/image">image</a>: shows off the cross-platform wxImage class.
 360 <li><a href="../../samples/internat">internat</a>: use of wxWindows' internationalization support.
 361 <li><a href="../../samples/joytest">joytest</a>: tests the wxJoystick class (currently Windows and GTK only).
 362 <li><a href="../../samples/keyboard">keyboard</a>: tests keyboard support.
 363 <li><a href="../../samples/layout">layout</a>: shows the constraint layout system in action.
 364 <li><a href="../../samples/listctrl">listctrl</a>: demonstrates the wxListCtrl (implemented natively on
 365 WIN32, and using a generic version on other platforms).
 366 <li><a href="../../samples/menu">menu</a>: tests menus.
 367 <li><a href="../../samples/mdi">mdi</a>: shows off the MDI (Multiple Document Interface) classes. On Windows, the regular MDI
 368 scheme is used whereby child windows have full sizing and moving rights within the main
 369 window. On other platforms, tabbed windows are used, where the children are always maximized.
 370 <li><a href="../../samples/memcheck">memcheck</a>: demonstrates the memory checking/debugging facilities.
 371 <li><a href="../../samples/mfc">mfc</a>: shows how to use MFC and wxWindows code in the same application (Windows only).
 372 To compile this, you must edit include/wx/wxprec.h, comment out the windows.h inclusion, and recompile wxWindows.
 373 <li><a href="../../samples/minifram">minifram</a>: demonstrates a frame with a small title bar. On
 374 platforms that don't support it, a normal-sized title bar is displayed.
 375 <li><a href="../../samples/minimal">minimal</a>: just shows a frame, a menubar, and a statusbar. About as
 376 small a wxWindows application as you can get.
 377 <li><a href="../../samples/mobile">mobile</a>: mini applications for embedded platforms.
 378 <li><a href="../../samples/nativdlg">nativdlg</a>: shows how wxWindows can load a standard Windows
 379 dialog resource, translating the controls into wxWindows controls (Windows only).
 380 <li><a href="../../samples/notebook">notebook</a>: shows the wxNotebook (tabbed window) control.
 381 <li><a href="../../samples/oleauto">oleauto</a>: a little OLE automation controller (Windows only; requires
 382 Excel to be present).
 383 <li><a href="../../samples/ownerdrw">ownerdrw</a>: demonstrates owner-draw menus and controls (Windows only).
 384 <li><a href="../../samples/png">png</a>: demonstrates PNG loading.
 385 <li><a href="../../samples/printing">printing</a>: shows printing and previewing.
 386 <li><a href="../../samples/propsize">propsize</a>: demonstrates proportional sizer classes.
 387 <li><a href="../../samples/regtest">regtest</a>: tests the low-level Windows registry functions (Windows only).
 388 <!-- <li><a href="../../samples/richedit">richedit</a>: a work-in-progress rich text editor with plain text and HTML export
 389 facilities.
 390 -->
 391 <li><a href="../../samples/rotate">rotate</a>: demonstrates interpolated and non-interpolated
 392 rotation of a wxImage.
 393 <li><a href="../../samples/sashtest">sashtest</a>: demonstrates use of the wxSashWindow class to allow
 394 the user to resize subwindows.
 395 <li><a href="../../samples/scroll">scroll</a>: demonstrates wxScrolledWindow.
 396 <li><a href="../../samples/scrollsub">scrollsub</a>: demonstrates the use of wxScrolledWindow to scroll
 397 an embedded window.
 398 <li><a href="../../samples/sockets">sockets</a>: demonstrates the TCP/IP family of classes.
 399 <li><a href="../../samples/splitter">splitter</a>: demonstrates the wxSplitterWindow class.
 400 <li><a href="../../samples/statbar">statbar</a>: demonstrates the wxStatusBar class.
 401 <li><a href="../../samples/taskbar">taskbar</a>: demonstrates the wxTaskBarIcon class, for
 402 adding icons to the system tray. Windows only, but may eventually be implemented for other desktop
 403 environments that use this metaphor.
 404 <li><a href="../../samples/text">text</a>: demonstrates single and multiline text controls,
 405 and clipboard operations.
 406 <li><a href="../../samples/thread">thread</a>: tests the family of classes for doing thread
 407 programming.
 408 <li><a href="../../samples/toolbar">toolbar</a>: demonstrates wxToolBar.
 409 <li><a href="../../samples/treectrl">treectrl</a>: demonstrates wxTreeCtrl.
 410 <li><a href="../../samples/typetest">typetest</a>: tests various data type classes, including
 411 wxTime, wxDate and wxVariant.
 412 <li><a href="../../samples/validate">validate</a>: shows simple use of validation.
 413 <li><a href="../../samples/wizard">wizard</a>: demonstrates the wxWizard class.
 414 </ul>
 415
 416 The following are deprecated samples.
 417
 418 <ul>
 419 <li><a href="../../contrib/deprecated/samples/resource">resource</a>: shows how to use old-style wxWindows resources (.wxr files).
 420 <li><a href="../../contrib/deprecated/samples/proplist">proplist</a>: demonstrates the property list classes (a VB-style property editor).
 421 <li><a href="../../contrib/deprecated/samples/treelay">treelay</a>: an algorithm for displaying tree hierarchies.
 422 </ul>
 423
 424
 425 <P>
 426
 427 <table width=100% border=0 cellpadding=3 cellspacing=0>
 428 <tr>
 429 <td bgcolor="#004080" align=left height=24 background="images/bluetitlegradient.gif">
 430 <font size=+1 face="Arial, Lucida Sans, Helvetica" color="#FFFFFF">
 431 <b><a name="demos">Demos</a></b>
 432 </font>
 433 </td>
 434 </tr>
 435 </table>
 436
 437 <P>
 438
 439 The following are fully-fledged applications.<P>
 440
 441 <ul>
 442 <li><a href="../../demos/bombs">bombs</a>: minesweeper-like game.
 443 <li><a href="../../demos/dbbrowse">dbbrowse</a>: ODBC database browser application.
 444 <li><a href="../../demos/forty">forty</a>: a great little card game by Chris Breeze.
 445 <li><a href="../../demos/fractal">fractal</a>: fractal mountains by Andrew Davison.
 446 <li><a href="../../demos/life">life</a>: the game of Life by J. H. Conway, implemented in wxWindows by Guillermo Rodriguez Garcia.
 447 <li><a href="../../demos/poem">poem</a>: a little poetry display program.
 448 </ul>
 449
 450 </font>
 451
 452 </BODY>
 453
 454 </HTML>
 455