Implement hatched/stippled pens/brushes in wxGraphicsContext for Cairo.

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

diff --git a/docs/doxygen/mainpages/samples.h b/docs/doxygen/mainpages/samples.h
index ae87007e7a2f323f731a9d3197261b5d19f002c2..68314151aaca7a81fad2e8095796572f14912b10 100644 (file)
--- a/docs/doxygen/mainpages/samples.h
+++ b/docs/doxygen/mainpages/samples.h
@@ -3,14 +3,16 @@
 // Purpose:     Samples page of the Doxygen manual
 // Author:      wxWidgets team
 // RCS-ID:      $Id: utilities.h 52634 2008-03-20 13:45:17Z VS $
 // 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

 
 

-Probably the best way to learn wxWidgets is by reading the source of some 70+
+@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
 from them, but sometimes it is not simple to just choose the right sample to
 look at. This overview aims at describing what each sample does/demonstrates to
 samples provided with it. Many aspects of wxWidgets programming can be learnt
 from them, but sometimes it is not simple to just choose the right sample to
 look at. This overview aims at describing what each sample does/demonstrates to


@@ -18,16 +20,18 @@ 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.
 
 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 70 different samples as part of wxWidgets:
+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 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:
 
 Other, more complicated controls, have their own samples. In this category you
 may find the following samples showing the corresponding controls:


@@ -36,143 +40,187 @@ 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
+@li wxWebView: @ref page_samples_webview
+
+Finally, here is the full list of samples:
+<!--
+The following sample list is generated by executing command

 
 

-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.
+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>
 
 @beginInvisibleTable
 <tr><td>

-@li @ref page_samples_access
-@li @ref page_samples_animate
-@li @ref page_samples_artprovider
-@li @ref page_samples_aui
-@li @ref page_samples_calendar
-@li @ref page_samples_config
-@li @ref page_samples_controls
-@li @ref page_samples_debugrpt
-@li @ref page_samples_dialogs
-@li @ref page_samples_dialup
-@li @ref page_samples_dnd
-@li @ref page_samples_event
+@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>
 </td><td>

-@li @ref page_samples_except
-@li @ref page_samples_exec
-@li @ref page_samples_font
-@li @ref page_samples_grid
-@li @ref page_samples_html
-@li @ref page_samples_image
-@li @ref page_samples_internat
-@li @ref page_samples_layout
-@li @ref page_samples_listctrl
-@li @ref page_samples_mediaplayer
-@li @ref page_samples_minimal
-@li @ref page_samples_notebook
-@li @ref page_samples_render
+@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>
 </td><td>

-@li @ref page_samples_scrollsub
-@li @ref page_samples_sockets
-@li @ref page_samples_sound
-@li @ref page_samples_statbar
-@li @ref page_samples_taborder
-@li @ref page_samples_text
-@li @ref page_samples_thread
-@li @ref page_samples_toolbar
-@li @ref page_samples_treectrl
-@li @ref page_samples_widgets
-@li @ref page_samples_wizard
+@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{webview}
+@li @sample{widgets}
+@li @sample{wizard}
+@li @sample{wrapsizer}
+@li @sample{xrc}

 </td></tr>
 @endTable
 
 
 </td></tr>
 @endTable
 
 

-<!--
-
-TODO: write descriptions for the samples:
-
-aui
-caret
-collpane
-combo
-console
-dataview
-display
-docview
-docvwmdi
-dragimag
-drawing
-editlbox
-erase
-event
-except
-help
-htlbox
-ipc
-joytest
-keyboard
-mdi
-memcheck
-menu
-mfc
-mobile
-nativdlg
-oleauto
-opengl
-ownerdrw
-popup
-power
-printing
-regtest
-richtext
-sashtest
-scroll
-shaped
-splash
-splitter
-stc
-svg
-taskbar
-typetest
-validate
-vscroll
-xrc
-
--->
+<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.

 
 
 
 

-<hr>
+@todo Write descriptions for the samples who description started with
+ "This sample demonstrates", they are semi-auto generated.

 
 

+@section page_samples_access Accessibility Sample

 
 

