Applied patch [ 827011 ] Event-based processing of item tooltips in wxTreeCtrl

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

diff --git a/docs/latex/wx/tsamples.tex b/docs/latex/wx/tsamples.tex
index 2a92f1b4cc01556ae8f82d932de6a65a294d2bff..82d9029534fbd67fc9761b174d9fb2e4911c9f26 100644 (file)
--- a/docs/latex/wx/tsamples.tex
+++ b/docs/latex/wx/tsamples.tex
@@ -44,6 +44,7 @@ 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.
 
 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.
 

+

 \subsection{Minimal sample}\label{sampleminimal}
 
 The minimal sample is what most people will know under the term Hello World,
 \subsection{Minimal sample}\label{sampleminimal}
 
 The minimal sample is what most people will know under the term Hello World,


@@ -51,6 +52,7 @@ 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.
 
 needed to write a program that will display a "hello" dialog. This is usually
 a good starting point for learning how to use wxWindows.
 

+

 \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


@@ -58,12 +60,14 @@ wxWindows 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.
 
 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{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}
 \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.
 
 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


@@ -83,6 +88,7 @@ Unix and uses the Registry under Windows.
 See \helpref{wxConfig overview}{wxconfigoverview} for the descriptions of all
 features of this class.
 
 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
 \subsection{Controls sample}\label{samplecontrols}
 
 The controls sample is the main test program for most simple controls used in


@@ -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}
 
 \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{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
 dialogs are described in details in the \helpref{Common dialogs overview}{commondialogsoverview}.
 
 \subsection{Dialogs sample}\label{sampledialogs}
 
 This sample shows how to use the common dialogs available from wxWindows. These
 dialogs are described in details in the \helpref{Common dialogs overview}{commondialogsoverview}.
 

+

 \subsection{Dialup sample}\label{sampledialup}
 
 This sample shows \helpref{wxDialUpManager}{wxdialupmanager} 
 \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.
 
 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
 \subsection{DnD sample}\label{samplednd}
 
 This sample shows both clipboard and drag and drop in action. It is quite non


@@ -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.
 
 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
 \subsection{Dynamic sample}\label{sampledynamic}
 
 This sample is a very small sample that demonstrates the use of the


@@ -189,6 +200,7 @@ forms or similar datagrams can be created by the uses.
 
 See also the \helpref{event sample}{sampleevent}
 
 
 See also the \helpref{event sample}{sampleevent}
 

+

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


@@ -199,6 +211,19 @@ during the run time and also using
 
 It replaces the old dynamic sample.
 
 
 It replaces the old dynamic sample.
 

+
+\subsection{Except(ions) sample}\label{sampleexcept}
+
+This very simple sample shows how to use C++ exceptions in wxWindows 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 
 \subsection{Exec sample}\label{sampleexec}
 
 The exec sample demonstrates the \helpref{wxExecute}{wxexecute} and 


@@ -211,6 +236,7 @@ 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}.
 
 \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}, 
 \subsection{Font sample}\label{samplefont}
 
 The font sample demonstrates \helpref{wxFont}{wxfont}, 


@@ -219,10 +245,12 @@ The font sample demonstrates \helpref{wxFont}{wxfont},
 available (to wxWindows) on the computer and shows all characters of the
 chosen font as well.
 
 available (to wxWindows) on the computer and shows all characters of the
 chosen font as well.
 

+

 \subsection{Grid sample}\label{samplegrid}
 
 TODO.
 
 \subsection{Grid sample}\label{samplegrid}
 
 TODO.
 

+

 \subsection{HTML samples}\label{samplehtml}
 
 Eight HTML samples (you can find them in directory {\tt samples/html})
 \subsection{HTML samples}\label{samplehtml}
 
 Eight HTML samples (you can find them in directory {\tt samples/html})


@@ -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.
 
 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
 \subsection{Image sample}\label{sampleimage}
 
 The image sample demonstrates the use of the \helpref{wxImage}{wximage} class


@@ -272,6 +301,7 @@ 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}.
 

