Remove hard TABs from 3rd party files in src directory.

[wxWidgets.git] / docs / doxygen / mainpages / samples.h

diff --git a/docs/doxygen/mainpages/samples.h b/docs/doxygen/mainpages/samples.h
index bfec6ec9888e183ca99ffb274a513ff7c509580b..a6446b91c0bb4c0cd067b8773ade115290677c81 100644 (file)
--- a/docs/doxygen/mainpages/samples.h
+++ b/docs/doxygen/mainpages/samples.h
@@ -8,7 +8,9 @@
 
 /**
 
 
 /**
 

-@page page_samples Included Samples
+@page page_samples Samples Overview
+
+@brief Overview of the examples provided with wxWidgets.

 
 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
 
 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


@@ -25,9 +27,11 @@ 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.
 
 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:
 
 Other, more complicated controls, have their own samples. In this category you
 may find the following samples showing the corresponding controls:


@@ -36,15 +40,14 @@ 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
 @li wxListCtrl: @ref page_samples_listctrl
 @li wxTreeCtrl: @ref page_samples_treectrl
 @li wxGrid: @ref page_samples_grid

+@li wxDataViewCtrl: @ref page_samples_dataview

 
 

-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.

 
 

+Finally, here is the full list of samples:

 <!--
 The following sample list is generated by executing command
 
 <!--
 The following sample list is generated by executing command
 

-ls | egrep '[a-z]+' | egrep '^[a-z]+$' | sed 's/^/@li @sample\{/' | sed 's/$/\}/'
+ls -1 | egrep '[a-z]+' | egrep '^[a-z]+/$' | sed 's/^/@li @sample\{/' | sed 's///$/\}/'

 
 in wxWidgets/samples
 
 
 in wxWidgets/samples
 


@@ -59,6 +62,7 @@ TODO: Organize them in a more human-readable way.
 @li @sample{aui}
 @li @sample{calendar}
 @li @sample{caret}
 @li @sample{aui}
 @li @sample{calendar}
 @li @sample{caret}

+@li @sample{clipboard}

 @li @sample{collpane}
 @li @sample{combo}
 @li @sample{config}
 @li @sample{collpane}
 @li @sample{combo}
 @li @sample{config}


@@ -73,7 +77,6 @@ TODO: Organize them in a more human-readable way.
 @li @sample{docview}
 @li @sample{dragimag}
 @li @sample{drawing}
 @li @sample{docview}
 @li @sample{dragimag}
 @li @sample{drawing}

-@li @sample{editlbox}

 @li @sample{erase}
 @li @sample{event}
 @li @sample{except}
 @li @sample{erase}
 @li @sample{event}
 @li @sample{except}


@@ -98,7 +101,6 @@ TODO: Organize them in a more human-readable way.
 @li @sample{menu}
 @li @sample{mfc}
 @li @sample{minimal}
 @li @sample{menu}
 @li @sample{mfc}
 @li @sample{minimal}

-@li @sample{mobile}

 @li @sample{nativdlg}
 @li @sample{notebook}
 @li @sample{oleauto}
 @li @sample{nativdlg}
 @li @sample{notebook}
 @li @sample{oleauto}


@@ -138,9 +140,25 @@ TODO: Organize them in a more human-readable way.
 </td></tr>
 @endTable
 
 </td></tr>
 @endTable
 

+
+<hr>
+
+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.
 @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
 
 
 @section page_samples_access Accessibility Sample
 


@@ -253,6 +271,12 @@ The various controls tested are listed here:
 
 @sampledir{dataview}
 
 
 @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
 @section page_samples_debugrpt Debug Reporter Sample
 
 This sample shows how to use wxDebugReport class to


@@ -359,12 +383,6 @@ wxDataObject to achieve this.
 
 @sampledir{drawing}
 
 
 @sampledir{drawing}
 

-@section page_samples_editlbox Editable List Box Sample
-
-@sampleabout{wxEditableListBox}
-
-@sampledir{editlbox}
-

 @section page_samples_erase Erase Event Sample
 
 @sampleabout{wxEraseEvent}
 @section page_samples_erase Erase Event Sample
 
 @sampleabout{wxEraseEvent}


@@ -621,13 +639,6 @@ a good starting point for learning how to use wxWidgets.
 
 @sampledir{minimal}
 
 
 @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}
 @section page_samples_nativdlg Native Windows Dialog Sample
 
 @sampleabout{native windows dialog}


@@ -967,7 +978,8 @@ demonstrated here as well - try the corresponding menu entries.
 
 @sampleabout{wxWidgets types}
 
 
 @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}
 
 
 @sampledir{typetest}