wxWindows Documentation

Welcome to wxWindows 2, the première cross-platform GUI C++ framework. This is an index of the plain text, HTML, Windows Help and Acrobat documentation: availability depends on what you've downloaded from the wxWindows Web site.

[Install] [Manuals] [Technical Notes] [3rd party tools] [Samples] [Demos]

###

Installation and release notes

- ReadMe: General ReadMe, wxGTK, wxMotif, wxMSW
- Installation: wxGTK, wxMotif, wxMSW
- Change log
- Buglist
- Licence: Preamble, Licence, Documentation Licence, L-GPL, GPL
- FAQ:
  - General questions
  - wxWindows 2 for GTK
  - wxWindows 2 for Windows
  - wxWindows 2 for Motif
  - wxWindows 2 for Mac
- ToDo: General ToDo, wxGTK, wxMotif, wxMSW
- List of preprocessor symbols used in wxWindows

###

wxWindows manuals

HTML | WinHelp | MS HTML Help | PDF
Reference Manual | Reference Manual | Reference Manual | Reference Manual
Dialog Editor Manual | Dialog Editor Manual | Dialog Editor Manual | Dialog Editor Manual
Tex2RTF Manual | Tex2RTF Manual | Tex2RTF Manual | Tex2RTF Manual
Remstar ODBC Classes |  |  | Remstar ODBC Classes

###

Technical notes

- Index of technical notes
- Technical notes in text form
- Other documents:
  - Platforms supported
  - Languages supported by wxWindows
  - wxWindows programmer style guide
  - wxWindows news

###

Third-party tools

- gettext Manual

###

Samples

Each of the following demonstrates one or more aspect of wxWindows.

- calendar: a sample to test the wxCalendarCtrl class.
- caret: a sample to test the wxCaret class.
- checklst: demonstrates wxCheckListBox on supported platforms (currently Windows and GTK only).
- config: demonstrates use of wxConfig, which defaults to wxRegConfig on WIN32, wxIniConfig on WIN16, and wxFileConfig on other platforms.
- console: demonstrates a console application using console-mode (no-GUI) compilation of wxWindows.
- controls: sample showing a variety of controls, including wxNotebook.
- db: wxDB ODBC sample.
- ipc: shows the DDE-like protocol in action, both using real DDE on Windows, and TCP/IP on all platforms. Edit ddesetup.h to switch between compilation modes.
- dialogs: shows some of the common dialogs available -- wxFontDialog, wxColourDialog, wxFileDialog, wxDirDialog, wxMessageBox, wxTextEntryDialog, wxSingleChoiceDialog. For printing-related dialogs, see the printing sample.
- dragimag: wxDragImage demo.
- dialup: wxDialUpManager demo.
- dnd: demonstrates drag and drop on supported platforms.
- docview: demonstrates use of the document view classes, using wxFrame.
- docvwmdi: demonstrates use of the document view classes, using wxMDIParentFrame, wxMDIChildFrame.
- drawing: tests device context drawing.
- dynamic: shows how to connect events to member functions dynamically.
- event: demonstrates event handling.
- exec: demonstrates wxExecute.
- font: tests fonts, font enumerator, font encodings.
- grid: 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.
- help: shows how to use wxHelpController.
- html: a number of demos for the wxHTML class library, used inside applications and also as a help facility.
  - about: shows use of a wxHTML widget inside an About box.
  - help: shows use of wxHtmlHelpController to display wxHTML help.
  - helpview: a stand-alone wxHTML help viewer for any .htb book.
  - printing: shows how easy it is to preview and print HTML files.
  - test: general wxHTML test application.
  - virtual: demonstrates the virtual file system feature.
  - widget: demonstrates the use of controls in HTML pages.
  - zip: shows how help files can be packaged in zip archives.
- image: shows off the cross-platform wxImage class.
- internat: use of wxWindows' internationalization support.
- joytest: tests the wxJoystick class (currently Windows and GTK only).
- layout: shows the constraint layout system in action.
- listctrl: demonstrates the wxListCtrl (implemented natively on WIN32, and using a generic version on other platforms).
- menu: tests menus.
- mdi: shows off the MDI (Multiple Document Interface) classes. On Windows, the regular MDI 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.
- memcheck: demonstrates the memory checking/debugging facilities.
- mfc: 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.
- minifram: demonstrates a frame with a small title bar. On platforms that don't support it, a normal-sized title bar is displayed.
- minimal: just shows a frame, a menubar, and a statusbar. About as small a wxWindows application as you can get.
- nativdlg: shows how wxWindows can load a standard Windows dialog resource, translating the controls into wxWindows controls (Windows only).
- newgrid: demonstrates the new wxGrid implementation, by Michael Bedward and others.
- notebook: shows the wxNotebook (tabbed window) control.
- oleauto: a little OLE automation controller (Windows only; requires Excel to be present).
- ownerdrw: demonstrates owner-draw menus and controls (Windows only).
- png: demonstrates PNG loading.
- printing: shows printing and previewing.
- proplist: demonstrates the property list classes (a VB-style property editor).
- propsize: demonstrates proportional sizer classes.
- regtest: tests the low-level Windows registry functions (Windows only).
- resource: shows how to use wxWindows resources (.wxr files).
- richedit: a work-in-progress rich text editor with plain text and HTML export facilities.
- rotate: demonstrates interpolated and non-interpolated rotation of a wxImage.
- sashtest: demonstrates use of the wxSashWindow class to allow the user to resize subwindows.
- scroll: demonstrates wxScrolledWindow.
- scrollsub: demonstrates the use of wxScrolledWindow to scroll an embedded window.
- sockets: demonstrates the TCP/IP family of classes.
- splitter: demonstrates the wxSplitterWindow class.
- statbar: demonstrates the wxStatusBar class.
- tab: demonstrates the generic tab window class. You should normally use wxNotebook instead, but the generic code is sometimes useful, for example for implementing wxNotebook on platforms with no native support.
- taskbar: demonstrates the wxTaskBarIcon class, for adding icons to the system tray. Windows only, but may eventually be implemented for other desktop environments that use this metaphor.
- text: demonstrates single and multiline text controls, and clipboard operations.
- thread: tests the family of classes for doing thread programming.
- toolbar: demonstrates wxToolBar.
- treectrl: demonstrates wxTreeCtrl.
- typetest: tests various data type classes, including wxTime, wxDate and wxVariant.
- validate: shows simple use of validation.
- wizard: demonstrates the wxWizard class.

###

Demos

The following are fully-fledged applications.

- bombs: minesweeper-like game.
- dbbrowse: ODBC database browser application.
- forty: a great little card game by Chris Breeze.
- fractal: fractal mountains by Andrew Davison.
- life: the game of Life by J. H. Conway, implemented in wxWindows by Guillermo Rodriguez Garcia.
- poem: a little poetry display program.