]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/doxygen/mainpages/samples.h
Fix incorrect painting of backgrounds inside notebook.
[wxWidgets.git] / docs / doxygen / mainpages / samples.h
index 8763fc2110bc62c7d38e6a2c22934de7cfc41a36..a6446b91c0bb4c0cd067b8773ade115290677c81 100644 (file)
@@ -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
@@ -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.
 
-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:
@@ -38,10 +42,8 @@ may find the following samples showing the corresponding controls:
 @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
 
@@ -138,9 +140,25 @@ TODO: Organize them in a more human-readable way.
 </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.
-<hr>
 
 @section page_samples_access Accessibility Sample