-@section page_samples_access Accessibility sample
-
-The @c access sample shows how you can use the wxAccessible classes in a
+This sample shows how you can use the wxAccessible classes in a

 simple GUI program.
 
 simple GUI program.
 

+@buildwith{wxUSE_ACCESSIBILITY}
+
+@sampledir{access}

 
 

-@section page_samples_animate Animate sample
+@section page_samples_animate Animation Sample

 
 

-The @c animate sample shows how you can use wxAnimationCtrl
+This sample shows how you can use wxAnimationCtrl

 control and shows concept of a platform-dependent animation encapsulated
 in wxAnimation.
 
 control and shows concept of a platform-dependent animation encapsulated
 in wxAnimation.
 

+@sampledir{animate}

 
 

-@section page_samples_artprovider Art provider sample
+@section page_samples_artprov Art Provider Sample

 
 

-The @c artprov sample shows how you can customize the look of standard
+This sample shows how you can customize the look of standard

 wxWidgets dialogs by replacing default bitmaps/icons with your own versions.
 It also shows how you can use wxArtProvider to
 get stock bitmaps for use in your application.
 
 wxWidgets dialogs by replacing default bitmaps/icons with your own versions.
 It also shows how you can use wxArtProvider to
 get stock bitmaps for use in your application.
 

+@sampledir{artprov}
+
+@section page_samples_aui Advanced User Interface Sample

 
 

-@section page_samples_calendar Calendar sample
+@sampleabout{@ref overview_aui "AUI classes"}

 
 

-This font shows the calendar control in action. It
+@sampledir{aui}
+
+@section page_samples_calendar Calendar Sample
+
+This sample shows the calendar control in action. It

 shows how to configure the control (see the different options in the calendar
 menu) and also how to process the notifications from it.
 
 shows how to configure the control (see the different options in the calendar
 menu) and also how to process the notifications from it.
 

+@sampledir{calendar}
+
+@section page_samples_caret Caret Sample
+
+@sampleabout{wxCaret}
+
+@sampledir{caret}
+
+@section page_samples_collpane Collapsible Pane Sample
+
+@sampleabout{wxCollapsiblePane}
+
+@sampledir{collpane}

 
 

-@section page_samples_config Config sample
+@section page_samples_combo Combo Sample
+
+@sampleabout{wxComboBox\, wxComboCtrl and wxOwnerDrawnComboBox etc}
+
+@sampledir{combo}
+
+@section page_samples_config Configuration Sample

 
 This sample demonstrates the wxConfig classes in a platform
 independent way, i.e. it uses text based files to store a given configuration under
 
 This sample demonstrates the wxConfig classes in a platform
 independent way, i.e. it uses text based files to store a given configuration under


@@ -180,8 +228,15 @@ Unix and uses the Registry under Windows.
 
 See @ref overview_config for the descriptions of all features of this class.
 
 
 See @ref overview_config for the descriptions of all features of this class.
 

+@sampledir{config}
+
+@section page_samples_console Console Program Sample
+
+@sampleabout{a console program}
+
+@sampledir{console}

 
 

-@section page_samples_controls Controls sample
+@section page_samples_controls Controls Sample

 
 The controls sample is the main test program for most simple controls used in
 wxWidgets. The sample tests their basic functionality, events, placement,
 
 The controls sample is the main test program for most simple controls used in
 wxWidgets. The sample tests their basic functionality, events, placement,


@@ -210,8 +265,21 @@ The various controls tested are listed here:
 @li wxRadioButton
 @li wxSlider
 
 @li wxRadioButton
 @li wxSlider
 

+@sampledir{controls}
+
+@section page_samples_dataview wxDataViewCtrl Sample
+
+@sampleabout{wxDataViewCtrl}
+
+@sampledir{dataview}
+
+@section page_samples_clipboard Clipboard Sample
+
+@sampleabout{wxClipboard}

 
 

-@section page_samples_debugrpt DebugRpt sample
+@sampledir{clipboard}
+
+@section page_samples_debugrpt Debug Reporter Sample

 
 This sample shows how to use wxDebugReport class to
 generate a debug report in case of a program crash or otherwise. On start up,
 
 This sample shows how to use wxDebugReport class to
 generate a debug report in case of a program crash or otherwise. On start up,


