]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/tsamples.tex
compilation fix after TRUE/FALSE change
[wxWidgets.git] / docs / latex / wx / tsamples.tex
index 6c448dc45c26a2e05b290a431370f48a02aa88b2..19fb0af4e257a14d1edaba6123691a071bfaa09e 100644 (file)
@@ -51,6 +51,13 @@ 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.
 
+\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.
+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
@@ -111,10 +118,8 @@ The various controls tested are listed here:
 \subsection{Database sample}\label{sampledb}
 
 The database sample is a small test program showing how to use the ODBC
-classes written by Remstar Intl. These classes are documented in a separate
-manual available from the wxWindows homepage. Obviously, this sample
-requires a database with ODBC support to be correctly installed on your
-system.
+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}
 
@@ -134,54 +139,6 @@ 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{Dynamic sample}\label{sampledynamic}
-
-This sample is a very small sample that demonstrates the 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 wxWindows or programs where
-forms or similar datagrams can be created by the uses.
-
-\subsection{Exec sample}\label{sampleexec}
-
-The exec sample demonstrates the \helpref{wxExecute}{wxexecute} and 
-\helpref{wxShell}{wxshell} functions. Both of them are used to execute the
-external programs and the sample shows how to do this synchronously (waiting
-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.
-
-\subsection{Scroll subwindow sample}\label{samplescrollsub}
-
-This sample demonstrates the use of the \helpref{wxScrolledWindow}{wxscrolledwindow} 
-class including placing subwindows into it and drawing simple graphics. It uses the 
-\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,
-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{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{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
-chosen font as well.
-
 \subsection{DnD sample}\label{samplednd}
 
 This sample shows both clipboard and drag and drop in action. It is quite non
@@ -220,6 +177,48 @@ 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
+\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 wxWindows 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
+shows using dynamic events and connecting/disconnecting the event handlers
+during the run time and also using 
+\helpref{PushEventHandler()}{wxwindowpusheventhandler} and
+\helpref{PopEventHandler()}{wxwindowpopeventhandler}.
+
+It replaces the old dynamic sample.
+
+\subsection{Exec sample}\label{sampleexec}
+
+The exec sample demonstrates the \helpref{wxExecute}{wxexecute} and 
+\helpref{wxShell}{wxshell} functions. Both of them are used to execute the
+external programs and the sample shows how to do this synchronously (waiting
+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 
+\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
+chosen font as well.
+
 \subsection{Grid sample}\label{samplegrid}
 
 TODO.
@@ -299,6 +298,26 @@ the menu.
 The sample also provides some timings for adding/deleting/sorting a lot of
 (several thousands) controls into the control.
 
+\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 the use of the \helpref{wxScrolledWindow}{wxscrolledwindow} 
+class including placing subwindows into it and drawing simple graphics. It uses the 
+\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,
+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
@@ -377,7 +396,7 @@ text ctrls, which is useful for testing if these stastitics actually are correct
 Thirdly, on platforms which support it, the sample will offer to copy text to the 
 \helpref{wxClipboard}{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. 
+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.
@@ -420,6 +439,16 @@ in MyFrame::OnUpdateCopyAndCut.
 toolbar.
 \end{itemize}
 
+Some buttons in the main toolbar are check buttons, i.e. they stay checked when
+pressed. On the platforms which support it, the sample also add a combobox
+to the toolbar showing how you can use arbitrary controls and not only buttons
+in it.
+
+If you toggle another toolbar in the sample (using {\tt Ctrl-A}) you will also
+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