]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/tsamples.tex
Documented new constructor and overloaded Create methods.
[wxWidgets.git] / docs / latex / wx / tsamples.tex
index 1c449aafac3987e5adf3401b8306148e9e324c2c..223b473389e438ffc374d4ba89bcab3cf7ffee8b 100644 (file)
@@ -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.
 
+
 \subsection{Minimal sample}\label{sampleminimal}
 
 The minimal sample is what most people will know under the term Hello World,
@@ -51,12 +52,22 @@ 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
 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}
@@ -67,15 +78,17 @@ 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
-indenpedent way, i.e. it uses text based files to store a given configuration under
+independent way, i.e. it uses text based files to store a given configuration under
 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
@@ -108,30 +121,34 @@ 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
 dialogs are described in details in the \helpref{Common dialogs overview}{commondialogsoverview}.
 
+
 \subsection{Dialup sample}\label{sampledialup}
 
 This sample shows \helpref{wxDialUpManager}{wxdialupmanager} 
-class. It displays in the status bar the information gathered through itsi
-nterface: in particular, the current connection status (online or offline) and
+class. It displays in the status bar the information gathered through its
+interface: in particular, the current connection status (online or offline) and
 whether the connection is permanent (in which case a string `LAN' appears in
-the thrid status bar field - but note that you may have be on a LAN not
+the third status bar field - but note that you may have be on a LAN not
 connected to the Internet, in which case you will not see this) or not.
 
 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
@@ -170,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
@@ -182,6 +200,7 @@ 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
@@ -192,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 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 
@@ -204,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}.
 
+
 \subsection{Font sample}\label{samplefont}
 
 The font sample demonstrates \helpref{wxFont}{wxfont}, 
@@ -212,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.
 
+
 \subsection{Grid sample}\label{samplegrid}
 
 TODO.
 
+
 \subsection{HTML samples}\label{samplehtml}
 
 Eight HTML samples (you can find them in directory {\tt samples/html})
@@ -247,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
@@ -265,6 +301,19 @@ 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
+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
+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
@@ -282,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
@@ -289,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
-(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}
 
@@ -299,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} 
@@ -311,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.
 
+
 \subsection{Sockets sample}\label{samplesockets}
 
 The sockets sample demonstrates how to use the communication facilities
@@ -363,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
@@ -373,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
@@ -384,7 +464,7 @@ the raw form using the {\tt EVT\_KEY\_UP} and {\tt EVT\_KEY\_DOWN} macros and th
 higher level from using the {\tt EVT\_CHAR} macro. All characters will be logged
 in a log window at the bottom of the main window. By pressing some of the function
 keys, you can test some actions in the text ctrl as well as get statistics on the
-text ctrls, which is useful for testing if these stastitics actually are correct.
+text ctrls, which is useful for testing if these statistics 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
@@ -394,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.
@@ -414,6 +495,7 @@ 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.
@@ -432,6 +514,17 @@ 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
@@ -443,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