@@ -225,14 +293,23 @@ For the report processing part of the sample to work you should make available
 a Web server accepting form uploads, otherwise
 wxDebugReportUpload will report an error.
 
 a Web server accepting form uploads, otherwise
 wxDebugReportUpload will report an error.
 

+@buildwith{wxUSE_DEBUGREPORT, wxUSE_ON_FATAL_EXCEPTION}
+
+@sampledir{debugrpt}

 
 

-@section page_samples_dialogs Dialogs sample
+@section page_samples_dialogs Dialogs Sample

 
 This sample shows how to use the common dialogs available from wxWidgets. These
 dialogs are described in detail in the @ref overview_cmndlg.
 
 
 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
+@section page_samples_dialup Dialup Sample

 
 This sample shows the wxDialUpManager
 class. In the status bar, it displays the information gathered through its
 
 This sample shows the wxDialUpManager
 class. In the status bar, it displays the information gathered through its


@@ -245,8 +322,15 @@ Using the menu entries, you may also dial or hang up the line if you have a
 modem attached and (this only makes sense for Windows) list the available
 connections.
 
 modem attached and (this only makes sense for Windows) list the available
 connections.
 

+@sampledir{dialup}
+
+@section page_samples_display Display Sample
+
+@sampleabout{wxDisplay}
+
+@sampledir{display}

 
 

-@section page_samples_dnd DnD sample
+@section page_samples_dnd Drag & Drop Sample

 
 This sample shows both clipboard and drag and drop in action. It is quite non
 trivial and may be safely used as a basis for implementing the clipboard and
 
 This sample shows both clipboard and drag and drop in action. It is quite non
 trivial and may be safely used as a basis for implementing the clipboard and


@@ -284,29 +368,58 @@ programs as well - try Write/Wordpad, for example).
 Take a look at DnDShapeDataObject class to see how you may use
 wxDataObject to achieve this.
 
 Take a look at DnDShapeDataObject class to see how you may use
 wxDataObject to achieve this.
 

+@sampledir{dnd}
+
+@section page_samples_docview Document/View Sample
+
+@sampleabout{@ref overview_docview}
+
+@sampledir{docview}
+
+@see @sample{mdi}
+
+@section page_samples_dragimag Drag Image Sample

 
 

-@section page_samples_event Event sample
+@sampleabout{wxDragImage}

 
 

-The event sample demonstrates various features of the wxWidgets events. It
-shows using dynamic events and connecting/disconnecting the event handlers
-during run time and also using
-PushEventHandler() and
-PopEventHandler().
+@sampledir{dragimag}

 
 

+@section page_samples_drawing Drawing Sample

 
 

-@section page_samples_except Except(ions) sample
+@sampleabout{the drawing ability of wxDC}
+
+@sampledir{drawing}
+
+@section page_samples_erase Erase Event Sample
+
+@sampleabout{wxEraseEvent}
+
+@sampledir{erase}
+
+@section page_samples_event Event Sample
+
+This sample demonstrates various features of the wxWidgets events. It
+shows how to dynamic events and connecting/disconnecting the event handlers
+during run time by using wxEvtHandler::Connect() and wxEvtHandler::Disconnect(),
+and also how to use wxWindow::PushEventHandler() and wxWindow::PopEventHandler().
+
+@sampledir{event}
+
+@section page_samples_except Exception Sample

 
 This very simple sample shows how to use C++ exceptions in wxWidgets programs,
 i.e. where to catch the exception which may be thrown by the program code. It
 doesn't do anything very exciting by itself, you need to study its code to
 understand what goes on.
 
 
 This very simple sample shows how to use C++ exceptions in wxWidgets programs,
 i.e. where to catch the exception which may be thrown by the program code. It
 doesn't do anything very exciting by itself, you need to study its code to
 understand what goes on.
 

+<b>Build Note:</b>

 You need to build the library with @c wxUSE_EXCEPTIONS being set to @c 1
 and compile your code with C++ exceptions support to be able to build this
 sample.
 
 You need to build the library with @c wxUSE_EXCEPTIONS being set to @c 1
 and compile your code with C++ exceptions support to be able to build this
 sample.
 

