]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/doxygen/mainpages/samples.h
wxMessageBox off the main thread lost result code.
[wxWidgets.git] / docs / doxygen / mainpages / samples.h
index 277738ed3675da4bfe7c0465fac7bb362be25764..e5c56758f92d4d7f616ce7cb194f6100587c8005 100644 (file)
@@ -2,7 +2,6 @@
 // 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
 /////////////////////////////////////////////////////////////////////////////
 
@@ -10,7 +9,7 @@
 
 @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
@@ -20,12 +19,11 @@ make it easier to find the relevant one if a simple grep through all sources
 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,
@@ -41,109 +39,7 @@ may find the following samples showing the corresponding controls:
 @li wxTreeCtrl: @ref page_samples_treectrl
 @li wxGrid: @ref page_samples_grid
 @li wxDataViewCtrl: @ref page_samples_dataview
-@li wxWebView: @ref page_samples_web
-
-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}
-@li @sample{regtest}
-</td><td>
-@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{web}
-@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
@@ -158,10 +54,11 @@ 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.
 
+
+
 @section page_samples_access Accessibility Sample
 
 This sample shows how you can use the wxAccessible classes in a
@@ -1020,14 +917,14 @@ control.
 
 @sampledir{vscroll}
 
-@section page_samples_web wxWebView Sample
+@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{web}
+@sampledir{webview}
 
 @section page_samples_widgets Widgets Sample