docs/html/index.htm

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