fixed anchor link naming, indentation in some places, added the <hr> divisor, fixed...

[wxWidgets.git] / docs / latex / wx / tsamples.tex

diff --git a/docs/latex/wx/tsamples.tex b/docs/latex/wx/tsamples.tex
index 655441bbb780919b341adae0c664a83fc3a709dc..002e3757569ebf045badd7453d7e64e97be7168b 100644 (file)
--- a/docs/latex/wx/tsamples.tex
+++ b/docs/latex/wx/tsamples.tex
@@ -6,7 +6,7 @@
 %% Created:     02.11.99
 %% RCS-ID:      $Id$
 %% Copyright:   (c) wxWidgets team
 %% Created:     02.11.99
 %% RCS-ID:      $Id$
 %% Copyright:   (c) wxWidgets team

-%% License:     wxWidgets license
+%% License:     wxWindows license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 % NB: please keep the subsections in alphabetic order!
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 % NB: please keep the subsections in alphabetic order!
 


@@ -26,9 +26,9 @@ this list is not complete. You should start your tour of wxWidgets with the
 "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.
 
 "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 probably the \helpref{controls}{samplecontrols}
-one which shows many of wxWidgets standard controls, such as buttons,
-listboxes, checkboxes, comboboxes etc.
+The next most useful samples are probably \helpref{widgets}{samplewidgets}
+and \helpref{controls}{samplecontrols} which show many of wxWidgets native and
+generic controls, such as buttons, listboxes, checkboxes, comboboxes etc.

 
 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:


@@ -53,6 +53,13 @@ needed to write a program that will display a "hello" dialog. This is usually
 a good starting point for learning how to use wxWidgets.
 
 
 a good starting point for learning how to use wxWidgets.
 
 

+\subsection{Animate sample}\label{sampleanimate}
+
+The {\tt animate} sample shows how you can use \helpref{wxAnimationCtrl}{wxanimationctrl}
+control and shows concept of a platform-dependent animation encapsulated
+in \helpref{wxAnimation}{wxanimation}.
+
+

 \subsection{Art provider sample}\label{sampleartprovider}
 
 The {\tt artprov} sample shows how you can customize the look of standard
 \subsection{Art provider sample}\label{sampleartprovider}
 
 The {\tt artprov} sample shows how you can customize the look of standard


@@ -68,17 +75,6 @@ shows how to configure the control (see the different options in the calendar
 menu) and also how to process the notifications from it.
 
 
 menu) and also how to process the notifications from it.
 
 

-\subsection{Checklist sample}\label{samplechecklist}
-
-This sample demonstrates use of the \helpref{wxCheckListBox}{wxchecklistbox}
-class intercepting check, select and double click events. It also tests
-use of various methods modifying the control, such as by deleting items
-from it or inserting new ones (these functions are actually implemented in
-the parent class \helpref{wxListBox}{wxlistbox} so the sample tests that class
-as well). The layout of the dialog is created using a \helpref{wxBoxSizer}{wxboxsizer}
-demonstrating a simple dynamic layout.
-
-

 \subsection{Config sample}\label{sampleconfig}
 
 This sample demonstrates the \helpref{wxConfig}{wxconfigbase} classes in a platform
 \subsection{Config sample}\label{sampleconfig}
 
 This sample demonstrates the \helpref{wxConfig}{wxconfigbase} classes in a platform


@@ -122,11 +118,19 @@ The various controls tested are listed here:
 \end{twocollist}
 
 
 \end{twocollist}
 
 

-\subsection{Database sample}\label{sampledb}
+\subsection{DebugRpt sample}\label{sampledebugrpt}
+
+This sample shows how to use \helpref{wxDebugReport}{wxdebugreport} class to
+generate a debug report in case of a program crash or otherwise. On start up,
+it proposes to either crash itself (by dereferencing a NULL pointer) or
+generate debug report without doing it. Next it initializes the debug report
+with standard information adding a custom file to it (just a timestamp) and
+allows to view the information gathered using
+\helpref{wxDebugReportPreview}{wxdebugreportpreview}.

 
 

-The database sample is a small test program showing how to use the ODBC
-classes written by Remstar Intl.  Obviously, this sample requires a
-database with ODBC support to be correctly installed on your system.
+For the report processing part of the sample to work you should make available
+a Web server accepting form uploads, otherwise
+\helpref{wxDebugReportUpload}{wxdebugreportupload} will report an error.

 
 
 \subsection{Dialogs sample}\label{sampledialogs}
 
 
 \subsection{Dialogs sample}\label{sampledialogs}


@@ -188,19 +192,6 @@ Take a look at DnDShapeDataObject class to see how you may use
 \helpref{wxDataObject}{wxdataobject} to achieve this.
 
 
 \helpref{wxDataObject}{wxdataobject} to achieve this.
 
 

-\subsection{Dynamic sample}\label{sampledynamic}
-
-This sample is a very small sample that demonstrates use of the
-\helpref{wxEvtHandler::Connect}{wxevthandlerconnect} method. This method
-should be used whenever it is not known at compile time which control
-will receive which event or which controls are actually going to be in
-a dialog or frame. This is most typically the case for any scripting
-language that would work as a wrapper for wxWidgets or programs where
-forms or similar datagrams can be created by the users.
-
-See also the \helpref{event sample}{sampleevent}
-
-

 \subsection{Event sample}\label{sampleevent}
 
 The event sample demonstrates various features of the wxWidgets events. It
 \subsection{Event sample}\label{sampleevent}
 
 The event sample demonstrates various features of the wxWidgets events. It


