// 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 license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
-@page page_samples Included Samples
+@page page_samples Samples Overview
+
+@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 samples are probably @ref page_samples_widgets and
-@ref page_samples_controls which show many of wxWidgets native and
-generic controls, such as buttons, listboxes, checkboxes, comboboxes etc.
+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,
+combo boxes etc. It is organized in many different source files, one per each
+control, which makes it easier to study it, and also allows to change various
+control styles and call its methods interactively.
Other, more complicated controls, have their own samples. In this category you
may find the following samples showing the corresponding controls:
@li wxListCtrl: @ref page_samples_listctrl
@li wxTreeCtrl: @ref page_samples_treectrl
@li wxGrid: @ref page_samples_grid
-
-Finally, it might be helpful to do a search in the entire sample directory if
-you can't 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.
-
-<!--
-The following sample list is generated by executing command
-
-ls | 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{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{editlbox}
-@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{mobile}
-@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{validate}
-@li @sample{vscroll}
-@li @sample{widgets}
-@li @sample{wizard}
-@li @sample{wrapsizer}
-@li @sample{xrc}
-</td></tr>
-@endTable
+@li wxDataViewCtrl: @ref page_samples_dataview
+@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
+below, its sources can be found in @c samples/foobar directory of your
+wxWidgets tree. If you installed wxWidgets from a binary package, you might not
+have this directory. In this case, you may view the samples online at
+http://svn.wxwidgets.org/viewvc/wx/wxWidgets/trunk/samples/ but you need to
+download the source distribution in order to be able to build them (highly
+recommended).
+
+Final advice is to do a search in the entire samples directory if you can't
+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.
-<hr>
+
+
@section page_samples_access Accessibility Sample
@sampledir{dataview}
+@section page_samples_clipboard Clipboard Sample
+
+@sampleabout{wxClipboard}
+
+@sampledir{clipboard}
+
@section page_samples_debugrpt Debug Reporter Sample
This sample shows how to use wxDebugReport class to
This sample shows how to use the common dialogs available from wxWidgets. These
dialogs are described in detail in the @ref overview_cmndlg.
+In addition to the dialogs accessible from the sample menus, you can also run
+it with a <code>--progress=style</code> command line option to show a
+wxProgressDialog with the given style (try 0 for the default style) on program
+startup, before the main window is shown.
+
@sampledir{dialogs}
@section page_samples_dialup Dialup Sample
@sampledir{drawing}
-@section page_samples_editlbox Editable List Box Sample
-
-@sampleabout{wxEditableListBox}
-
-@sampledir{editlbox}
-
@section page_samples_erase Erase Event Sample
@sampleabout{wxEraseEvent}
internationalization (i18n for short from now on) features. To be more
precise, it only shows localization support, i.e. support for translating the
program messages into another language while true i18n would also involve
-changing the other aspects of the programs behaviour.
+changing the other aspects of the program's behaviour.
More information about this sample can be found in the @c readme.txt file in
-its directory. Please also see the @ref overview_i18n.
+its directory. Please also see the @ref overview_i18n overview.
@sampledir{internat}
@sampleabout{wxKeyEvent}
+This sample can be used to interactively test the events produced by pressing
+various keyboard keys. It also shows the interaction between accelerators and
+the normal keyboard events (which are overridden by any defined accelerators)
+and finally allows to test that not skipping an event in EVT_KEY_DOWN handler
+suppresses the subsequent EVT_CHAR event.
+
@sampledir{keyboard}
@section page_samples_layout Layout Sample
@sampledir{minimal}
-@section page_samples_mobile Mobile Sample
-
-@todo Figure out what this sample is written for, maybe remove it from samples,
-since it seems to an incomplete test program (for mobile phone?)
-
-@sampledir{mobile}
-
@section page_samples_nativdlg Native Windows Dialog Sample
@sampleabout{native windows dialog}
This samples shows wxBookCtrl family of controls.
Although initially it was written to demonstrate wxNotebook
only, it can now be also used to see wxListbook,
-wxChoicebook and wxTreebook in action.
+wxChoicebook, wxTreebook and wxToolbook in action.
Test each of the controls, their orientation, images and pages using
-commands through menu.
+commands through the menu.
@sampledir{notebook}
@sampleabout{wxGLCanvas}
-@li @b cube Draws only a cube to demonstrate how to write a basic wxWidgets OpenGL program.
-@li @b isosurf Draws a surface by reading coordinates from a dat file.
-@li @b penguin Draws a rotatable penguin by reading data from a dxf file.
+@li @b cube Draws a cube to demonstrate how to write a basic wxWidgets OpenGL program.
+ Arrow keys rotate the cube. Space bar toggles spinning.
+@li @b isosurf Draws a surface by reading coordinates from a DAT file.
+@li @b penguin Draws a rotatable penguin by reading data from a DXF file.
@sampledir{opengl}
use the so called PRIMARY SELECTION, which is the pseudo clipboard under X and
best known from pasting text to the XTerm program.
-Last not least: some of the text controls have tooltips and the sample also shows
-how tooltips can be centrally disabled and their latency controlled.
+Last but not least: some of the text controls have tooltips and the sample also
+shows how tooltips can be centrally disabled and their latency controlled.
@sampledir{text}
@sampleabout{wxWidgets types}
-@todo Rewrite its description ASAP.
+@todo This sample isn't very didactive; it's more than a set of tests rather
+ than a sample and thus should be rewritten with CppUnit and moved under "tests"
@sampledir{typetest}
+@section page_samples_uiaction wxUIActionSimulator Sample
+
+@sampleabout{wxUIActionSimulator}
+
+This sample shows some features of wxUIActionSimulator class. When a simulation
+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{uiaction}
+
@section page_samples_validate Validator Sample
@sampleabout{wxValidator}
@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
@section page_samples_xrc XRC Sample
-@sampleabout{@ref overview_xrc}
+This sample shows how to use the various features of the @ref overview_xrc to
+create the gui of your program. It starts by loading and showing a frame and
+other resources. From its menu or toolbar you can then run the following dialogs:
+
+@li A non-derived wxDialog
+@li A derived dialog
+@li A dialog containing a large number of controls
+@li An uncentred dialog
+@li A dialog demonstrating the use of object references and ID ranges
+@li A dialog that contains a custom class
+@li A dialog with platform-specific features
+@li A dialog demonstrating wxArtProvider
+@li A dialog saying "VARIABLE EXPANSION ISN'T IMPLEMENTED CURRENTLY" :/
@sampledir{xrc}
projects / wxWidgets.git / blobdiff