+

 \subsection{Internat(ionalization) sample}\label{sampleinternat}
 
 The not very clearly named internat sample demonstrates the wxWindows
 \subsection{Internat(ionalization) sample}\label{sampleinternat}
 
 The not very clearly named internat sample demonstrates the wxWindows


@@ -281,7 +311,8 @@ program messages in another language while true i18n would also involve
 changing the other aspects of the programs behaviour.
 
 More information about this sample can be found in the {\tt readme.txt} file in
 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}\label{internationalization}.
+its directory. Please see also \helpref{i18n overview}{internationalization}.
+

 
 \subsection{Layout sample}\label{samplelayout}
 
 
 \subsection{Layout sample}\label{samplelayout}
 


@@ -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}.
 
 class. See also \helpref{wxNotebookSizer}{wxnotebooksizer} and 
 \helpref{wxSizer}{wxsizer}.
 

+

 \subsection{Listctrl sample}\label{samplelistctrl}
 
 This sample shows \helpref{wxListCtrl}{wxlistctrl} control. Different modes
 \subsection{Listctrl sample}\label{samplelistctrl}
 
 This sample shows \helpref{wxListCtrl}{wxlistctrl} control. Different modes


@@ -307,7 +339,27 @@ supported by the control (list, icons, small icons, report) may be chosen from
 the menu.
 
 The sample also provides some timings for adding/deleting/sorting a lot of
 the menu.
 
 The sample also provides some timings for adding/deleting/sorting a lot of

-(several thousands) controls into the control.
+(several thousands) items into the control.
+
+
+
+\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} 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.
+
+
+
+\subsection{Render sample}\label{samplerender}
+
+This sample shows how to replace the default wxWindows 
+\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}
 
 
 \subsection{Rotate sample}\label{samplerotate}
 


@@ -317,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.
 
 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} 
 \subsection{Scroll subwindow sample}\label{samplescrollsub}
 
 This sample demonstrates the use of the \helpref{wxScrolledWindow}{wxscrolledwindow} 


@@ -329,6 +382,7 @@ in particular using the \helpref{wxWindow::IsExposed}{wxwindowisexposed} method
 the aim to prevent unnecessary drawing in the window and thus reducing or removing 
 flicker on screen.
 
 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
 \subsection{Sockets sample}\label{samplesockets}
 
 The sockets sample demonstrates how to use the communication facilities


@@ -381,6 +435,7 @@ The sockets sample is work in progress. Some things to do:
 \item New samples which actually do something useful (suggestions accepted).
 \end{itemize}
 
 \item New samples which actually do something useful (suggestions accepted).
 \end{itemize}
 

+

 \subsection{Statbar sample}\label{samplestatbar}
 
 This sample shows how to create and use wxStatusBar. Although most of the
 \subsection{Statbar sample}\label{samplestatbar}
 
 This sample shows how to create and use wxStatusBar. Although most of the


@@ -391,6 +446,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.
 
 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
 \subsection{Text sample}\label{sampletext}
 
 This sample demonstrates four features: firstly the use and many variants of


@@ -412,6 +468,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.
 
 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.
 \subsection{Thread sample}\label{samplethread}
 
 This sample demonstrates the use of threads in connection with GUI programs.


@@ -432,6 +489,7 @@ used and tested in the sample as well.
 
 See also \helpref{Multithreading overview}{wxthreadoverview} and \helpref{wxThread}{wxthread}.
 
 
 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.
 \subsection{Toolbar sample}\label{sampletoolbar}
 
 The toolbar sample shows the \helpref{wxToolBar}{wxtoolbar} class in action.


@@ -460,6 +518,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.
 
 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
 \subsection{Treectrl sample}\label{sampletreectrl}
 
 This sample demonstrates using \helpref{wxTreeCtrl}{wxtreectrl} class. Here


@@ -471,6 +530,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.
 
 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 
 \subsection{Wizard sample}\label{samplewizard}
 
 This sample shows so-called wizard dialog (implemented using