1999-11-02 17:47:19 -05:00
|
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
|
|
%% Name: tsamples.tex
|
|
|
|
%% Purpose: Samples description
|
|
|
|
%% Author: Vadim Zeitlin
|
|
|
|
%% Modified by:
|
|
|
|
%% Created: 02.11.99
|
|
|
|
%% RCS-ID: $Id$
|
2004-05-04 04:27:20 -04:00
|
|
|
%% Copyright: (c) wxWidgets team
|
2005-02-22 10:09:56 -05:00
|
|
|
%% License: wxWindows license
|
1999-11-02 17:47:19 -05:00
|
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
2000-02-07 10:48:53 -05:00
|
|
|
% NB: please keep the subsections in alphabetic order!
|
|
|
|
|
2004-05-04 04:27:20 -04:00
|
|
|
\section{wxWidgets samples}\label{samples}
|
1999-11-02 17:47:19 -05:00
|
|
|
|
2004-05-04 04:27:20 -04:00
|
|
|
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
|
1999-11-02 17:47:19 -05:00
|
|
|
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
|
2004-05-04 04:27:20 -04:00
|
|
|
features of wxWidgets are they supposed to test.
|
1999-11-02 17:47:19 -05:00
|
|
|
|
2004-05-04 04:27:20 -04:00
|
|
|
There are currently more than 50 different samples as part of wxWidgets and
|
2004-09-16 07:29:15 -04:00
|
|
|
this list is not complete. You should start your tour of wxWidgets with the
|
2004-05-04 04:27:20 -04:00
|
|
|
\helpref{minimal sample}{sampleminimal} which is the wxWidgets version of
|
|
|
|
"Hello, world!". It shows the basic structure of wxWidgets program and is the
|
2000-02-07 10:48:53 -05:00
|
|
|
most commented sample of all - looking at its source code is recommended.
|
|
|
|
|
2004-09-16 07:29:15 -04:00
|
|
|
The next most useful sample is probably the \helpref{controls}{samplecontrols}
|
2004-05-04 04:27:20 -04:00
|
|
|
one which shows many of wxWidgets standard controls, such as buttons,
|
2000-02-11 14:42:46 -05:00
|
|
|
listboxes, checkboxes, comboboxes etc.
|
2000-02-07 10:48:53 -05:00
|
|
|
|
|
|
|
Other, more complicated controls, have their own samples. In this category you
|
|
|
|
may find the following samples showing the corresponding controls:
|
|
|
|
|
|
|
|
\begin{twocollist}\itemsep=0pt
|
|
|
|
\twocolitem{\helpref{wxCalendarCtrl}{samplecalendar}}{Calendar a.k.a. date picker control}
|
|
|
|
\twocolitem{\helpref{wxListCtrl}{samplelistctrl}}{List view control}
|
|
|
|
\twocolitem{\helpref{wxTreeCtrl}{sampletreectrl}}{Tree view control}
|
|
|
|
\twocolitem{\helpref{wxGrid}{samplegrid}}{Grid control}
|
|
|
|
\end{twocollist}
|
|
|
|
|
|
|
|
Finally, it might be helpful to do a search in the entire sample directory if
|
2004-07-04 07:19:47 -04:00
|
|
|
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.
|
2000-01-04 14:41:25 -05:00
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-01-04 14:41:25 -05:00
|
|
|
\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
|
2004-05-04 04:27:20 -04:00
|
|
|
a good starting point for learning how to use wxWidgets.
|
2000-01-04 14:41:25 -05:00
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2002-04-07 12:05:25 -04:00
|
|
|
\subsection{Art provider sample}\label{sampleartprovider}
|
|
|
|
|
|
|
|
The {\tt artprov} sample shows how you can customize the look of standard
|
2004-05-04 04:27:20 -04:00
|
|
|
wxWidgets dialogs by replacing default bitmaps/icons with your own versions.
|
2002-04-08 12:46:27 -04:00
|
|
|
It also shows how you can use wxArtProvider to
|
2002-04-07 12:05:25 -04:00
|
|
|
get stock bitmaps for use in your application.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-01-02 18:17:55 -05:00
|
|
|
\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.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-01-02 13:13:45 -05:00
|
|
|
\subsection{Checklist sample}\label{samplechecklist}
|
|
|
|
|
2004-09-03 22:44:43 -04:00
|
|
|
This sample demonstrates use of the \helpref{wxCheckListBox}{wxchecklistbox}
|
|
|
|
class intercepting check, select and double click events. It also tests
|
2000-07-15 15:51:35 -04:00
|
|
|
use of various methods modifying the control, such as by deleting items
|
2004-07-04 07:19:47 -04:00
|
|
|
from it or inserting new ones (these functions are actually implemented in
|
2000-01-02 13:13:45 -05:00
|
|
|
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.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-01-02 13:13:45 -05:00
|
|
|
\subsection{Config sample}\label{sampleconfig}
|
|
|
|
|
|
|
|
This sample demonstrates the \helpref{wxConfig}{wxconfigbase} classes in a platform
|
2002-06-07 16:15:28 -04:00
|
|
|
independent way, i.e. it uses text based files to store a given configuration under
|
2000-01-02 13:13:45 -05:00
|
|
|
Unix and uses the Registry under Windows.
|
|
|
|
|
|
|
|
See \helpref{wxConfig overview}{wxconfigoverview} for the descriptions of all
|
|
|
|
features of this class.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-01-16 14:24:57 -05:00
|
|
|
\subsection{Controls sample}\label{samplecontrols}
|
|
|
|
|
|
|
|
The controls sample is the main test program for most simple controls used in
|
2004-05-04 04:27:20 -04:00
|
|
|
wxWidgets. The sample tests their basic functionality, events, placement,
|
2000-01-16 14:24:57 -05:00
|
|
|
modification in terms of colour and font as well as the possibility to change
|
2004-07-04 07:19:47 -04:00
|
|
|
the controls programmatically, such as adding an item to a list box etc. Apart
|
2000-01-16 14:24:57 -05:00
|
|
|
from that, the sample uses a \helpref{wxNotebook}{wxnotebook} and tests most
|
2004-09-16 07:29:15 -04:00
|
|
|
features of this special control (using bitmap in the tabs, using
|
2000-01-16 14:24:57 -05:00
|
|
|
\helpref{wxSizers}{wxsizer} and \helpref{constraints}{wxlayoutconstraints} within
|
2000-07-15 15:51:35 -04:00
|
|
|
notebook pages, advancing pages programmatically and vetoing a page change
|
2000-01-16 14:24:57 -05:00
|
|
|
by intercepting the \helpref{wxNotebookEvent}{wxnotebookevent}.
|
|
|
|
|
|
|
|
The various controls tested are listed here:
|
2000-02-11 14:42:46 -05:00
|
|
|
|
2000-01-16 14:24:57 -05:00
|
|
|
\begin{twocollist}\itemsep=0pt
|
|
|
|
\twocolitem{\helpref{wxButton}{wxbutton}}{Push button control, displaying text}
|
|
|
|
\twocolitem{\helpref{wxBitmapButton}{wxbitmapbutton}}{Push button control, displaying a bitmap}
|
|
|
|
\twocolitem{\helpref{wxCheckBox}{wxcheckbox}}{Checkbox control}
|
|
|
|
\twocolitem{\helpref{wxChoice}{wxchoice}}{Choice control (a combobox without the editable area)}
|
|
|
|
\twocolitem{\helpref{wxComboBox}{wxcombobox}}{A choice with an editable area}
|
|
|
|
\twocolitem{\helpref{wxGauge}{wxgauge}}{A control to represent a varying quantity, such as time remaining}
|
|
|
|
\twocolitem{\helpref{wxStaticBox}{wxstaticbox}}{A static, or group box for visually grouping related controls}
|
|
|
|
\twocolitem{\helpref{wxListBox}{wxlistbox}}{A list of strings for single or multiple selection}
|
|
|
|
\twocolitem{wxSpinCtrl}{A spin ctrl with a text field and a `up-down' control}
|
|
|
|
\twocolitem{\helpref{wxSpinButton}{wxspinbutton}}{A spin or `up-down' control}
|
|
|
|
\twocolitem{\helpref{wxStaticText}{wxstatictext}}{One or more lines of non-editable text}
|
|
|
|
\twocolitem{\helpref{wxStaticBitmap}{wxstaticbitmap}}{A control to display a bitmap}
|
|
|
|
\twocolitem{\helpref{wxRadioBox}{wxradiobox}}{A group of radio buttons}
|
|
|
|
\twocolitem{\helpref{wxRadioButton}{wxradiobutton}}{A round button to be used with others in a mutually exclusive way}
|
|
|
|
\twocolitem{\helpref{wxSlider}{wxslider}}{A slider that can be dragged by the user}
|
|
|
|
\end{twocollist}
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-01-16 14:24:57 -05:00
|
|
|
\subsection{Database sample}\label{sampledb}
|
|
|
|
|
|
|
|
The database sample is a small test program showing how to use the ODBC
|
2004-09-16 07:29:15 -04:00
|
|
|
classes written by Remstar Intl. Obviously, this sample requires a
|
2001-02-05 08:33:43 -05:00
|
|
|
database with ODBC support to be correctly installed on your system.
|
2000-01-16 14:24:57 -05:00
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2005-03-22 15:15:51 -05:00
|
|
|
\subsection{DebugRpt sample}\label{sampledebugrpt}
|
|
|
|
|
|
|
|
This sample shows how to use \helpref{wxDebugReport}{wxdebugreport} class to
|
|
|
|
generate a debug report in case of a program crash or otherwise. On start up,
|
|
|
|
it proposes to either crash itself (by dereferencing a NULL pointer) or
|
|
|
|
generate debug report without doing it. Next it initializes the debug report
|
|
|
|
with standard information adding a custom file to it (just a timestamp) and
|
|
|
|
allows to view the information gathered using
|
|
|
|
\helpref{wxDebugReportPreview}{wxdebugreportpreview}.
|
|
|
|
|
|
|
|
For the report processing part of the sample to work you should make available
|
|
|
|
a Web server accepting form uploads, otherwise
|
|
|
|
\helpref{wxDebugReportUpload}{wxdebugreportupload} will report an error.
|
|
|
|
|
|
|
|
|
2000-01-02 13:13:45 -05:00
|
|
|
\subsection{Dialogs sample}\label{sampledialogs}
|
|
|
|
|
2004-05-04 04:27:20 -04:00
|
|
|
This sample shows how to use the common dialogs available from wxWidgets. These
|
2004-07-04 07:19:47 -04:00
|
|
|
dialogs are described in detail in the \helpref{Common dialogs overview}{commondialogsoverview}.
|
2000-07-15 15:51:35 -04:00
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
\subsection{Dialup sample}\label{sampledialup}
|
|
|
|
|
2004-09-16 07:29:15 -04:00
|
|
|
This sample shows the \helpref{wxDialUpManager}{wxdialupmanager}
|
2004-09-03 22:44:43 -04:00
|
|
|
class. In the status bar, it displays the information gathered through its
|
2002-06-07 16:15:28 -04:00
|
|
|
interface: in particular, the current connection status (online or offline) and
|
2000-07-15 15:51:35 -04:00
|
|
|
whether the connection is permanent (in which case a string `LAN' appears in
|
2004-07-04 07:19:47 -04:00
|
|
|
the third status bar field - but note that you may be on a LAN not
|
2000-07-15 15:51:35 -04:00
|
|
|
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.
|
2000-01-02 13:13:45 -05:00
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2001-10-08 13:46:04 -04:00
|
|
|
\subsection{DnD sample}\label{samplednd}
|
|
|
|
|
|
|
|
This sample shows both clipboard and drag and drop in action. It is quite non
|
|
|
|
trivial and may be safely used as a basis for implementing the clipboard and
|
|
|
|
drag and drop operations in a real-life program.
|
|
|
|
|
|
|
|
When you run the sample, its screen is split in several parts. On the top,
|
2004-09-16 07:29:15 -04:00
|
|
|
there are two listboxes which show the standard derivations of
|
|
|
|
\helpref{wxDropTarget}{wxdroptarget}:
|
|
|
|
\helpref{wxTextDropTarget}{wxtextdroptarget} and
|
2001-10-08 13:46:04 -04:00
|
|
|
\helpref{wxFileDropTarget}{wxfiledroptarget}.
|
|
|
|
|
|
|
|
The middle of the sample window is taken by the log window which shows what is
|
|
|
|
going on (of course, this only works in debug builds) and may be helpful to see
|
|
|
|
the sequence of steps of data transfer.
|
|
|
|
|
|
|
|
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
|
2004-07-04 07:19:47 -04:00
|
|
|
clipboard (or, in the case of the Windows version, also a metafile) - it will be
|
2001-10-08 13:46:04 -04:00
|
|
|
shown in a new frame.
|
|
|
|
|
|
|
|
So far, everything we mentioned was implemented with minimal amount of code
|
2004-05-04 04:27:20 -04:00
|
|
|
using standard wxWidgets classes. The more advanced features are demonstrated
|
2001-10-08 13:46:04 -04:00
|
|
|
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
|
|
|
|
private \helpref{wxDataFormat}{wxdataformat} which means that you may cut and
|
|
|
|
paste it or drag and drop (between one and the same or different shapes) from
|
|
|
|
one sample instance to another (or the same). However, chances are that no
|
|
|
|
other program supports this format and so shapes can also be rendered as
|
|
|
|
bitmaps which allows them to be pasted/dropped in many other applications
|
|
|
|
(and, under Windows, also as metafiles which are supported by most of Windows
|
|
|
|
programs as well - try Write/Wordpad, for example).
|
|
|
|
|
2004-09-16 07:29:15 -04:00
|
|
|
Take a look at DnDShapeDataObject class to see how you may use
|
2001-10-08 13:46:04 -04:00
|
|
|
\helpref{wxDataObject}{wxdataobject} to achieve this.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-01-04 14:41:25 -05:00
|
|
|
\subsection{Dynamic sample}\label{sampledynamic}
|
|
|
|
|
2004-09-03 22:44:43 -04:00
|
|
|
This sample is a very small sample that demonstrates use of the
|
2000-01-04 14:41:25 -05:00
|
|
|
\helpref{wxEvtHandler::Connect}{wxevthandlerconnect} method. This method
|
2004-07-04 07:19:47 -04:00
|
|
|
should be used whenever it is not known at compile time which control
|
2000-01-04 14:41:25 -05:00
|
|
|
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
|
2004-05-04 04:27:20 -04:00
|
|
|
language that would work as a wrapper for wxWidgets or programs where
|
2004-07-04 07:19:47 -04:00
|
|
|
forms or similar datagrams can be created by the users.
|
2000-01-04 14:41:25 -05:00
|
|
|
|
2001-01-31 11:00:00 -05:00
|
|
|
See also the \helpref{event sample}{sampleevent}
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2001-01-31 11:00:00 -05:00
|
|
|
\subsection{Event sample}\label{sampleevent}
|
|
|
|
|
2004-05-04 04:27:20 -04:00
|
|
|
The event sample demonstrates various features of the wxWidgets events. It
|
2001-01-31 11:00:00 -05:00
|
|
|
shows using dynamic events and connecting/disconnecting the event handlers
|
2004-09-16 07:29:15 -04:00
|
|
|
during run time and also using
|
2001-01-31 11:00:00 -05:00
|
|
|
\helpref{PushEventHandler()}{wxwindowpusheventhandler} and
|
|
|
|
\helpref{PopEventHandler()}{wxwindowpopeventhandler}.
|
|
|
|
|
|
|
|
It replaces the old dynamic sample.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
|
|
|
\subsection{Except(ions) sample}\label{sampleexcept}
|
|
|
|
|
2004-05-04 04:27:20 -04:00
|
|
|
This very simple sample shows how to use C++ exceptions in wxWidgets programs,
|
2003-09-17 19:25:22 -04:00
|
|
|
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$
|
2004-07-04 07:19:47 -04:00
|
|
|
and compile your code with C++ exceptions support to be able to build this
|
2003-09-17 19:25:22 -04:00
|
|
|
sample.
|
|
|
|
|
|
|
|
|
2000-01-15 17:36:52 -05:00
|
|
|
\subsection{Exec sample}\label{sampleexec}
|
|
|
|
|
2004-09-16 07:29:15 -04:00
|
|
|
The exec sample demonstrates the \helpref{wxExecute}{wxexecute} and
|
2000-01-15 17:36:52 -05:00
|
|
|
\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).
|
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
It also shows how to capture the output of the child process in both
|
2004-09-16 07:29:15 -04:00
|
|
|
synchronous and asynchronous cases and how to kill the processes with
|
|
|
|
\helpref{wxProcess::Kill}{wxprocesskill} and test for their existence with
|
2001-06-15 20:59:07 -04:00
|
|
|
\helpref{wxProcess::Exists}{wxprocessexists}.
|
2000-07-15 15:51:35 -04:00
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
1999-11-03 18:51:07 -05:00
|
|
|
\subsection{Font sample}\label{samplefont}
|
|
|
|
|
2004-09-16 07:29:15 -04:00
|
|
|
The font sample demonstrates \helpref{wxFont}{wxfont},
|
|
|
|
\helpref{wxFontEnumerator}{wxfontenumerator} and
|
1999-11-03 18:51:07 -05:00
|
|
|
\helpref{wxFontMapper}{wxfontmapper} classes. It allows you to see the fonts
|
2004-05-04 04:27:20 -04:00
|
|
|
available (to wxWidgets) on the computer and shows all characters of the
|
1999-11-03 18:51:07 -05:00
|
|
|
chosen font as well.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-02-07 10:48:53 -05:00
|
|
|
\subsection{Grid sample}\label{samplegrid}
|
|
|
|
|
|
|
|
TODO.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
1999-12-13 03:43:50 -05:00
|
|
|
\subsection{HTML samples}\label{samplehtml}
|
|
|
|
|
|
|
|
Eight HTML samples (you can find them in directory {\tt samples/html})
|
2004-07-04 07:19:47 -04:00
|
|
|
cover all features of the HTML sub-library.
|
1999-12-13 03:43:50 -05:00
|
|
|
|
2004-09-16 07:29:15 -04:00
|
|
|
{\bf Test} demonstrates how to create \helpref{wxHtmlWindow}{wxhtmlwindow}
|
2004-07-04 07:19:47 -04:00
|
|
|
and also shows most supported HTML tags.
|
1999-12-13 03:43:50 -05:00
|
|
|
|
2004-07-04 07:19:47 -04:00
|
|
|
{\bf Widget} shows how you can embed ordinary controls or windows within an
|
1999-12-13 03:43:50 -05:00
|
|
|
HTML page. It also nicely explains how to write new tag handlers and extend
|
|
|
|
the library to work with unsupported tags.
|
|
|
|
|
2004-07-04 07:19:47 -04:00
|
|
|
{\bf About} may give you an idea how to write good-looking About boxes.
|
1999-12-13 03:43:50 -05:00
|
|
|
|
|
|
|
{\bf Zip} demonstrates use of virtual file systems in wxHTML. The zip archives
|
2004-09-16 07:29:15 -04:00
|
|
|
handler (ships with wxWidgets) allows you to access HTML pages stored
|
2004-07-04 07:19:47 -04:00
|
|
|
in a compressed archive as if they were ordinary files.
|
1999-12-13 03:43:50 -05:00
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
{\bf Virtual} is yet another virtual file systems demo. This one generates pages at run-time.
|
1999-12-13 03:43:50 -05:00
|
|
|
You may find it useful if you need to display some reports in your application.
|
|
|
|
|
2004-09-16 07:29:15 -04:00
|
|
|
{\bf Printing} explains use of \helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting}
|
|
|
|
class which serves as as-simple-as-possible interface for printing HTML
|
1999-12-13 03:43:50 -05:00
|
|
|
documents without much work. In fact, only few function calls are sufficient.
|
|
|
|
|
2004-09-16 07:29:15 -04:00
|
|
|
{\bf Help} and {\bf Helpview} are variations on displaying HTML help
|
|
|
|
(compatible with MS HTML Help Workshop). {\it Help} shows how to embed
|
1999-12-13 03:43:50 -05:00
|
|
|
\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} in your application
|
2004-07-04 07:19:47 -04:00
|
|
|
while {\it Helpview} is a simple tool that only pops up the help window and
|
1999-12-13 03:43:50 -05:00
|
|
|
displays help books given at command line.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-02-07 10:48:53 -05:00
|
|
|
\subsection{Image sample}\label{sampleimage}
|
|
|
|
|
2004-09-03 22:44:43 -04:00
|
|
|
The image sample demonstrates use of the \helpref{wxImage}{wximage} class
|
2000-02-07 10:48:53 -05:00
|
|
|
and shows how to download images in a variety of formats, currently PNG, GIF,
|
2004-07-04 07:19:47 -04:00
|
|
|
TIFF, JPEG, BMP, PNM and PCX. The top of the sample shows two rectangles, one
|
2004-09-16 07:29:15 -04:00
|
|
|
of which is drawn directly in the window, the other one is drawn into a
|
2000-02-07 10:48:53 -05:00
|
|
|
\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
|
2004-07-04 07:19:47 -04:00
|
|
|
and wxBitmap as well as loading and saving PNG files are tested.
|
2000-02-07 10:48:53 -05:00
|
|
|
|
2004-07-04 07:19:47 -04:00
|
|
|
At the bottom of the main frame there is a test for using a monochrome bitmap by
|
2000-02-07 10:48:53 -05:00
|
|
|
drawing into a \helpref{wxMemoryDC}{wxmemorydc}. The bitmap is then drawn
|
2004-09-16 07:29:15 -04:00
|
|
|
specifying the foreground and background colours with
|
|
|
|
\helpref{wxDC::SetTextForeground}{wxdcsettextforeground} and
|
2000-02-07 10:48:53 -05:00
|
|
|
\helpref{wxDC::SetTextBackground}{wxdcsettextbackground} (on the left). The
|
|
|
|
bitmap is then converted to a wxImage and the foreground colour (black) is
|
|
|
|
replaced with red using \helpref{wxImage::Replace}{wximagereplace}.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2002-08-20 09:41:45 -04:00
|
|
|
\subsection{Internat(ionalization) sample}\label{sampleinternat}
|
|
|
|
|
2004-05-04 04:27:20 -04:00
|
|
|
The not very clearly named internat sample demonstrates the wxWidgets
|
2004-07-04 07:19:47 -04:00
|
|
|
internationalization (i18n for short from now on) features. To be more
|
2002-08-20 09:41:45 -04:00
|
|
|
precise, it only shows localization support, i.e. support for translating the
|
2004-09-03 22:44:43 -04:00
|
|
|
program messages into another language while true i18n would also involve
|
2002-08-20 09:41:45 -04:00
|
|
|
changing the other aspects of the programs behaviour.
|
|
|
|
|
|
|
|
More information about this sample can be found in the {\tt readme.txt} file in
|
2002-08-23 11:59:29 -04:00
|
|
|
its directory. Please see also \helpref{i18n overview}{internationalization}.
|
2002-08-20 09:41:45 -04:00
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-01-04 14:41:25 -05:00
|
|
|
\subsection{Layout sample}\label{samplelayout}
|
|
|
|
|
|
|
|
The layout sample demonstrates the two different layout systems offered
|
2004-05-04 04:27:20 -04:00
|
|
|
by wxWidgets. When starting the program, you will see a frame with some
|
2000-01-04 14:41:25 -05:00
|
|
|
controls and some graphics. The controls will change their size whenever
|
|
|
|
you resize the entire frame and the exact behaviour of the size changes
|
2004-09-16 07:29:15 -04:00
|
|
|
is determined using the \helpref{wxLayoutConstraints}{wxlayoutconstraints}
|
|
|
|
class. See also the \helpref{overview}{constraintsoverview} and the
|
|
|
|
\helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}
|
2000-01-04 14:41:25 -05:00
|
|
|
class for further information.
|
|
|
|
|
|
|
|
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
|
2004-09-16 07:29:15 -04:00
|
|
|
showing how to use sizers in connection with a \helpref{wxNotebook}{wxnotebook}
|
2004-06-24 07:59:38 -04:00
|
|
|
class. See also \helpref{wxSizer}{wxsizer}.
|
2000-01-04 14:41:25 -05:00
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-02-07 10:48:53 -05:00
|
|
|
\subsection{Listctrl sample}\label{samplelistctrl}
|
2000-01-16 14:24:57 -05:00
|
|
|
|
2004-07-04 07:19:47 -04:00
|
|
|
This sample shows the \helpref{wxListCtrl}{wxlistctrl} control. Different modes
|
2000-02-07 10:48:53 -05:00
|
|
|
supported by the control (list, icons, small icons, report) may be chosen from
|
|
|
|
the menu.
|
2000-01-16 14:24:57 -05:00
|
|
|
|
2000-02-07 10:48:53 -05:00
|
|
|
The sample also provides some timings for adding/deleting/sorting a lot of
|
2003-08-06 08:59:59 -04:00
|
|
|
(several thousands) items into the control.
|
|
|
|
|
|
|
|
|
2004-11-14 18:33:12 -05:00
|
|
|
\subsection{Mediaplayer sample}\label{samplemediaplayer}
|
|
|
|
|
|
|
|
This sample demonstrates how to use all the features of
|
2004-11-23 06:45:07 -05:00
|
|
|
\helpref{wxMediaCtrl}{wxmediactrl} and play various types of sound, video,
|
2004-11-14 18:33:12 -05:00
|
|
|
and other files.
|
|
|
|
|
|
|
|
|
|
|
|
It replaces the old dynamic sample.
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2003-08-21 19:16:41 -04:00
|
|
|
\subsection{Notebook sample}\label{samplenotebook}
|
|
|
|
|
2005-02-11 11:24:25 -05:00
|
|
|
This samples shows \helpref{wxBookCtrl}{wxbookctrloverview} family of controls.
|
2004-09-17 14:20:08 -04:00
|
|
|
Although initially it was written to demonstrate \helpref{wxNotebook}{wxnotebook}
|
|
|
|
only, it can now be also used to see \helpref{wxListbook}{wxlistbook} and
|
|
|
|
\helpref{wxChoicebook}{wxchoicebook} in action. Test each of the controls, their
|
|
|
|
orientation, images and pages using commands through menu.
|
2003-08-21 19:16:41 -04:00
|
|
|
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2003-08-06 08:59:59 -04:00
|
|
|
\subsection{Render sample}\label{samplerender}
|
|
|
|
|
2004-09-16 07:29:15 -04:00
|
|
|
This sample shows how to replace the default wxWidgets
|
2003-08-06 08:59:59 -04:00
|
|
|
\helpref{renderer}{wxrenderernative} and also how to write a shared library
|
|
|
|
(DLL) implementing a renderer and load and unload it during the run-time.
|
|
|
|
|
2000-01-16 14:24:57 -05:00
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2001-10-08 13:46:04 -04:00
|
|
|
\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.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2001-10-08 13:46:04 -04:00
|
|
|
\subsection{Scroll subwindow sample}\label{samplescrollsub}
|
|
|
|
|
2004-09-16 07:29:15 -04:00
|
|
|
This sample demonstrates use of the \helpref{wxScrolledWindow}{wxscrolledwindow}
|
|
|
|
class including placing subwindows into it and drawing simple graphics. It uses the
|
2001-10-08 13:46:04 -04:00
|
|
|
\helpref{SetTargetWindow}{wxscrolledwindowsettargetwindow} method and thus the effect
|
|
|
|
of scrolling does not show in the scrolled window itself, but in one of its subwindows.
|
|
|
|
|
2004-05-04 04:27:20 -04:00
|
|
|
Additionally, this samples demonstrates how to optimize drawing operations in wxWidgets,
|
2004-09-16 07:29:15 -04:00
|
|
|
in particular using the \helpref{wxWindow::IsExposed}{wxwindowisexposed} method with
|
|
|
|
the aim to prevent unnecessary drawing in the window and thus reducing or removing
|
2001-10-08 13:46:04 -04:00
|
|
|
flicker on screen.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-01-24 15:46:54 -05:00
|
|
|
\subsection{Sockets sample}\label{samplesockets}
|
|
|
|
|
|
|
|
The sockets sample demonstrates how to use the communication facilities
|
|
|
|
provided by \helpref{wxSocket}{wxsocketbase}. There are two different
|
2004-09-16 07:29:15 -04:00
|
|
|
applications in this sample: a server, which is implemented using a
|
2000-03-10 12:59:20 -05:00
|
|
|
\helpref{wxSocketServer}{wxsocketserver} object, and a client, which
|
|
|
|
is implemented as a \helpref{wxSocketClient}{wxsocketclient}.
|
|
|
|
|
|
|
|
The server binds to the local address, using TCP port number 3000,
|
|
|
|
sets up an event handler to be notified of incoming connection requests
|
2004-07-04 07:19:47 -04:00
|
|
|
({\bf wxSOCKET\_CONNECTION} events), and sits there, waiting for clients
|
2004-09-03 22:44:43 -04:00
|
|
|
({\it listening}, in socket parlance). For each accepted connection,
|
2000-03-10 12:59:20 -05:00
|
|
|
a new \helpref{wxSocketBase}{wxsocketbase} object is created. These
|
|
|
|
socket objects are independent from the server that created them, so
|
|
|
|
they set up their own event handler, and then request to be notified
|
2004-09-16 07:29:15 -04:00
|
|
|
of {\bf wxSOCKET\_INPUT} (incoming data) or {\bf wxSOCKET\_LOST}
|
2000-03-10 12:59:20 -05:00
|
|
|
(connection closed at the remote end) events. In the sample, the event
|
|
|
|
handler is the same for all connections; to find out which socket the
|
2000-07-15 15:51:35 -04:00
|
|
|
event is addressed to, the \helpref{GetSocket}{wxsocketeventgetsocket} function
|
|
|
|
is used.
|
2000-01-24 15:46:54 -05:00
|
|
|
|
|
|
|
Although it might take some time to get used to the event-oriented
|
|
|
|
system upon which wxSocket is built, the benefits are many. See, for
|
|
|
|
example, that the server application, while being single-threaded
|
|
|
|
(and of course without using fork() or ugly select() loops) can handle
|
|
|
|
an arbitrary number of connections.
|
|
|
|
|
|
|
|
The client starts up unconnected, so you can use the Connect... option
|
|
|
|
to specify the address of the server you are going to connect to (the
|
|
|
|
TCP port number is hard-coded as 3000). Once connected, a number of
|
|
|
|
tests are possible. Currently, three tests are implemented. They show
|
|
|
|
how to use the basic IO calls in \helpref{wxSocketBase}{wxsocketbase},
|
2004-09-16 07:29:15 -04:00
|
|
|
such as \helpref{Read}{wxsocketbaseread}, \helpref{Write}{wxsocketbasewrite},
|
2000-01-24 15:46:54 -05:00
|
|
|
\helpref{ReadMsg}{wxsocketbasereadmsg} and \helpref{WriteMsg}{wxsocketbasewritemsg},
|
|
|
|
and how to set up the correct IO flags depending on what you are going to
|
2000-03-10 12:59:20 -05:00
|
|
|
do. See the comments in the code for more information. Note that because
|
|
|
|
both clients and connection objects in the server set up an event handler
|
|
|
|
to catch {\bf wxSOCKET\_LOST} events, each one is immediately notified
|
|
|
|
if the other end closes the connection.
|
2000-01-24 15:46:54 -05:00
|
|
|
|
2004-07-04 07:19:47 -04:00
|
|
|
There is also a URL test which shows how to use
|
2000-07-15 15:51:35 -04:00
|
|
|
the \helpref{wxURL}{wxurl} class to fetch data from a given URL.
|
2000-03-06 11:31:05 -05:00
|
|
|
|
2000-03-10 12:59:20 -05:00
|
|
|
The sockets sample is work in progress. Some things to do:
|
2000-01-24 15:46:54 -05:00
|
|
|
|
2000-02-11 14:42:46 -05:00
|
|
|
\begin{itemize}\itemsep=0pt
|
2000-01-24 15:46:54 -05:00
|
|
|
\item More tests for basic socket functionality.
|
2000-03-06 11:31:05 -05:00
|
|
|
\item More tests for protocol classes (wxProtocol and its descendants).
|
2000-03-10 12:59:20 -05:00
|
|
|
\item Tests for the recently added (and still in alpha stage) datagram sockets.
|
2000-01-24 15:46:54 -05:00
|
|
|
\item New samples which actually do something useful (suggestions accepted).
|
|
|
|
\end{itemize}
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2004-02-01 05:53:59 -05:00
|
|
|
\subsection{Sound sample}\label{samplesound}
|
|
|
|
|
2004-02-02 08:42:04 -05:00
|
|
|
The {\tt sound} sample shows how to use \helpref{wxSound}{wxsound} for simple
|
2004-02-01 05:53:59 -05:00
|
|
|
audio output (e.g. notifications).
|
|
|
|
|
|
|
|
|
2000-02-04 15:27:10 -05:00
|
|
|
\subsection{Statbar sample}\label{samplestatbar}
|
|
|
|
|
2000-02-10 00:01:21 -05:00
|
|
|
This sample shows how to create and use wxStatusBar. Although most of the
|
2000-02-04 15:27:10 -05:00
|
|
|
samples have a statusbar, they usually only create a default one and only
|
|
|
|
do it once.
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-01-04 14:41:25 -05:00
|
|
|
\subsection{Text sample}\label{sampletext}
|
|
|
|
|
|
|
|
This sample demonstrates four features: firstly the use and many variants of
|
|
|
|
the \helpref{wxTextCtrl}{wxtextctrl} class (single line, multi line, read only,
|
|
|
|
password, ignoring TAB, ignoring ENTER).
|
|
|
|
|
|
|
|
Secondly it shows how to intercept a \helpref{wxKeyEvent}{wxkeyevent} in both
|
2000-02-07 05:14:56 -05:00
|
|
|
the raw form using the {\tt EVT\_KEY\_UP} and {\tt EVT\_KEY\_DOWN} macros and the
|
2000-07-15 15:51:35 -04:00
|
|
|
higher level from using the {\tt EVT\_CHAR} macro. All characters will be logged
|
2000-01-04 14:41:25 -05:00
|
|
|
in a log window at the bottom of the main window. By pressing some of the function
|
2000-07-15 15:51:35 -04:00
|
|
|
keys, you can test some actions in the text ctrl as well as get statistics on the
|
2002-06-07 16:15:28 -04:00
|
|
|
text ctrls, which is useful for testing if these statistics actually are correct.
|
2000-01-04 14:41:25 -05:00
|
|
|
|
2004-09-16 07:29:15 -04:00
|
|
|
Thirdly, on platforms which support it, the sample will offer to copy text to the
|
2000-01-04 14:41:25 -05:00
|
|
|
\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
|
2001-10-08 13:46:04 -04:00
|
|
|
best known from pasting text to the XTerm program.
|
2000-01-04 14:41:25 -05:00
|
|
|
|
|
|
|
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.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-01-02 16:52:18 -05:00
|
|
|
\subsection{Thread sample}\label{samplethread}
|
|
|
|
|
2004-09-03 22:44:43 -04:00
|
|
|
This sample demonstrates use of threads in connection with GUI programs.
|
2000-01-02 16:52:18 -05:00
|
|
|
There are two fundamentally different ways to use threads in GUI programs and
|
|
|
|
either way has to take care of the fact that the GUI library itself usually
|
|
|
|
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
|
2004-09-16 07:29:15 -04:00
|
|
|
GUI program in the main thread and some worker threads which work in the
|
2000-01-02 16:52:18 -05:00
|
|
|
background. In order to make communication between the main thread and the
|
2004-09-16 07:29:15 -04:00
|
|
|
worker threads possible, wxWidgets offers the \helpref{wxPostEvent}{wxpostevent}
|
2000-01-02 16:52:18 -05:00
|
|
|
function and this sample makes use of this function.
|
|
|
|
|
2004-09-16 07:29:15 -04:00
|
|
|
The other way to use a so called Mutex (such as those offered in the \helpref{wxMutex}{wxmutex}
|
2000-01-02 16:52:18 -05:00
|
|
|
class) that prevent threads from accessing the GUI classes as long as any other
|
2004-09-16 07:29:15 -04:00
|
|
|
thread accesses them. For this, wxWidgets has the \helpref{wxMutexGuiEnter}{wxmutexguienter}
|
2000-01-02 16:52:18 -05:00
|
|
|
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}.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
1999-12-13 21:02:09 -05:00
|
|
|
\subsection{Toolbar sample}\label{sampletoolbar}
|
|
|
|
|
|
|
|
The toolbar sample shows the \helpref{wxToolBar}{wxtoolbar} class in action.
|
|
|
|
|
|
|
|
The following things are demonstrated:
|
|
|
|
|
2000-02-11 14:42:46 -05:00
|
|
|
\begin{itemize}\itemsep=0pt
|
2004-09-16 07:29:15 -04:00
|
|
|
\item Creating the toolbar using \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}
|
1999-12-13 21:02:09 -05:00
|
|
|
and \helpref{wxToolBar::AddControl}{wxtoolbaraddcontrol}: see
|
|
|
|
MyApp::InitToolbar in the sample.
|
|
|
|
\item Using {\tt EVT\_UPDATE\_UI} handler for automatically enabling/disabling
|
2000-07-15 15:51:35 -04:00
|
|
|
toolbar buttons without having to explicitly call EnableTool. This is done
|
1999-12-13 21:02:09 -05:00
|
|
|
in MyFrame::OnUpdateCopyAndCut.
|
2004-09-16 07:29:15 -04:00
|
|
|
\item Using \helpref{wxToolBar::DeleteTool}{wxtoolbardeletetool} and
|
1999-12-13 21:02:09 -05:00
|
|
|
\helpref{wxToolBar::InsertTool}{wxtoolbarinserttool} to dynamically update the
|
|
|
|
toolbar.
|
|
|
|
\end{itemize}
|
2000-02-07 10:48:53 -05:00
|
|
|
|
2002-03-26 11:24:04 -05:00
|
|
|
Some buttons in the main toolbar are check buttons, i.e. they stay checked when
|
2004-07-04 07:19:47 -04:00
|
|
|
pressed. On the platforms which support it, the sample also adds a combobox
|
2002-03-26 11:24:04 -05:00
|
|
|
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
|
2004-07-04 07:19:47 -04:00
|
|
|
group, i.e. checking any of them automatically unchecks the previously
|
2002-03-26 11:24:04 -05:00
|
|
|
checked one.
|
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-02-07 10:48:53 -05:00
|
|
|
\subsection{Treectrl sample}\label{sampletreectrl}
|
|
|
|
|
2004-09-03 22:44:43 -04:00
|
|
|
This sample demonstrates using the \helpref{wxTreeCtrl}{wxtreectrl} class. Here
|
2000-02-07 10:48:53 -05:00
|
|
|
you may see how to process various notification messages sent by this control
|
|
|
|
and also when they occur (by looking at the messages in the text control in
|
|
|
|
the bottom part of the frame).
|
|
|
|
|
|
|
|
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.
|
2000-02-11 14:42:46 -05:00
|
|
|
|
2003-09-17 19:25:22 -04:00
|
|
|
|
2000-07-15 15:51:35 -04:00
|
|
|
\subsection{Wizard sample}\label{samplewizard}
|
|
|
|
|
2004-09-16 07:29:15 -04:00
|
|
|
This sample shows the so-called wizard dialog (implemented using
|
2000-07-15 15:51:35 -04:00
|
|
|
\helpref{wxWizard}{wxwizard} and related classes). It shows almost all
|
|
|
|
features supported:
|
|
|
|
|
|
|
|
\begin{itemize}\itemsep=0pt
|
|
|
|
\item Using bitmaps with the wizard and changing them depending on the page
|
|
|
|
shown (notice that wxValidationPage in the sample has a different image from
|
|
|
|
the other ones)
|
2004-09-16 07:29:15 -04:00
|
|
|
\item Using \helpref{TransferDataFromWindow}{wxwindowtransferdatafromwindow}
|
2000-07-15 15:51:35 -04:00
|
|
|
to verify that the data entered is correct before passing to the next page
|
|
|
|
(done in wxValidationPage which forces the user to check a checkbox before
|
|
|
|
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)
|
2004-07-04 07:19:47 -04:00
|
|
|
\item This (wxRadioboxPage) page also shows how the page may process the {\tt
|
2000-07-15 15:51:35 -04:00
|
|
|
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
|
2004-09-16 07:29:15 -04:00
|
|
|
dynamically decide which page to display next (see also
|
2000-07-15 15:51:35 -04:00
|
|
|
\helpref{wxWizardPage}{wxwizardpage})
|
|
|
|
\end{itemize}
|
|
|
|
|