%% 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
\end{twocollist}
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 showing the control you are interested in by
+name. Most classes contained in wxWidgets 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.
This sample demonstrates the use of the \helpref{wxCheckListBox}{wxchecklistbox}
class intercepting check, select and double click events. It also tests the
use of various methods modifying the control, such as by deleting items
-from it or inserting new once (these functions are actually implemented in
+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{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
+the controls programmatically, such as adding an item to a list box etc. Apart
from that, the sample uses a \helpref{wxNotebook}{wxnotebook} and tests most
features of this special control (using bitmap in the tabs, using
\helpref{wxSizers}{wxsizer} and \helpref{constraints}{wxlayoutconstraints} within
\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}.
+This sample shows how to use the common dialogs available from wxWidgets. These
+dialogs are described in detail in the \helpref{Common dialogs overview}{commondialogsoverview}.
\subsection{Dialup sample}\label{sampledialup}
-This sample shows \helpref{wxDialUpManager}{wxdialupmanager}
+This sample shows the \helpref{wxDialUpManager}{wxdialupmanager}
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 third status bar field - but note that you may have be on a LAN not
+the third status bar field - but note that you may 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
Finally, the last part is used for dragging text from it to either one of the
listboxes (only one will accept it) or another application. The last
functionality available from the main frame is to paste a bitmap from the
-clipboard (or, in the case of Windows version, also a metafile) - it will be
+clipboard (or, in the case of the 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
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
+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.
+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 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
\subsection{Except(ions) sample}\label{sampleexcept}
-This very simple sample shows how to use C++ exceptions in wxWindows programs,
+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
+and compile your code with C++ exceptions support to be able to build this
sample.
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{HTML samples}\label{samplehtml}
Eight HTML samples (you can find them in directory {\tt samples/html})
-cover all features of HTML sub-library.
+cover all features of the HTML sub-library.
{\bf Test} demonstrates how to create \helpref{wxHtmlWindow}{wxhtmlwindow}
-and also shows most of supported HTML tags.
+and also shows most supported HTML tags.
-{\bf Widget} shows how you can embed ordinary controls or windows within
+{\bf Widget} shows how you can embed ordinary controls or windows within an
HTML page. It also nicely explains how to write new tag handlers and extend
the library to work with unsupported tags.
-{\bf About} may give you an idea how to write good-looking about boxes.
+{\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
-in compressed archive as if they were ordinary files.
+handler (ships with wxWidgets) allows you to access HTML pages stored
+in a compressed archive as if they were ordinary files.
{\bf Virtual} is yet another virtual file systems demo. This one generates pages at run-time.
You may find it useful if you need to display some reports in your application.
{\bf Help} and {\bf Helpview} are variations on displaying HTML help
(compatible with MS HTML Help Workshop). {\it Help} shows how to embed
\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} in your application
-while {\it Helpview} is simple tool that only pops up help window and
+while {\it Helpview} is a simple tool that only pops up the help window and
displays help books given at command line.
The image sample demonstrates the use of the \helpref{wxImage}{wximage} class
and shows how to download images in a variety of formats, currently PNG, GIF,
-TIFF, JPEG, BMP, PNM and PCX. The top of the sample shows to rectangles, one
+TIFF, JPEG, BMP, PNM and PCX. The top of the sample shows two rectangles, one
of which is drawn directly in the window, the other one is drawn into a
\helpref{wxBitmap}{wxbitmap}, converted to a wxImage, saved as a PNG image
and then reloaded from the PNG file again so that conversions between wxImage
-and wxBitmap as well as loading and save PNG files are tested.
+and wxBitmap as well as loading and saving PNG files are tested.
-At the bottom of the main frame is a test for using a monochrome bitmap by
+At the bottom of the main frame there is a test for using a monochrome bitmap by
drawing into a \helpref{wxMemoryDC}{wxmemorydc}. The bitmap is then drawn
specifying the foreground and background colours with
\helpref{wxDC::SetTextForeground}{wxdcsettextforeground} and
\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
+The not very clearly named internat sample demonstrates the wxWidgets
+internationalization (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.
\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}
The menu in this sample offers two more tests, one showing how to use
a \helpref{wxBoxSizer}{wxboxsizer} in a simple dialog and the other one
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{wxSizer}{wxsizer}.
\subsection{Listctrl sample}\label{samplelistctrl}
-This sample shows \helpref{wxListCtrl}{wxlistctrl} control. Different modes
+This sample shows the \helpref{wxListCtrl}{wxlistctrl} control. Different modes
supported by the control (list, icons, small icons, report) may be chosen from
the menu.
\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.
\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.
The server binds to the local address, using TCP port number 3000,
sets up an event handler to be notified of incoming connection requests
-({\bf wxSOCKET\_CONNECTION} events), and stands there, waiting for clients
+({\bf wxSOCKET\_CONNECTION} events), and sits there, waiting for clients
({\it listening} in the socket parlance). For each accepted connection,
a new \helpref{wxSocketBase}{wxsocketbase} object is created. These
socket objects are independent from the server that created them, so
to catch {\bf wxSOCKET\_LOST} events, each one is immediately notified
if the other end closes the connection.
-There is also an URL test which shows how to use
+There is also a URL test which shows how to use
the \helpref{wxURL}{wxurl} class to fetch data from a given URL.
The sockets sample is work in progress. Some things to do:
\subsection{Sound sample}\label{samplesound}
-The {\tt sound} sample shows how to use \helpref{wxWave}{wxwave} for simple
+The {\tt sound} sample shows how to use \helpref{wxSound}{wxsound} for simple
audio output (e.g. notifications).
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.
\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
+pressed. On the platforms which support it, the sample also adds 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
+group, i.e. checking any of them automatically unchecks the previously
checked one.
continuing).
\item Using more elaborated techniques to allow returning to the previous
page, but not continuing to the next one or vice versa (in wxRadioboxPage)
-\item This (wxRadioboxPage) page also shows how the page may process {\tt
+\item This (wxRadioboxPage) page also shows how the page may process the {\tt
Cancel} button itself instead of relying on the wizard parent to do it.
\item Normally, the order of the pages in the wizard is known at compile-time,
but sometimes it depends on the user choices: wxCheckboxPage shows how to
projects / wxWidgets.git / blobdiff