+@sampledir{except}

 
 

-@section page_samples_exec Exec sample
+@section page_samples_exec External Program Execution Sample

 
 The exec sample demonstrates the wxExecute and
 wxShell functions. Both of them are used to execute the
 
 The exec sample demonstrates the wxExecute and
 wxShell functions. Both of them are used to execute the


@@ -315,11 +428,29 @@ until the program terminates) or asynchronously (notification will come later).
 
 It also shows how to capture the output of the child process in both
 synchronous and asynchronous cases and how to kill the processes with
 
 It also shows how to capture the output of the child process in both
 synchronous and asynchronous cases and how to kill the processes with

-wxProcess::Kill and test for their existence with
-wxProcess::Exists.
+wxProcess::Kill() and test for their existence with
+wxProcess::Exists().
+
+@sampledir{exec}

 
 

+@section page_samples_flash Flash Sample

 
 

-@section page_samples_font Font 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,
 wxFontEnumerator and
 
 The font sample demonstrates wxFont,
 wxFontEnumerator and


@@ -327,16 +458,23 @@ wxFontMapper classes. It allows you to see the fonts
 available (to wxWidgets) on the computer and shows all characters of the
 chosen font as well.
 
 available (to wxWidgets) on the computer and shows all characters of the
 chosen font as well.
 

+@sampledir{font}
+
+@section page_samples_grid Grid Sample

 
 

-@section page_samples_grid Grid sample
+@sampleabout{wxGrid}

 
 

-@todo WRITE THIS DESCRIPTION.
+@sampledir{grid}

 
 

+@section page_samples_help Help Sample

 
 

-@section page_samples_html HTML samples
+@sampleabout{wxHelpController}

 
 

-Eight HTML samples (you can find them in directory @c samples/html)
-cover all features of the HTML sub-library.
+@sampledir{help}
+
+@section page_samples_html HTML Sample
+
+Eight HTML samples cover all features of the HTML sub-library.

 
 @li @b Test demonstrates how to create wxHtmlWindow
 and also shows most supported HTML tags.
 
 @li @b Test demonstrates how to create wxHtmlWindow
 and also shows most supported HTML tags.


@@ -364,8 +502,15 @@ wxHtmlHelpController in your application
 while @e Helpview is a simple tool that only pops up the help window and
 displays help books given at command line.
 
 while @e Helpview is a simple tool that only pops up the help window and
 displays help books given at command line.
 

+@sampledir{html}
+
+@section page_samples_htlbox HTML List Box Sample

 
 

-@section page_samples_image Image sample
+@sampleabout{wxHtmlListBox}
+
+@sampledir{htlbox}
+
+@section page_samples_image Image Sample

 
 The image sample demonstrates use of the wxImage class
 and shows how to download images in a variety of formats, currently PNG, GIF,
 
 The image sample demonstrates use of the wxImage class
 and shows how to download images in a variety of formats, currently PNG, GIF,


@@ -378,28 +523,54 @@ and wxBitmap as well as loading and saving PNG files are tested.
 At the bottom of the main frame there is a test for using a monochrome bitmap by
 drawing into a wxMemoryDC. The bitmap is then drawn
 specifying the foreground and background colours with
 At the bottom of the main frame there is a test for using a monochrome bitmap by
 drawing into a wxMemoryDC. The bitmap is then drawn
 specifying the foreground and background colours with

-wxDC::SetTextForeground and
-wxDC::SetTextBackground (on the left). The
+wxDC::SetTextForeground() and
+wxDC::SetTextBackground() (on the left). The

 bitmap is then converted to a wxImage and the foreground colour (black) is
 bitmap is then converted to a wxImage and the foreground colour (black) is

-replaced with red using wxImage::Replace.
+replaced with red using wxImage::Replace().

 
 This sample also contains the code for testing the image rotation and resizing
 and using raw bitmap access, see the corresponding menu commands.
 
 
 This sample also contains the code for testing the image rotation and resizing
 and using raw bitmap access, see the corresponding menu commands.
 

+@sampledir{image}

 
 

