X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1c4293cb91327247ad69e6ec8d589bfaa299db28..d33ccbe15c60e311c2d63f5aeb1d3ff52650ac61:/docs/doxygen/mainpages/samples.h

diff --git a/docs/doxygen/mainpages/samples.h b/docs/doxygen/mainpages/samples.h
index 7334903ff7..8763fc2110 100644
--- a/docs/doxygen/mainpages/samples.h
+++ b/docs/doxygen/mainpages/samples.h
@@ -36,6 +36,7 @@ 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 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
@@ -44,7 +45,7 @@ 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/$/\}/'
+ls -1 | egrep '[a-z]+' | egrep '^[a-z]+/$' | sed 's/^/@li @sample\{/' | sed 's///$/\}/'
 
 in wxWidgets/samples
 
@@ -59,6 +60,7 @@ TODO: Organize them in a more human-readable way.
 @li @sample{aui}
 @li @sample{calendar}
 @li @sample{caret}
+@li @sample{clipboard}
 @li @sample{collpane}
 @li @sample{combo}
 @li @sample{config}
@@ -71,14 +73,13 @@ TODO: Organize them in a more human-readable way.
 @li @sample{display}
 @li @sample{dnd}
 @li @sample{docview}
-@li @sample{docvwmdi}
 @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}
@@ -98,7 +99,6 @@ TODO: Organize them in a more human-readable way.
 @li @sample{menu}
 @li @sample{mfc}
 @li @sample{minimal}
-@li @sample{mobile}
 @li @sample{nativdlg}
 @li @sample{notebook}
 @li @sample{oleauto}
@@ -114,7 +114,6 @@ TODO: Organize them in a more human-readable way.
 @li @sample{richtext}
 @li @sample{sashtest}
 @li @sample{scroll}
-@li @sample{scrollsub}
 @li @sample{shaped}
 @li @sample{sockets}
 @li @sample{sound}
@@ -254,6 +253,12 @@ The various controls tested are listed here:
 
 @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
@@ -346,15 +351,7 @@ wxDataObject to achieve this.
 
 @sampledir{docview}
 
-@see @sample{docvwmdi}, @sample{mdi}
-
-@section page_samples_docvwmdi Document/View MDI Sample
-
-@sampleabout{@ref overview_docview in MDI}
-
-@see @sample{docview}, @sample{mdi}
-
-@sampledir{docvwmdi}
+@see @sample{mdi}
 
 @section page_samples_dragimag Drag Image Sample
 
@@ -368,12 +365,6 @@ wxDataObject to achieve this.
 
 @sampledir{drawing}
 
-@section page_samples_editlbox Editable List Box Sample
-
-@sampleabout{wxEditableListBox}
-
-@sampledir{editlbox}
-
 @section page_samples_erase Erase Event Sample
 
 @sampleabout{wxEraseEvent}
@@ -417,6 +408,23 @@ wxProcess::Exists().
 
 @sampledir{exec}
 
+@section page_samples_flash Flash Sample
+
+The flash sample demonstrates embedding of Adobe Flash into a wxWidgets
+program. Currently it only works under Windows as it uses the Flash ActiveX
+control to achieve this but we hope to be able to extend it to also work under
+other platforms in the future. The sample also currently requires Microsoft
+Visual C++ compiler as it uses COM support extensions specific to this
+compiler.
+
+The sample comes with 2 Flash files (SWF), showing a simple Flash animation
+which can be controlled using the "Play", "Stop" and "Back"/"Forward" buttons
+in the sample as well as a Flash form which shows how Flash and wxWidgets
+program can exchange data: calling "GetText" function without arguments returns
+the text of the text control defined inside Flash and calling "SetText" with an
+argument sets the control contents to the given string. Finally clicking on the
+button generates an event which is caught by the C++ program.
+
 @section page_samples_font Font Sample
 
 The font sample demonstrates wxFont,
@@ -564,7 +572,7 @@ The sample also provides some timings for adding/deleting/sorting a lot of
 
 @sampleabout{MDI}
 
-@see @sample{docview}, @sample{docvwmdi}
+@see @sample{docview}
 
 @sampledir{mdi}
 
@@ -613,13 +621,6 @@ a good starting point for learning how to use wxWidgets.
 
 @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}
@@ -738,23 +739,17 @@ renderer and also how to write a shared library
 
 @sampleabout{wxScrolledWindow}
 
-@see @sample{scrollsub}
-
-@sampledir{scroll}
-
-@section page_samples_scrollsub Scroll Subwindow Sample
-
 This sample demonstrates use of the ::wxScrolledWindow
-class including placing subwindows into it and drawing simple graphics. It uses the
-SetTargetWindow method and thus the effect
-of scrolling does not show in the scrolled window itself, but in one of its subwindows.
+class including placing subwindows into it and drawing simple graphics. It uses
+the SetTargetWindow method and thus the effect of scrolling does not show in
+the scrolled window itself, but in one of its subwindows.
 
-Additionally, this samples demonstrates how to optimize drawing operations in wxWidgets,
-in particular using the wxWindow::IsExposed() method with
-the aim to prevent unnecessary drawing in the window and thus reducing or removing
-flicker on screen.
+Additionally, this samples demonstrates how to optimize drawing operations in
+wxWidgets, in particular using the wxWindow::IsExposed() method with the aim to
+prevent unnecessary drawing in the window and thus reducing or removing flicker
+on screen.
 
-@sampledir{scrollsub}
+@sampledir{scroll}
 
 @section page_samples_shaped Shaped Window Sample
 
@@ -904,20 +899,19 @@ how tooltips can be centrally disabled and their latency controlled.
 @section page_samples_thread Thread Sample
 
 This sample demonstrates use of threads in connection with GUI programs.
+
 There are two fundamentally different ways to use threads in GUI programs and
 either way has to take care of the fact that the GUI library itself usually
 is not multi-threading safe, i.e. that it might crash if two threads try to
-access the GUI class simultaneously. One way to prevent that is have a normal
-GUI program in the main thread and some worker threads which work in the
-background. In order to make communication between the main thread and the
-worker threads possible, wxWidgets offers the wxPostEvent
-function and this sample makes use of this function.
-
-The other way to use a so called Mutex (such as those offered in the wxMutex
-class) that prevent threads from accessing the GUI classes as long as any other
-thread accesses them. For this, wxWidgets has the wxMutexGuiEnter
-and wxMutexGuiLeave functions, both of which are
-used and tested in the sample as well.
+access the GUI class simultaneously.
+
+One way to prevent that is have a normal GUI program in the main thread and some
+worker threads which work in the background. In order to make communication between
+the main thread and the worker threads possible, wxWidgets offers the ::wxQueueEvent
+function and this sample demonstrates its usage.
+
+The other way is to use a ::wxMutexGuiEnter and ::wxMutexGuiLeave functions, but
+this is not currently shown in the sample.
 
 See also @ref overview_thread and wxThread.
 
@@ -966,7 +960,8 @@ demonstrated here as well - try the corresponding menu entries.
 
 @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}