@@ -209,8 +200,6 @@ during run time and also using
 \helpref{PushEventHandler()}{wxwindowpusheventhandler} and
 \helpref{PopEventHandler()}{wxwindowpopeventhandler}.
 
 \helpref{PushEventHandler()}{wxwindowpusheventhandler} and
 \helpref{PopEventHandler()}{wxwindowpopeventhandler}.
 

-It replaces the old dynamic sample.
-

 
 \subsection{Except(ions) sample}\label{sampleexcept}
 
 
 \subsection{Except(ions) sample}\label{sampleexcept}
 


@@ -301,6 +290,9 @@ specifying the foreground and background colours with
 bitmap is then converted to a wxImage and the foreground colour (black) is
 replaced with red using \helpref{wxImage::Replace}{wximagereplace}.
 
 bitmap is then converted to a wxImage and the foreground colour (black) is
 replaced with red using \helpref{wxImage::Replace}{wximagereplace}.
 

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

 
 \subsection{Internat(ionalization) sample}\label{sampleinternat}
 
 
 \subsection{Internat(ionalization) sample}\label{sampleinternat}
 


@@ -341,15 +333,22 @@ The sample also provides some timings for adding/deleting/sorting a lot of
 (several thousands) items into the control.
 
 
 (several thousands) items into the control.
 
 

+\subsection{Mediaplayer sample}\label{samplemediaplayer}
+
+This sample demonstrates how to use all the features of
+\helpref{wxMediaCtrl}{wxmediactrl} and play various types of sound, video,
+and other files.
+
+
+It replaces the old dynamic sample.

 
 \subsection{Notebook sample}\label{samplenotebook}
 
 
 \subsection{Notebook sample}\label{samplenotebook}
 

-This samples shows two controls at once: although initially it was written to
-demonstrate \helpref{wxNotebook}{wxnotebook} only, it can now be also used
-to see \helpref{wxListbook}{wxlistbook} and \helpref{wxChoicebook}{wxchoicebook} 
-in action. To switch between the two controls you need to manually change 
-\texttt{TEST\_LISTBOOK} definition in the file \texttt{notebook.h} and rebuild 
-the sample.
+This samples shows \helpref{wxBookCtrl}{wxbookctrloverview} family of controls.
+Although initially it was written to demonstrate \helpref{wxNotebook}{wxnotebook}
+only, it can now be also used to see \helpref{wxListbook}{wxlistbook},
+\helpref{wxChoicebook}{wxchoicebook} and \helpref{wxTreebook}{wxtreebook} in action.
+Test each of the controls, their orientation, images and pages using commands through menu.

 
 
 
 
 
 


@@ -361,15 +360,6 @@ This sample shows how to replace the default wxWidgets
 
 
 
 
 
 

-\subsection{Rotate sample}\label{samplerotate}
-
-This is a simple example which demonstrates how to rotate an image with
-the \helpref{wxImage::Rotate}{wximagerotate} method. The rotation can
-be done without interpolation (left mouse button) which will be faster,
-or with interpolation (right mouse button) which is slower but gives
-better results.
-
-

 \subsection{Scroll subwindow sample}\label{samplescrollsub}
 
 This sample demonstrates use of the \helpref{wxScrolledWindow}{wxscrolledwindow}
 \subsection{Scroll subwindow sample}\label{samplescrollsub}
 
 This sample demonstrates use of the \helpref{wxScrolledWindow}{wxscrolledwindow}


@@ -453,6 +443,18 @@ of fields) and how to use it to show icons/bitmaps and/or put arbitrary
 controls into it.
 
 
 controls into it.
 
 

+\subsection{Tab order sample}\label{sampletaborder}
+
+This sample allows to test keyboard navigation (mostly done using the 
+\texttt{\textsc{TAB}} key, hence the sample name) between different controls.
+It shows the use of 
+\helpref{wxWindow::MoveBeforeInTabOrder()}{wxwindowmovebeforeintaborder} and 
+\helpref{MoveAfterInTabOrder()}{wxwindowmoveafterintaborder} methods to change
+the default order of the windows in the navigation chain and of 
+\helpref{wxWindow::Navigate()}{wxwindownavigate} for moving focus along this
+chain.
+
+

 \subsection{Text sample}\label{sampletext}
 
 This sample demonstrates four features: firstly the use and many variants of
 \subsection{Text sample}\label{sampletext}
 
 This sample demonstrates four features: firstly the use and many variants of


@@ -537,6 +539,15 @@ sorting (in default alphabetical order as well as in custom one) is
 demonstrated here as well - try the corresponding menu entries.
 
 
 demonstrated here as well - try the corresponding menu entries.
 
 

+\subsection{Widgets sample}\label{samplewidgets}
+
+The widgets sample is the main presentation program for most simple and advanced
+native controls and complex generic widgets provided by wxWidgets.
+The sample tests their basic functionality, events, placement, modification
+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.
+

 \subsection{Wizard sample}\label{samplewizard}
 
 This sample shows the so-called wizard dialog (implemented using
 \subsection{Wizard sample}\label{samplewizard}
 
 This sample shows the so-called wizard dialog (implemented using