-@section page_samples_internat Internat(ionalization) sample
+@section page_samples_internat Internationalization Sample

 
 The not very clearly named internat sample demonstrates the wxWidgets
 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
 
 The not very clearly named internat sample demonstrates the wxWidgets
 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
 
 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}
+
+@section page_samples_ipc Connection Sample
+
+@sampleabout{wxConnection}
+
+@sampledir{ipc}
+
+@section page_samples_joytest Joystick Sample
+
+@sampleabout{wxJoystick}

 
 

+@sampledir{joytest}

 
 

-@section page_samples_layout Layout sample
+@section page_samples_keyboard Key Event Sample
+
+@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

 
 The layout sample demonstrates the two different layout systems offered
 by wxWidgets. When starting the program, you will see a frame with some
 
 The layout sample demonstrates the two different layout systems offered
 by wxWidgets. When starting the program, you will see a frame with some


@@ -415,8 +586,9 @@ a wxBoxSizer in a simple dialog and the other one
 showing how to use sizers in connection with a wxNotebook
 class. See also wxSizer.
 
 showing how to use sizers in connection with a wxNotebook
 class. See also wxSizer.
 

+@sampledir{layout}

 
 

-@section page_samples_listctrl Listctrl sample
+@section page_samples_listctrl List Control Sample

 
 This sample shows the wxListCtrl control. Different modes
 supported by the control (list, icons, small icons, report) may be chosen from
 
 This sample shows the wxListCtrl control. Different modes
 supported by the control (list, icons, small icons, report) may be chosen from


@@ -425,55 +597,202 @@ the menu.
 The sample also provides some timings for adding/deleting/sorting a lot of
 (several thousands) items into the control.
 
 The sample also provides some timings for adding/deleting/sorting a lot of
 (several thousands) items into the control.
 

+@sampledir{listctrl}
+
+@section page_samples_mdi MDI Sample
+
+@sampleabout{MDI}

 
 

-@section page_samples_mediaplayer Mediaplayer sample
+@see @sample{docview}
+
+@sampledir{mdi}
+
+@section page_samples_mediaplayer Mediaplayer Sample

 
 This sample demonstrates how to use all the features of
 wxMediaCtrl and play various types of sound, video,
 and other files.
 
 
 This sample demonstrates how to use all the features of
 wxMediaCtrl and play various types of sound, video,
 and other files.
 

-It replaces the old dynamic sample.
+It replaces the old @c dynamic sample.
+
+@sampledir{mediaplayer}
+
+@section page_samples_memcheck Memory Checking Sample
+
+@sampleabout{memory tracing using wxDebugContext}

 
 

+@sampledir{memcheck}

 
 

-@section page_samples_minimal Minimal sample
+@buildwith{wxUSE_MEMORY_TRACING, wxUSE_DEBUG_CONTEXT}
+
+@section page_samples_menu Menu Sample
+
+@sampleabout{wxMenu classes}
+
+@sampledir{menu}
+
+@section page_samples_mfc MFC Sample
+
+@sampleabout{how to mix MFC and wxWidgets code}
+It pops up an initial wxWidgets frame, with a menu item
+that allows a new MFC window to be created.
+
+For build instructions please read IMPORTANT NOTES in @c mfctest.cpp.
+
+@onlyfor{wxmsw}
+
+@sampledir{mfc}
+
+@section page_samples_minimal Minimal Sample

 
 The minimal sample is what most people will know under the term Hello World,
 i.e. a minimal program that doesn't demonstrate anything apart from what is
 needed to write a program that will display a "hello" dialog. This is usually
 a good starting point for learning how to use wxWidgets.
 
 
 The minimal sample is what most people will know under the term Hello World,
 i.e. a minimal program that doesn't demonstrate anything apart from what is
 needed to write a program that will display a "hello" dialog. This is usually
 a good starting point for learning how to use wxWidgets.
 

+@sampledir{minimal}
+
+@section page_samples_nativdlg Native Windows Dialog Sample
+
+@sampleabout{native windows dialog}

 
 

-@section page_samples_notebook Notebook sample
+@onlyfor{wxmsw}
+
+@sampledir{nativdlg}
+
+@section page_samples_notebook Notebook Sample

 
 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,
 
 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
 Test each of the controls, their orientation, images and pages using

