X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c16b8e18ff2fc8862a44f7756e4510235b71cd4f..9e152a55785098472ca1c0df110ad0a1203f710f:/docs/latex/wx/tsamples.tex

diff --git a/docs/latex/wx/tsamples.tex b/docs/latex/wx/tsamples.tex
index 4dbe0e5073..3db6df7f17 100644
--- a/docs/latex/wx/tsamples.tex
+++ b/docs/latex/wx/tsamples.tex
@@ -5,29 +5,29 @@
 %% Modified by:
 %% Created:     02.11.99
 %% RCS-ID:      $Id$
-%% Copyright:   (c) wxWindows team
-%% License:     wxWindows license
+%% Copyright:   (c) wxWidgets team
+%% License:     wxWidgets license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 % NB: please keep the subsections in alphabetic order!
 
-\section{wxWindows samples}\label{samples}
+\section{wxWidgets samples}\label{samples}
 
-Probably the best way to learn wxWindows is by reading the source of some 50+
-samples provided with it. Many aspects of wxWindows programming can be learnt
+Probably the best way to learn wxWidgets is by reading the source of some 50+
+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
 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 wxWindows are they supposed to test.
+features of wxWidgets are they supposed to test.
 
-There are currently more than 50 different samples as part of wxWindows and
-this list is not complete. You should start your tour of wxWindows with the 
-\helpref{minimal sample}{sampleminimal} which is the wxWindows version of
-"Hello, world!". It shows the basic structure of wxWindows program and is the
+There are currently more than 50 different samples as part of wxWidgets and
+this list is not complete. You should start your tour of wxWidgets with the 
+\helpref{minimal sample}{sampleminimal} 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 sample is probably the \helpref{controls}{samplecontrols} 
-one which shows many of wxWindows standard controls, such as buttons,
+one which shows many of wxWidgets standard controls, such as buttons,
 listboxes, checkboxes, comboboxes etc.
 
 Other, more complicated controls, have their own samples. In this category you
@@ -42,28 +42,32 @@ may find the following samples showing the corresponding controls:
 
 Finally, it might be helpful to do a search in the entire sample directory if
 you can't find the sample you showing the control you are interested in by
-name. Most of wxWindows classes, occur in at least one of the samples.
+name. Most of wxWidgets classes, occur in at least one of the samples.
+
 
 \subsection{Minimal sample}\label{sampleminimal}
 
 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 wxWindows.
+a good starting point for learning how to use wxWidgets.
+
 
 \subsection{Art provider sample}\label{sampleartprovider}
 
 The {\tt artprov} sample shows how you can customize the look of standard
-wxWindows dialogs by replacing default bitmaps/icons with your own versions.
+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.
 
+
 \subsection{Calendar sample}\label{samplecalendar}
 
 This font shows the \helpref{calendar control}{wxcalendarctrl} 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.
 
+
 \subsection{Checklist sample}\label{samplechecklist}
 
 This sample demonstrates the use of the \helpref{wxCheckListBox}{wxchecklistbox}
@@ -74,6 +78,7 @@ 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
@@ -83,10 +88,11 @@ Unix and uses the Registry under Windows.
 See \helpref{wxConfig overview}{wxconfigoverview} for the descriptions of all
 features of this class.
 
+
 \subsection{Controls sample}\label{samplecontrols}
 
 The controls sample is the main test program for most simple controls used in
-wxWindows. The sample tests their basic functionality, events, placement,
+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 item to a list box etc. Apart
 from that, the sample uses a \helpref{wxNotebook}{wxnotebook} and tests most
@@ -115,17 +121,20 @@ The various controls tested are listed here:
 \twocolitem{\helpref{wxSlider}{wxslider}}{A slider that can be dragged by the user}
 \end{twocollist}
 
+
 \subsection{Database sample}\label{sampledb}
 
 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.
 
+
 \subsection{Dialogs sample}\label{sampledialogs}
 
-This sample shows how to use the common dialogs available from wxWindows. These
+This sample shows how to use the common dialogs available from wxWidgets. These
 dialogs are described in details in the \helpref{Common dialogs overview}{commondialogsoverview}.
 
+
 \subsection{Dialup sample}\label{sampledialup}
 
 This sample shows \helpref{wxDialUpManager}{wxdialupmanager} 
@@ -139,6 +148,7 @@ 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.
 
+
 \subsection{DnD sample}\label{samplednd}
 
 This sample shows both clipboard and drag and drop in action. It is quite non
@@ -162,7 +172,7 @@ clipboard (or, in the case of Windows version, also a metafile) - it will be
 shown in a new frame.
 
 So far, everything we mentioned was implemented with minimal amount of code
