// Name: samples.h
// Purpose: Samples page of the Doxygen manual
// Author: wxWidgets team
-// RCS-ID: $Id: utilities.h 52634 2008-03-20 13:45:17Z VS $
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
@page page_samples Samples Overview
-@brief Overview of the examples provided with wxWidgets.
+@tableofcontents
Probably the best way to learn wxWidgets is by reading the source of some 80+
samples provided with it. Many aspects of wxWidgets programming can be learnt
didn't help. They also provide some notes about using the samples and what
features of wxWidgets are they supposed to test.
-There are currently more than 80 different samples as part of wxWidgets:
-the list in this page is not complete!
-You should start your tour of wxWidgets with the @ref page_samples_minimal
-which is the wxWidgets version of "Hello, world!".
-It shows the basic structure of wxWidgets program and is the most commented
-sample of all - looking at its source code is recommended.
+There are currently more than 80 different samples as part of wxWidgets: the
+list in this page is not complete! You should start your tour of wxWidgets with
+the @ref page_samples_minimal which is the wxWidgets version of "Hello,
+world!". It shows the basic structure of wxWidgets program and is the most
+commented sample of all - looking at its source code is recommended.
The next most useful sample is @ref page_samples_widgets which shows many of
wxWidgets controls, such as buttons, text entry zones, list boxes, check boxes,
@li wxTreeCtrl: @ref page_samples_treectrl
@li wxGrid: @ref page_samples_grid
@li wxDataViewCtrl: @ref page_samples_dataview
-
-
-Finally, here is the full list of samples:
-<!--
-The following sample list is generated by executing command
-
-ls -1 | egrep '[a-z]+' | egrep '^[a-z]+/$' | sed 's/^/@li @sample\{/' | sed 's///$/\}/'
-
-in wxWidgets/samples
-
-TODO: Organize them in a more human-readable way.
--->
-
-@beginInvisibleTable
-<tr><td>
-@li @sample{access}
-@li @sample{animate}
-@li @sample{artprov}
-@li @sample{aui}
-@li @sample{calendar}
-@li @sample{caret}
-@li @sample{clipboard}
-@li @sample{collpane}
-@li @sample{combo}
-@li @sample{config}
-@li @sample{console}
-@li @sample{controls}
-@li @sample{dataview}
-@li @sample{debugrpt}
-@li @sample{dialogs}
-@li @sample{dialup}
-@li @sample{display}
-@li @sample{dnd}
-@li @sample{docview}
-@li @sample{dragimag}
-@li @sample{drawing}
-@li @sample{erase}
-@li @sample{event}
-@li @sample{except}
-@li @sample{exec}
-@li @sample{flash}
-@li @sample{font}
-</td><td>
-@li @sample{grid}
-@li @sample{help}
-@li @sample{htlbox}
-@li @sample{html}
-@li @sample{image}
-@li @sample{internat}
-@li @sample{ipc}
-@li @sample{joytest}
-@li @sample{keyboard}
-@li @sample{layout}
-@li @sample{listctrl}
-@li @sample{mdi}
-@li @sample{mediaplayer}
-@li @sample{memcheck}
-@li @sample{menu}
-@li @sample{mfc}
-@li @sample{minimal}
-@li @sample{nativdlg}
-@li @sample{notebook}
-@li @sample{oleauto}
-@li @sample{opengl}
-@li @sample{ownerdrw}
-@li @sample{popup}
-@li @sample{power}
-@li @sample{printing}
-@li @sample{propgrid}
-</td><td>
-@li @sample{regtest}
-@li @sample{render}
-@li @sample{richtext}
-@li @sample{sashtest}
-@li @sample{scroll}
-@li @sample{shaped}
-@li @sample{sockets}
-@li @sample{sound}
-@li @sample{splash}
-@li @sample{splitter}
-@li @sample{statbar}
-@li @sample{stc}
-@li @sample{svg}
-@li @sample{taborder}
-@li @sample{taskbar}
-@li @sample{text}
-@li @sample{thread}
-@li @sample{toolbar}
-@li @sample{treectrl}
-@li @sample{typetest}
-@li @sample{uiaction}
-@li @sample{validate}
-@li @sample{vscroll}
-@li @sample{widgets}
-@li @sample{wizard}
-@li @sample{wrapsizer}
-@li @sample{xrc}
-</td></tr>
-@endTable
-
-
-<hr>
+@li wxWebView: @ref page_samples_webview
Notice that all wxWidgets samples mentioned above can be found in @c samples
subdirectory of the library distribution. When a @c foobar sample is mentioned
find the sample showing the control you are interested in by name. Most classes
contained in wxWidgets occur in at least one of the samples.
-
@todo Write descriptions for the samples who description started with
"This sample demonstrates", they are semi-auto generated.
+
+
@section page_samples_access Accessibility Sample
This sample shows how you can use the wxAccessible classes in a
@sampleabout{wxUIActionSimulator}
This sample shows some features of wxUIActionSimulator class. When a simulation
-is ran using its menu items, you can see that the button is pressed
+is run using its menu items, you can see that the button is pressed
programmatically and the characters generated by the program appear in the text
control.
@sampledir{vscroll}
+@section page_samples_webview wxWebView Sample
+
+The wxWebView sample demonstarates the various capabilities of the wxWebView
+control. It is set up as a simple single window web broswer, but with support
+for many of the more complex wxWebView features, including browsing through
+archives.
+
+@sampledir{webview}
+
@section page_samples_widgets Widgets Sample
The widgets sample is the main presentation program for most simple and advanced
projects / wxWidgets.git / blobdiff