-commands through menu.
+commands through the menu.
+
+@sampledir{notebook}
+
+@section page_samples_oleauto OLE Automation Sample
+
+@sampleabout{OLE automation using wxAutomationObject}
+
+@onlyfor{wxmsw}
+
+@sampledir{oleauto}
+
+@section page_samples_opengl OpenGL Sample
+
+@sampleabout{wxGLCanvas}
+
+@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}
+
+@section page_samples_ownerdrw Owner-drawn Sample
+
+@sampleabout{owner-drawn wxMenuItem\, wxCheckList and wxListBox}
+
+<!--It's weird that it doesn't need <wx/ownerdrw.h> and class wxOwnerDrawn!-->
+
+@sampledir{ownerdrw}
+
+@section page_samples_popup Popup Transient Window Sample
+
+@sampleabout{wxPopupTransientWindow}
+
+@sampledir{popup}
+
+@section page_samples_power Power Management Sample
+
+@sampleabout{wxWidgets power management}
+
+@see wxPowerEvent
+
+@sampledir{power}
+
+@section page_samples_printing Printing Sample

 
 

+@sampleabout{printing}

 
 

-@section page_samples_render Render sample
+@see @ref overview_printing, @ref overview_unixprinting
+
+@buildwith{wxUSE_PRINTING_ARCHITECTURE}
+
+@sampledir{printing}
+
+@section page_samples_propgrid wxPropertyGrid Sample
+
+Sample application has following additional examples of custom properties:
+- wxFontDataProperty ( edits wxFontData )
+- wxPointProperty ( edits wxPoint )
+- wxSizeProperty ( edits wxSize )
+- wxAdvImageFileProperty ( like wxImageFileProperty, but also has a drop-down
+  for recent image selection )
+- wxDirsProperty ( edits a wxArrayString consisting of directory strings)
+- wxArrayDoubleProperty ( edits wxArrayDouble )
+
+@sampleabout{wxPropertyGrid}
+
+@sampledir{propgrid}
+
+@section page_samples_regtest Registry Sample
+
+@sampleabout{wxRegKey}
+
+<!--Its directory name doesn't seem to be proper.-->
+
+@onlyfor{wxmsw}
+
+@sampledir{regtest}
+
+@section page_samples_render Render Sample

 
 This sample shows how to replace the default wxWidgets
 renderer and also how to write a shared library
 (DLL) implementing a renderer and load and unload it during the run-time.
 
 
 This sample shows how to replace the default wxWidgets
 renderer and also how to write a shared library
 (DLL) implementing a renderer and load and unload it during the run-time.
 

+@sampledir{render}
+
+@section page_samples_richtext wxRichTextCtrl Sample
+
+@sampleabout{wxRichTextCtrl}
+
+@sampledir{richtext}
+
+@section page_samples_sashtest Sash Sample
+
+@sampleabout{wxSashWindow classes}

 
 

-@section page_samples_scrollsub Scroll subwindow sample
+@sampledir{sashtest}
+
+@section page_samples_scroll Scroll Window Sample
+
+@sampleabout{wxScrolledWindow}

 
 This sample demonstrates use of the ::wxScrolledWindow
 
 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.
+
+@sampledir{scroll}
+
+@section page_samples_shaped Shaped Window Sample

 
 

-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.
+@sampleabout{how to implement a shaped or transparent window\, and a window showing/hiding with effect}

 
 

+@see wxTopLevelWindow::SetShape(), wxTopLevelWindow::SetTransparent(),
+wxWindow::ShowWithEffect(), wxWindow::HideWithEffect()

 
 

-@section page_samples_sockets Sockets sample
+@sampledir{shaped}
+
+@section page_samples_sockets Sockets Sample

 
 The sockets sample demonstrates how to use the communication facilities
 provided by wxSocket. There are two different
 
 The sockets sample demonstrates how to use the communication facilities
 provided by wxSocket. There are two different


@@ -505,8 +824,8 @@ to specify the address of the server you are going to connect to (the
 TCP port number is hard-coded as 3000). Once connected, a number of
 tests are possible. Currently, three tests are implemented. They show
 how to use the basic IO calls in wxSocketBase,
 TCP port number is hard-coded as 3000). Once connected, a number of
 tests are possible. Currently, three tests are implemented. They show
 how to use the basic IO calls in wxSocketBase,

