+
+This is an index of
+the plain text, HTML, Windows Help and Acrobat documentation: availability depends on what you've
+downloaded from the wxWidgets Web site.
-
+ |
-
-
+Installation and release notes
|
@@ -24,49 +44,387 @@
-Welcome to wxWindows 2.0, the premiere cross-platform C++ framework. This is an index of
-the plain text and HTML documentation. Documentation is also available in Acrobat (PDF) and Windows Help,
-from the wxWindows Web site.
+Unless you installed a binary version of wxWidgets using RPMs,
+you will probably have to compile the wxWidgets library first.
+Please read the platform-specific readme.txt and install.txt
+for how to do this.
-
Installation and release notes
+
+- ReadMe: General ReadMe,
+wxGTK,
+wxMotif,
+wxX11,
+wxNanoX,
+wxMSW,
+wxMac,
+wxMGL,
+Univ
+
- Installation: wxGTK,
+wxMotif,
+wxX11,
+wxMSW,
+wxMac,
+wxMGL,
+wxOS2
+
- General change log, wxGTK change log
- Licence: Preamble,
Licence,
Documentation Licence,
L-GPL,
GPL
-
- ReadMe: wxGTK,
-wxMotif,
-wxMSW
-
- Installation: wxGTK,
-wxMotif,
-wxMSW
-
- Change logs: wxMotif,
-wxMSW
-
- ToDo: wxGTK,
+
- FAQ:
+
+
- ToDo: General ToDo,
+wxGTK,
wxMotif,
-wxMSW
-
- List of preprocessor symbols used in wxWindows
+wxMSW,
+wxMac
+
- List of preprocessor symbols used in wxWidgets
+
+
+Further platform-specific notes:
+
+
+
+
+
+
+
+
+
+To use manuals in wxHTML Help form (extension htb), you can use the HelpView
+application, either compiling it from utils/helpview in the distribution,
+or downloading a binary, for example from here.
+
+See also the wxWidgets Tutorial
+by Franky Braem, in PDF format.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-wxWindows manuals
+
+
+
+
+
+
+Each of the following samples demonstrates one or more aspect of wxWidgets.
-- Reference Manual
-
- Porting Guide (wxWindows 1.xx to 2.0)
-
- Dialog Editor
-
- Property Classes
-
- wxTreeLayout
-
- Remstar ODBC Classes
+
- artprov: shows how you can customize the look of standard
+wxWidgets dialogs by replacing default bitmaps/icons with your own versions.
+
- 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 (optionally wxIniConfig), and wxFileConfig on other platforms.
+
- console: demonstrates a console application using
+console-mode (no-GUI) compilation of wxWidgets.
+
- controls: sample showing a variety of controls, including
+wxNotebook.
+
- db: wxDB ODBC sample.
+
- dialogs: shows some of the common dialogs available -- wxFontDialog,
+wxColourDialog, wxFileDialog, wxDirDialog, wxMessageBox, wxTextEntryDialog, wxSingleChoiceDialog.
+For printing-related dialogs, see the printing sample.
+
- 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.
+
- dragimag: wxDragImage demo.
+
- 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.
+
- 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.
+
- 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.
+
- internat: use of wxWidgets' internationalization support.
+
- joytest: tests the wxJoystick class (currently Windows and GTK only).
+
- keyboard: tests keyboard support.
+
- 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 wxWidgets 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 wxWidgets.
+
- 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 wxWidgets application as you can get.
+
- mobile: mini applications for embedded platforms.
+
- nativdlg: shows how wxWidgets can load a standard Windows
+dialog resource, translating the controls into wxWidgets controls (Windows only).
+
- 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.
+
- propsize: demonstrates proportional sizer classes.
+
- regtest: tests the low-level Windows registry functions (Windows only).
+
+
- 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.
+
- splash: demonstrates use of the wxSplashScreen class.
+
- splitter: demonstrates the wxSplitterWindow class.
+
- statbar: demonstrates the wxStatusBar class.
+
- 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.
+
- xrc: demonstrates the XRC resource system.
-Third-party tools
+The following are deprecated samples.
+
+
+- resource: shows how to use old-style wxWidgets resources (.wxr files).
+
- proplist: demonstrates the property list classes (a VB-style property editor).
+
- treelay: an algorithm for displaying tree hierarchies.
+
+
+
+
+
+
+
+
+
+The following are fully-fledged applications.