-using standard wxWindows classes. The more advanced features are demonstrated
+using standard wxWidgets classes. The more advanced features are demonstrated
 if you create a shape frame from the main frame menu. A shape is a geometric
 object which has a position, size and color. It models some
 application-specific data in this sample. A shape object supports its own
@@ -177,6 +187,7 @@ programs as well - try Write/Wordpad, for example).
 Take a look at DnDShapeDataObject class to see how you may use 
 \helpref{wxDataObject}{wxdataobject} to achieve this.
 
+
 \subsection{Dynamic sample}\label{sampledynamic}
 
 This sample is a very small sample that demonstrates the use of the
@@ -184,14 +195,15 @@ This sample is a very small sample that demonstrates the use of the
 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 wxWindows or programs where
+language that would work as a wrapper for wxWidgets or programs where
 forms or similar datagrams can be created by the uses.
 
 See also the \helpref{event sample}{sampleevent}
 
+
 \subsection{Event sample}\label{sampleevent}
 
-The event sample demonstrates various features of the wxWindows events. It
+The event sample demonstrates various features of the wxWidgets events. It
 shows using dynamic events and connecting/disconnecting the event handlers
 during the run time and also using 
 \helpref{PushEventHandler()}{wxwindowpusheventhandler} and
@@ -199,6 +211,19 @@ during the run time and also using
 
 It replaces the old dynamic sample.
 
+
+\subsection{Except(ions) sample}\label{sampleexcept}
+
+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.
+
+You need to build the library with \texttt{wxUSE\_EXCEPTIONS} being set to $1$
+and compile your code with the C++ exceptions support to be able to build this
+sample.
+
+
 \subsection{Exec sample}\label{sampleexec}
 
 The exec sample demonstrates the \helpref{wxExecute}{wxexecute} and 
@@ -211,18 +236,21 @@ synchronous and asynchronous cases and how to kill the processes with
 \helpref{wxProcess::Kill}{wxprocesskill} and test for their existence with 
 \helpref{wxProcess::Exists}{wxprocessexists}.
 
+
 \subsection{Font sample}\label{samplefont}
 
 The font sample demonstrates \helpref{wxFont}{wxfont}, 
 \helpref{wxFontEnumerator}{wxfontenumerator} and 
 \helpref{wxFontMapper}{wxfontmapper} classes. It allows you to see the fonts
-available (to wxWindows) on the computer and shows all characters of the
+available (to wxWidgets) on the computer and shows all characters of the
 chosen font as well.
 
+
 \subsection{Grid sample}\label{samplegrid}
 
 TODO.
 
+
 \subsection{HTML samples}\label{samplehtml}
 
 Eight HTML samples (you can find them in directory {\tt samples/html})
@@ -238,7 +266,7 @@ the library to work with unsupported tags.
 {\bf About} may give you an idea how to write good-looking about boxes.
 
 {\bf Zip} demonstrates use of virtual file systems in wxHTML. The zip archives
-handler (ships with wxWindows) allows you to access HTML pages stored 
+handler (ships with wxWidgets) allows you to access HTML pages stored 
 in compressed archive as if they were ordinary files.
 
 {\bf Virtual} is yet another virtual file systems demo. This one generates pages at run-time.
@@ -254,6 +282,7 @@ documents without much work. In fact, only few function calls are sufficient.
 while {\it Helpview} is simple tool that only pops up help window and
 displays help books given at command line.
 
+
 \subsection{Image sample}\label{sampleimage}
 
 The image sample demonstrates the use of the \helpref{wxImage}{wximage} class
@@ -272,9 +301,10 @@ 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}.
 
+
 \subsection{Internat(ionalization) sample}\label{sampleinternat}
 
-The not very clearly named internat sample demonstrates the wxWindows
+The not very clearly named internat sample demonstrates the wxWidgets
 internatationalization (i18n for short from now on) features. To be more
 precise, it only shows localization support, i.e. support for translating the
 program messages in another language while true i18n would also involve
@@ -283,10 +313,11 @@ changing the other aspects of the programs behaviour.
 More information about this sample can be found in the {\tt readme.txt} file in
 its directory. Please see also \helpref{i18n overview}{internationalization}.
 
+
 \subsection{Layout sample}\label{samplelayout}
 
 The layout sample demonstrates the two different layout systems offered
-by wxWindows. When starting the program, you will see a frame with some
+by wxWidgets. When starting the program, you will see a frame with some
 controls and some graphics. The controls will change their size whenever
 you resize the entire frame and the exact behaviour of the size changes
 is determined using the \helpref{wxLayoutConstraints}{wxlayoutconstraints} 