-such as wxSocketBase::Read, wxSocketBase::Write,
-wxSocketBase::ReadMsg and wxSocketBase::WriteMsg,
+such as wxSocketBase::Read(), wxSocketBase::Write(),
+wxSocketBase::ReadMsg() and wxSocketBase::WriteMsg(),

 and how to set up the correct IO flags depending on what you are going to
 do. See the comments in the code for more information. Note that because
 both clients and connection objects in the server set up an event handler
 and how to set up the correct IO flags depending on what you are going to
 do. See the comments in the code for more information. Note that because
 both clients and connection objects in the server set up an event handler


@@ -523,14 +842,28 @@ The sockets sample is work in progress. Some things to do:
 @li Tests for the recently added (and still in alpha stage) datagram sockets.
 @li New samples which actually do something useful (suggestions accepted).
 
 @li Tests for the recently added (and still in alpha stage) datagram sockets.
 @li New samples which actually do something useful (suggestions accepted).
 

+@sampledir{sockets}

 
 

-@section page_samples_sound Sound sample
+@section page_samples_sound Sound Sample

 
 The @c sound sample shows how to use wxSound for simple
 audio output (e.g. notifications).
 
 
 The @c sound sample shows how to use wxSound for simple
 audio output (e.g. notifications).
 

+@sampledir{sound}
+
+@section page_samples_splash Splash Screen Sample
+
+@sampleabout{wxSplashScreen}
+
+@sampledir{splash}
+
+@section page_samples_splitter Splitter Window Sample
+
+@sampleabout{wxSplitterWindow}

 
 

-@section page_samples_statbar Statbar sample
+@sampledir{splitter}
+
+@section page_samples_statbar Status Bar Sample

 
 This sample shows how to create and use wxStatusBar. Although most of the
 samples have a statusbar, they usually only create a default one and only
 
 This sample shows how to create and use wxStatusBar. Although most of the
 samples have a statusbar, they usually only create a default one and only


@@ -540,8 +873,21 @@ Here you can see how to recreate the statusbar (with possibly different number
 of fields) and how to use it to show icons/bitmaps and/or put arbitrary
 controls into it.
 
 of fields) and how to use it to show icons/bitmaps and/or put arbitrary
 controls into it.
 

+@sampledir{statbar}
+
+@section page_samples_stc wxStyledTextCtrl Sample
+
+@sampleabout{wxStyledTextCtrl}
+
+@sampledir{stc}
+
+@section page_samples_svg SVG Sample

 
 

-@section page_samples_taborder Tab order sample
+@sampleabout{wxSVGFileDC}
+
+@sampledir{svg}
+
+@section page_samples_taborder Tab Order Sample

 
 This sample allows to test keyboard navigation (mostly done using the
 @c TAB key, hence the sample name) between different controls.
 
 This sample allows to test keyboard navigation (mostly done using the
 @c TAB key, hence the sample name) between different controls.


@@ -551,8 +897,15 @@ the default order of the windows in the navigation chain and of
 wxWindow::Navigate() for moving focus along this
 chain.
 
 wxWindow::Navigate() for moving focus along this
 chain.
 

+@sampledir{taborder}
+
+@section page_samples_taskbar Task Bar Icon Sample

 
 

-@section page_samples_text Text sample
+@sampleabout{wxTaskBarIcon}
+
+@sampledir{taskbar}
+
+@section page_samples_text Text Sample

 
 This sample demonstrates four features: firstly the use and many variants of
 the wxTextCtrl class (single line, multi line, read only,
 
 This sample demonstrates four features: firstly the use and many variants of
 the wxTextCtrl class (single line, multi line, read only,


@@ -570,43 +923,44 @@ wxClipboard and to paste text from it. The GTK version will
 use the so called PRIMARY SELECTION, which is the pseudo clipboard under X and
 best known from pasting text to the XTerm program.
 
 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}

 
 

-@section page_samples_thread Thread sample
+@section page_samples_thread Thread Sample

 
 This sample demonstrates use of threads in connection with GUI programs.
 
 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
 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.
 
 
 See also @ref overview_thread and wxThread.
 

+@sampledir{thread}

 
 

-@section page_samples_toolbar Toolbar sample
+@section page_samples_toolbar Tool Bar Sample

 
 The toolbar sample shows the wxToolBar class in action.
 
 The following things are demonstrated:
 
 
 The toolbar sample shows the wxToolBar class in action.
 
 The following things are demonstrated:
 

-@li Creating the toolbar using wxToolBar::AddTool and wxToolBar::AddControl: see
-    MyApp::InitToolbar in the sample.
+@li Creating the toolbar using wxToolBar::AddTool() and wxToolBar::AddControl(): see
+    MyApp::InitToolbar() in the sample.

 @li Using @c EVT_UPDATE_UI handler for automatically enabling/disabling
     toolbar buttons without having to explicitly call EnableTool. This is done
 @li Using @c EVT_UPDATE_UI handler for automatically enabling/disabling
     toolbar buttons without having to explicitly call EnableTool. This is done

-    in MyFrame::OnUpdateCopyAndCut.
-@li Using wxToolBar::DeleteTool and wxToolBar::InsertTool to dynamically update the
+    in MyFrame::OnUpdateCopyAndCut().
+@li Using wxToolBar::DeleteTool() and wxToolBar::InsertTool() to dynamically update the

     toolbar.
 
 Some buttons in the main toolbar are check buttons, i.e. they stay checked when
     toolbar.
 
 Some buttons in the main toolbar are check buttons, i.e. they stay checked when


@@ -619,8 +973,9 @@ see the radio toolbar buttons in action: the first three buttons form a radio
 group, i.e. checking any of them automatically unchecks the previously
 checked one.
 
 group, i.e. checking any of them automatically unchecks the previously
 checked one.
 

+@sampledir{toolbar}

 
 

-@section page_samples_treectrl Treectrl sample
+@section page_samples_treectrl wxTreeCtrl Sample

 
 This sample demonstrates using the wxTreeCtrl class. Here
 you may see how to process various notification messages sent by this control
 
 This sample demonstrates using the wxTreeCtrl class. Here
 you may see how to process various notification messages sent by this control


@@ -631,8 +986,50 @@ Adding, inserting and deleting items and branches from the tree as well as
 sorting (in default alphabetical order as well as in custom one) is
 demonstrated here as well - try the corresponding menu entries.
 
 sorting (in default alphabetical order as well as in custom one) is
 demonstrated here as well - try the corresponding menu entries.
 

+@sampledir{treectrl}
+
+@section page_samples_typetest Types Sample
+
+@sampleabout{wxWidgets types}
+
+@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"

 
 

-@section page_samples_widgets Widgets sample
+@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{validate}
+
+@section page_samples_vscroll VScrolled Window Sample
+
+@sampleabout{wxVScrolledWindow}
+
+@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
 native controls and complex generic widgets provided by wxWidgets.
 
 The widgets sample is the main presentation program for most simple and advanced
 native controls and complex generic widgets provided by wxWidgets.


@@ -641,8 +1038,9 @@ in terms of colour and font as well as the possibility to change
 the controls programmatically, such as adding an item to a list box etc.
 All widgets are categorized for easy browsing.
 
 the controls programmatically, such as adding an item to a list box etc.
 All widgets are categorized for easy browsing.
 

+@sampledir{widgets}

 
 

-@section page_samples_wizard Wizard sample
+@section page_samples_wizard Wizard Sample

 
 This sample shows the so-called wizard dialog (implemented using
 wxWizard and related classes). It shows almost all
 
 This sample shows the so-called wizard dialog (implemented using
 wxWizard and related classes). It shows almost all


@@ -664,5 +1062,31 @@ features supported:
     dynamically decide which page to display next (see also
     wxWizardPage)
 
     dynamically decide which page to display next (see also
     wxWizardPage)
 

+@sampledir{wizard}
+
+@section page_samples_wrapsizer wxWrapSizer Sample
+
+@sampleabout{wxWrapSizer}
+
+@sampledir{wrapsizer}
+
+@section page_samples_xrc XRC Sample
+
+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}
+

 */
 
 */