@@ -300,6 +331,7 @@ showing how to use sizers in connection with a \helpref{wxNotebook}{wxnotebook}
 class. See also \helpref{wxNotebookSizer}{wxnotebooksizer} and 
 \helpref{wxSizer}{wxsizer}.
 
+
 \subsection{Listctrl sample}\label{samplelistctrl}
 
 This sample shows \helpref{wxListCtrl}{wxlistctrl} control. Different modes
@@ -310,6 +342,7 @@ The sample also provides some timings for adding/deleting/sorting a lot of
 (several thousands) items into the control.
 
 
+
 \subsection{Notebook sample}\label{samplenotebook}
 
 This samples shows two controls at once: although initially it was written to
@@ -319,13 +352,15 @@ controls you need to manually change \texttt{TEST\_LISTBOOK} definition in the
 file \texttt{notebook.h} and rebuild the sample.
 
 
+
 \subsection{Render sample}\label{samplerender}
 
-This sample shows how to replace the default wxWindows 
+This sample shows how to replace the default wxWidgets 
 \helpref{renderer}{wxrenderernative} and also how to write a shared library
 (DLL) implementing a renderer and load and unload it during the run-time.
 
 
+
 \subsection{Rotate sample}\label{samplerotate}
 
 This is a simple example which demonstrates how to rotate an image with
@@ -334,6 +369,7 @@ 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 the use of the \helpref{wxScrolledWindow}{wxscrolledwindow} 
@@ -341,11 +377,12 @@ class including placing subwindows into it and drawing simple graphics. It uses
 \helpref{SetTargetWindow}{wxscrolledwindowsettargetwindow} 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 wxWindows,
+Additionally, this samples demonstrates how to optimize drawing operations in wxWidgets,
 in particular using the \helpref{wxWindow::IsExposed}{wxwindowisexposed} method with 
 the aim to prevent unnecessary drawing in the window and thus reducing or removing 
 flicker on screen.
 
+
 \subsection{Sockets sample}\label{samplesockets}
 
 The sockets sample demonstrates how to use the communication facilities
@@ -398,6 +435,13 @@ The sockets sample is work in progress. Some things to do:
 \item New samples which actually do something useful (suggestions accepted).
 \end{itemize}
 
+
+\subsection{Sound sample}\label{samplesound}
+
+The {\tt sound} sample shows how to use \helpref{wxSound}{wxsound} for simple
+audio output (e.g. notifications).
+
+
 \subsection{Statbar sample}\label{samplestatbar}
 
 This sample shows how to create and use wxStatusBar. Although most of the
@@ -408,6 +452,7 @@ 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.
 
+
 \subsection{Text sample}\label{sampletext}
 
 This sample demonstrates four features: firstly the use and many variants of
@@ -429,6 +474,7 @@ 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.
 
+
 \subsection{Thread sample}\label{samplethread}
 
 This sample demonstrates the use of threads in connection with GUI programs.
@@ -438,17 +484,18 @@ 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, wxWindows offers the \helpref{wxPostEvent}{wxpostevent} 
+worker threads possible, wxWidgets offers the \helpref{wxPostEvent}{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 \helpref{wxMutex}{wxmutex} 
 class) that prevent threads from accessing the GUI classes as long as any other
-thread accesses them. For this, wxWindows has the \helpref{wxMutexGuiEnter}{wxmutexguienter} 
+thread accesses them. For this, wxWidgets has the \helpref{wxMutexGuiEnter}{wxmutexguienter} 
 and \helpref{wxMutexGuiLeave}{wxmutexguileave} functions, both of which are
 used and tested in the sample as well.
 
 See also \helpref{Multithreading overview}{wxthreadoverview} and \helpref{wxThread}{wxthread}.
 
+
 \subsection{Toolbar sample}\label{sampletoolbar}
 
 The toolbar sample shows the \helpref{wxToolBar}{wxtoolbar} class in action.
@@ -477,6 +524,7 @@ see the radio toolbar buttons in action: the first three buttons form a radio
 group, that is checking any of them automatically unchecks the previously
 checked one.
 
+
 \subsection{Treectrl sample}\label{sampletreectrl}
 
 This sample demonstrates using \helpref{wxTreeCtrl}{wxtreectrl} class. Here
@@ -488,6 +536,7 @@ 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.
 
+
 \subsection{Wizard sample}\label{samplewizard}
 
 This sample shows so-called wizard dialog (implemented using