]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/tsamples.tex
added missing libraries to the requirements list
[wxWidgets.git] / docs / latex / wx / tsamples.tex
CommitLineData
eb91c0be
VZ
1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name: tsamples.tex
3%% Purpose: Samples description
4%% Author: Vadim Zeitlin
5%% Modified by:
6%% Created: 02.11.99
7%% RCS-ID: $Id$
fc2171bd 8%% Copyright: (c) wxWidgets team
8795498c 9%% License: wxWindows license
eb91c0be 10%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
963863ad
VZ
11% NB: please keep the subsections in alphabetic order!
12
fc2171bd 13\section{wxWidgets samples}\label{samples}
eb91c0be 14
fc2171bd
JS
15Probably the best way to learn wxWidgets is by reading the source of some 50+
16samples provided with it. Many aspects of wxWidgets programming can be learnt
eb91c0be
VZ
17from them, but sometimes it is not simple to just choose the right sample to
18look at. This overview aims at describing what each sample does/demonstrates to
19make it easier to find the relevant one if a simple grep through all sources
20didn't help. They also provide some notes about using the samples and what
fc2171bd 21features of wxWidgets are they supposed to test.
eb91c0be 22
fc2171bd 23There are currently more than 50 different samples as part of wxWidgets and
f5e0b4bc 24this list is not complete. You should start your tour of wxWidgets with the
fc2171bd
JS
25\helpref{minimal sample}{sampleminimal} which is the wxWidgets version of
26"Hello, world!". It shows the basic structure of wxWidgets program and is the
963863ad
VZ
27most commented sample of all - looking at its source code is recommended.
28
d0e834f3 29The next most useful samples are probably \helpref{widgets}{samplewidgets}
b26f2425
WS
30and \helpref{controls}{samplecontrols} which show many of wxWidgets native and
31generic controls, such as buttons, listboxes, checkboxes, comboboxes etc.
963863ad
VZ
32
33Other, more complicated controls, have their own samples. In this category you
34may find the following samples showing the corresponding controls:
35
36\begin{twocollist}\itemsep=0pt
37\twocolitem{\helpref{wxCalendarCtrl}{samplecalendar}}{Calendar a.k.a. date picker control}
38\twocolitem{\helpref{wxListCtrl}{samplelistctrl}}{List view control}
39\twocolitem{\helpref{wxTreeCtrl}{sampletreectrl}}{Tree view control}
40\twocolitem{\helpref{wxGrid}{samplegrid}}{Grid control}
41\end{twocollist}
42
43Finally, it might be helpful to do a search in the entire sample directory if
87b6002d
VZ
44you can't find the sample showing the control you are interested in by
45name. Most classes contained in wxWidgets occur in at least one of the samples.
238ddd26 46
4c39aa3a 47
238ddd26
RR
48\subsection{Minimal sample}\label{sampleminimal}
49
50The minimal sample is what most people will know under the term Hello World,
51i.e. a minimal program that doesn't demonstrate anything apart from what is
52needed to write a program that will display a "hello" dialog. This is usually
fc2171bd 53a good starting point for learning how to use wxWidgets.
238ddd26 54
4c39aa3a 55
fabe121c
WS
56\subsection{Animate sample}\label{sampleanimate}
57
58The {\tt animate} sample shows how you can use \helpref{wxAnimationCtrl}{wxanimationctrl}
59control and shows concept of a platform-dependent animation encapsulated
60in \helpref{wxAnimation}{wxanimation}.
61
62
c9d0bc8a
VS
63\subsection{Art provider sample}\label{sampleartprovider}
64
65The {\tt artprov} sample shows how you can customize the look of standard
fc2171bd 66wxWidgets dialogs by replacing default bitmaps/icons with your own versions.
f4fcc291 67It also shows how you can use wxArtProvider to
c9d0bc8a
VS
68get stock bitmaps for use in your application.
69
4c39aa3a 70
4f6aed9c
VZ
71\subsection{Calendar sample}\label{samplecalendar}
72
73This font shows the \helpref{calendar control}{wxcalendarctrl} in action. It
74shows how to configure the control (see the different options in the calendar
75menu) and also how to process the notifications from it.
76
4c39aa3a 77
cddfbd9f
RR
78\subsection{Checklist sample}\label{samplechecklist}
79
f70c0443
WS
80This sample demonstrates use of the \helpref{wxCheckListBox}{wxchecklistbox}
81class intercepting check, select and double click events. It also tests
f6bcfd97 82use of various methods modifying the control, such as by deleting items
87b6002d 83from it or inserting new ones (these functions are actually implemented in
cddfbd9f
RR
84the parent class \helpref{wxListBox}{wxlistbox} so the sample tests that class
85as well). The layout of the dialog is created using a \helpref{wxBoxSizer}{wxboxsizer}
86demonstrating a simple dynamic layout.
87
4c39aa3a 88
cddfbd9f
RR
89\subsection{Config sample}\label{sampleconfig}
90
91This sample demonstrates the \helpref{wxConfig}{wxconfigbase} classes in a platform
2edb0bde 92independent way, i.e. it uses text based files to store a given configuration under
cddfbd9f
RR
93Unix and uses the Registry under Windows.
94
95See \helpref{wxConfig overview}{wxconfigoverview} for the descriptions of all
96features of this class.
97
4c39aa3a 98
32ab332f
RR
99\subsection{Controls sample}\label{samplecontrols}
100
101The controls sample is the main test program for most simple controls used in
fc2171bd 102wxWidgets. The sample tests their basic functionality, events, placement,
32ab332f 103modification in terms of colour and font as well as the possibility to change
87b6002d 104the controls programmatically, such as adding an item to a list box etc. Apart
32ab332f 105from that, the sample uses a \helpref{wxNotebook}{wxnotebook} and tests most
f5e0b4bc 106features of this special control (using bitmap in the tabs, using
32ab332f 107\helpref{wxSizers}{wxsizer} and \helpref{constraints}{wxlayoutconstraints} within
f6bcfd97 108notebook pages, advancing pages programmatically and vetoing a page change
32ab332f
RR
109by intercepting the \helpref{wxNotebookEvent}{wxnotebookevent}.
110
111The various controls tested are listed here:
ecf527c0 112
32ab332f
RR
113\begin{twocollist}\itemsep=0pt
114\twocolitem{\helpref{wxButton}{wxbutton}}{Push button control, displaying text}
115\twocolitem{\helpref{wxBitmapButton}{wxbitmapbutton}}{Push button control, displaying a bitmap}
116\twocolitem{\helpref{wxCheckBox}{wxcheckbox}}{Checkbox control}
117\twocolitem{\helpref{wxChoice}{wxchoice}}{Choice control (a combobox without the editable area)}
118\twocolitem{\helpref{wxComboBox}{wxcombobox}}{A choice with an editable area}
119\twocolitem{\helpref{wxGauge}{wxgauge}}{A control to represent a varying quantity, such as time remaining}
120\twocolitem{\helpref{wxStaticBox}{wxstaticbox}}{A static, or group box for visually grouping related controls}
121\twocolitem{\helpref{wxListBox}{wxlistbox}}{A list of strings for single or multiple selection}
122\twocolitem{wxSpinCtrl}{A spin ctrl with a text field and a `up-down' control}
123\twocolitem{\helpref{wxSpinButton}{wxspinbutton}}{A spin or `up-down' control}
124\twocolitem{\helpref{wxStaticText}{wxstatictext}}{One or more lines of non-editable text}
125\twocolitem{\helpref{wxStaticBitmap}{wxstaticbitmap}}{A control to display a bitmap}
126\twocolitem{\helpref{wxRadioBox}{wxradiobox}}{A group of radio buttons}
127\twocolitem{\helpref{wxRadioButton}{wxradiobutton}}{A round button to be used with others in a mutually exclusive way}
128\twocolitem{\helpref{wxSlider}{wxslider}}{A slider that can be dragged by the user}
129\end{twocollist}
130
4c39aa3a 131
32ab332f
RR
132\subsection{Database sample}\label{sampledb}
133
134The database sample is a small test program showing how to use the ODBC
f5e0b4bc 135classes written by Remstar Intl. Obviously, this sample requires a
19320af4 136database with ODBC support to be correctly installed on your system.
32ab332f 137
4c39aa3a 138
df1b5a2a
VZ
139\subsection{DebugRpt sample}\label{sampledebugrpt}
140
141This sample shows how to use \helpref{wxDebugReport}{wxdebugreport} class to
142generate a debug report in case of a program crash or otherwise. On start up,
143it proposes to either crash itself (by dereferencing a NULL pointer) or
144generate debug report without doing it. Next it initializes the debug report
145with standard information adding a custom file to it (just a timestamp) and
b26f2425 146allows to view the information gathered using
df1b5a2a
VZ
147\helpref{wxDebugReportPreview}{wxdebugreportpreview}.
148
149For the report processing part of the sample to work you should make available
b26f2425 150a Web server accepting form uploads, otherwise
df1b5a2a
VZ
151\helpref{wxDebugReportUpload}{wxdebugreportupload} will report an error.
152
153
cddfbd9f
RR
154\subsection{Dialogs sample}\label{sampledialogs}
155
fc2171bd 156This sample shows how to use the common dialogs available from wxWidgets. These
87b6002d 157dialogs are described in detail in the \helpref{Common dialogs overview}{commondialogsoverview}.
f6bcfd97 158
4c39aa3a 159
f6bcfd97
BP
160\subsection{Dialup sample}\label{sampledialup}
161
f5e0b4bc 162This sample shows the \helpref{wxDialUpManager}{wxdialupmanager}
f70c0443 163class. In the status bar, it displays the information gathered through its
2edb0bde 164interface: in particular, the current connection status (online or offline) and
f6bcfd97 165whether the connection is permanent (in which case a string `LAN' appears in
87b6002d 166the third status bar field - but note that you may be on a LAN not
f6bcfd97
BP
167connected to the Internet, in which case you will not see this) or not.
168
169Using the menu entries, you may also dial or hang up the line if you have a
170modem attached and (this only makes sense for Windows) list the available
171connections.
cddfbd9f 172
4c39aa3a 173
b9989817
VZ
174\subsection{DnD sample}\label{samplednd}
175
176This sample shows both clipboard and drag and drop in action. It is quite non
177trivial and may be safely used as a basis for implementing the clipboard and
178drag and drop operations in a real-life program.
179
180When you run the sample, its screen is split in several parts. On the top,
f5e0b4bc
WS
181there are two listboxes which show the standard derivations of
182\helpref{wxDropTarget}{wxdroptarget}:
183\helpref{wxTextDropTarget}{wxtextdroptarget} and
b9989817
VZ
184\helpref{wxFileDropTarget}{wxfiledroptarget}.
185
186The middle of the sample window is taken by the log window which shows what is
187going on (of course, this only works in debug builds) and may be helpful to see
188the sequence of steps of data transfer.
189
190Finally, the last part is used for dragging text from it to either one of the
191listboxes (only one will accept it) or another application. The last
192functionality available from the main frame is to paste a bitmap from the
87b6002d 193clipboard (or, in the case of the Windows version, also a metafile) - it will be
b9989817
VZ
194shown in a new frame.
195
196So far, everything we mentioned was implemented with minimal amount of code
fc2171bd 197using standard wxWidgets classes. The more advanced features are demonstrated
b9989817
VZ
198if you create a shape frame from the main frame menu. A shape is a geometric
199object which has a position, size and color. It models some
200application-specific data in this sample. A shape object supports its own
201private \helpref{wxDataFormat}{wxdataformat} which means that you may cut and
202paste it or drag and drop (between one and the same or different shapes) from
203one sample instance to another (or the same). However, chances are that no
204other program supports this format and so shapes can also be rendered as
205bitmaps which allows them to be pasted/dropped in many other applications
206(and, under Windows, also as metafiles which are supported by most of Windows
207programs as well - try Write/Wordpad, for example).
208
f5e0b4bc 209Take a look at DnDShapeDataObject class to see how you may use
b9989817
VZ
210\helpref{wxDataObject}{wxdataobject} to achieve this.
211
4c39aa3a 212
238ddd26
RR
213\subsection{Dynamic sample}\label{sampledynamic}
214
f70c0443 215This sample is a very small sample that demonstrates use of the
238ddd26 216\helpref{wxEvtHandler::Connect}{wxevthandlerconnect} method. This method
87b6002d 217should be used whenever it is not known at compile time which control
238ddd26
RR
218will receive which event or which controls are actually going to be in
219a dialog or frame. This is most typically the case for any scripting
fc2171bd 220language that would work as a wrapper for wxWidgets or programs where
87b6002d 221forms or similar datagrams can be created by the users.
238ddd26 222
6164f93c
VZ
223See also the \helpref{event sample}{sampleevent}
224
4c39aa3a 225
6164f93c
VZ
226\subsection{Event sample}\label{sampleevent}
227
fc2171bd 228The event sample demonstrates various features of the wxWidgets events. It
6164f93c 229shows using dynamic events and connecting/disconnecting the event handlers
f5e0b4bc 230during run time and also using
6164f93c
VZ
231\helpref{PushEventHandler()}{wxwindowpusheventhandler} and
232\helpref{PopEventHandler()}{wxwindowpopeventhandler}.
233
234It replaces the old dynamic sample.
235
4c39aa3a
VZ
236
237\subsection{Except(ions) sample}\label{sampleexcept}
238
fc2171bd 239This very simple sample shows how to use C++ exceptions in wxWidgets programs,
4c39aa3a
VZ
240i.e. where to catch the exception which may be thrown by the program code. It
241doesn't do anything very exciting by itself, you need to study its code to
242understand what goes on.
243
244You need to build the library with \texttt{wxUSE\_EXCEPTIONS} being set to $1$
87b6002d 245and compile your code with C++ exceptions support to be able to build this
4c39aa3a
VZ
246sample.
247
248
0d7ea902
VZ
249\subsection{Exec sample}\label{sampleexec}
250
f5e0b4bc 251The exec sample demonstrates the \helpref{wxExecute}{wxexecute} and
0d7ea902
VZ
252\helpref{wxShell}{wxshell} functions. Both of them are used to execute the
253external programs and the sample shows how to do this synchronously (waiting
254until the program terminates) or asynchronously (notification will come later).
255
f6bcfd97 256It also shows how to capture the output of the child process in both
f5e0b4bc
WS
257synchronous and asynchronous cases and how to kill the processes with
258\helpref{wxProcess::Kill}{wxprocesskill} and test for their existence with
50567b69 259\helpref{wxProcess::Exists}{wxprocessexists}.
f6bcfd97 260
4c39aa3a 261
775a998e
VZ
262\subsection{Font sample}\label{samplefont}
263
f5e0b4bc
WS
264The font sample demonstrates \helpref{wxFont}{wxfont},
265\helpref{wxFontEnumerator}{wxfontenumerator} and
775a998e 266\helpref{wxFontMapper}{wxfontmapper} classes. It allows you to see the fonts
fc2171bd 267available (to wxWidgets) on the computer and shows all characters of the
775a998e
VZ
268chosen font as well.
269
4c39aa3a 270
963863ad
VZ
271\subsection{Grid sample}\label{samplegrid}
272
273TODO.
274
4c39aa3a 275
61eff74f
VS
276\subsection{HTML samples}\label{samplehtml}
277
278Eight HTML samples (you can find them in directory {\tt samples/html})
87b6002d 279cover all features of the HTML sub-library.
61eff74f 280
f5e0b4bc 281{\bf Test} demonstrates how to create \helpref{wxHtmlWindow}{wxhtmlwindow}
87b6002d 282and also shows most supported HTML tags.
61eff74f 283
87b6002d 284{\bf Widget} shows how you can embed ordinary controls or windows within an
61eff74f
VS
285HTML page. It also nicely explains how to write new tag handlers and extend
286the library to work with unsupported tags.
287
87b6002d 288{\bf About} may give you an idea how to write good-looking About boxes.
61eff74f
VS
289
290{\bf Zip} demonstrates use of virtual file systems in wxHTML. The zip archives
f5e0b4bc 291handler (ships with wxWidgets) allows you to access HTML pages stored
87b6002d 292in a compressed archive as if they were ordinary files.
61eff74f 293
f6bcfd97 294{\bf Virtual} is yet another virtual file systems demo. This one generates pages at run-time.
61eff74f
VS
295You may find it useful if you need to display some reports in your application.
296
f5e0b4bc
WS
297{\bf Printing} explains use of \helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting}
298class which serves as as-simple-as-possible interface for printing HTML
61eff74f
VS
299documents without much work. In fact, only few function calls are sufficient.
300
f5e0b4bc
WS
301{\bf Help} and {\bf Helpview} are variations on displaying HTML help
302(compatible with MS HTML Help Workshop). {\it Help} shows how to embed
61eff74f 303\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} in your application
87b6002d 304while {\it Helpview} is a simple tool that only pops up the help window and
61eff74f
VS
305displays help books given at command line.
306
4c39aa3a 307
963863ad
VZ
308\subsection{Image sample}\label{sampleimage}
309
f70c0443 310The image sample demonstrates use of the \helpref{wxImage}{wximage} class
963863ad 311and shows how to download images in a variety of formats, currently PNG, GIF,
87b6002d 312TIFF, JPEG, BMP, PNM and PCX. The top of the sample shows two rectangles, one
f5e0b4bc 313of which is drawn directly in the window, the other one is drawn into a
963863ad
VZ
314\helpref{wxBitmap}{wxbitmap}, converted to a wxImage, saved as a PNG image
315and then reloaded from the PNG file again so that conversions between wxImage
87b6002d 316and wxBitmap as well as loading and saving PNG files are tested.
963863ad 317
87b6002d 318At the bottom of the main frame there is a test for using a monochrome bitmap by
963863ad 319drawing into a \helpref{wxMemoryDC}{wxmemorydc}. The bitmap is then drawn
f5e0b4bc
WS
320specifying the foreground and background colours with
321\helpref{wxDC::SetTextForeground}{wxdcsettextforeground} and
963863ad
VZ
322\helpref{wxDC::SetTextBackground}{wxdcsettextbackground} (on the left). The
323bitmap is then converted to a wxImage and the foreground colour (black) is
324replaced with red using \helpref{wxImage::Replace}{wximagereplace}.
325
4c39aa3a 326
fb848f58
VZ
327\subsection{Internat(ionalization) sample}\label{sampleinternat}
328
fc2171bd 329The not very clearly named internat sample demonstrates the wxWidgets
87b6002d 330internationalization (i18n for short from now on) features. To be more
fb848f58 331precise, it only shows localization support, i.e. support for translating the
f70c0443 332program messages into another language while true i18n would also involve
fb848f58
VZ
333changing the other aspects of the programs behaviour.
334
335More information about this sample can be found in the {\tt readme.txt} file in
a81705a3 336its directory. Please see also \helpref{i18n overview}{internationalization}.
fb848f58 337
4c39aa3a 338
238ddd26
RR
339\subsection{Layout sample}\label{samplelayout}
340
341The layout sample demonstrates the two different layout systems offered
fc2171bd 342by wxWidgets. When starting the program, you will see a frame with some
238ddd26
RR
343controls and some graphics. The controls will change their size whenever
344you resize the entire frame and the exact behaviour of the size changes
f5e0b4bc
WS
345is determined using the \helpref{wxLayoutConstraints}{wxlayoutconstraints}
346class. See also the \helpref{overview}{constraintsoverview} and the
347\helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}
238ddd26
RR
348class for further information.
349
350The menu in this sample offers two more tests, one showing how to use
351a \helpref{wxBoxSizer}{wxboxsizer} in a simple dialog and the other one
f5e0b4bc 352showing how to use sizers in connection with a \helpref{wxNotebook}{wxnotebook}
c6eb7785 353class. See also \helpref{wxSizer}{wxsizer}.
238ddd26 354
4c39aa3a 355
963863ad 356\subsection{Listctrl sample}\label{samplelistctrl}
32ab332f 357
87b6002d 358This sample shows the \helpref{wxListCtrl}{wxlistctrl} control. Different modes
963863ad
VZ
359supported by the control (list, icons, small icons, report) may be chosen from
360the menu.
32ab332f 361
963863ad 362The sample also provides some timings for adding/deleting/sorting a lot of
3e6c2880
VZ
363(several thousands) items into the control.
364
365
db55c58f
RN
366\subsection{Mediaplayer sample}\label{samplemediaplayer}
367
368This sample demonstrates how to use all the features of
61c083e7 369\helpref{wxMediaCtrl}{wxmediactrl} and play various types of sound, video,
db55c58f
RN
370and other files.
371
372
373It replaces the old dynamic sample.
4c39aa3a 374
c16b8e18
VZ
375\subsection{Notebook sample}\label{samplenotebook}
376
b742a43b 377This samples shows \helpref{wxBookCtrl}{wxbookctrloverview} family of controls.
566a06e8 378Although initially it was written to demonstrate \helpref{wxNotebook}{wxnotebook}
eca15c0d
VZ
379only, it can now be also used to see \helpref{wxListbook}{wxlistbook},
380\helpref{wxChoicebook}{wxchoicebook} and \helpref{wxTreebook}{wxtreebook} in action.
381Test each of the controls, their orientation, images and pages using commands through menu.
c16b8e18
VZ
382
383
4c39aa3a 384
3e6c2880
VZ
385\subsection{Render sample}\label{samplerender}
386
f5e0b4bc 387This sample shows how to replace the default wxWidgets
3e6c2880
VZ
388\helpref{renderer}{wxrenderernative} and also how to write a shared library
389(DLL) implementing a renderer and load and unload it during the run-time.
390
32ab332f 391
4c39aa3a 392
b9989817
VZ
393\subsection{Rotate sample}\label{samplerotate}
394
395This is a simple example which demonstrates how to rotate an image with
396the \helpref{wxImage::Rotate}{wximagerotate} method. The rotation can
397be done without interpolation (left mouse button) which will be faster,
398or with interpolation (right mouse button) which is slower but gives
399better results.
400
4c39aa3a 401
b9989817
VZ
402\subsection{Scroll subwindow sample}\label{samplescrollsub}
403
f5e0b4bc
WS
404This sample demonstrates use of the \helpref{wxScrolledWindow}{wxscrolledwindow}
405class including placing subwindows into it and drawing simple graphics. It uses the
b9989817
VZ
406\helpref{SetTargetWindow}{wxscrolledwindowsettargetwindow} method and thus the effect
407of scrolling does not show in the scrolled window itself, but in one of its subwindows.
408
fc2171bd 409Additionally, this samples demonstrates how to optimize drawing operations in wxWidgets,
f5e0b4bc
WS
410in particular using the \helpref{wxWindow::IsExposed}{wxwindowisexposed} method with
411the aim to prevent unnecessary drawing in the window and thus reducing or removing
b9989817
VZ
412flicker on screen.
413
4c39aa3a 414
e5a2291a
GRG
415\subsection{Sockets sample}\label{samplesockets}
416
417The sockets sample demonstrates how to use the communication facilities
418provided by \helpref{wxSocket}{wxsocketbase}. There are two different
f5e0b4bc 419applications in this sample: a server, which is implemented using a
5adbbc29
GRG
420\helpref{wxSocketServer}{wxsocketserver} object, and a client, which
421is implemented as a \helpref{wxSocketClient}{wxsocketclient}.
422
423The server binds to the local address, using TCP port number 3000,
424sets up an event handler to be notified of incoming connection requests
87b6002d 425({\bf wxSOCKET\_CONNECTION} events), and sits there, waiting for clients
f70c0443 426({\it listening}, in socket parlance). For each accepted connection,
5adbbc29
GRG
427a new \helpref{wxSocketBase}{wxsocketbase} object is created. These
428socket objects are independent from the server that created them, so
429they set up their own event handler, and then request to be notified
f5e0b4bc 430of {\bf wxSOCKET\_INPUT} (incoming data) or {\bf wxSOCKET\_LOST}
5adbbc29
GRG
431(connection closed at the remote end) events. In the sample, the event
432handler is the same for all connections; to find out which socket the
f6bcfd97
BP
433event is addressed to, the \helpref{GetSocket}{wxsocketeventgetsocket} function
434is used.
e5a2291a
GRG
435
436Although it might take some time to get used to the event-oriented
437system upon which wxSocket is built, the benefits are many. See, for
438example, that the server application, while being single-threaded
439(and of course without using fork() or ugly select() loops) can handle
440an arbitrary number of connections.
441
442The client starts up unconnected, so you can use the Connect... option
443to specify the address of the server you are going to connect to (the
444TCP port number is hard-coded as 3000). Once connected, a number of
445tests are possible. Currently, three tests are implemented. They show
446how to use the basic IO calls in \helpref{wxSocketBase}{wxsocketbase},
f5e0b4bc 447such as \helpref{Read}{wxsocketbaseread}, \helpref{Write}{wxsocketbasewrite},
e5a2291a
GRG
448\helpref{ReadMsg}{wxsocketbasereadmsg} and \helpref{WriteMsg}{wxsocketbasewritemsg},
449and how to set up the correct IO flags depending on what you are going to
5adbbc29
GRG
450do. See the comments in the code for more information. Note that because
451both clients and connection objects in the server set up an event handler
452to catch {\bf wxSOCKET\_LOST} events, each one is immediately notified
453if the other end closes the connection.
e5a2291a 454
87b6002d 455There is also a URL test which shows how to use
f6bcfd97 456the \helpref{wxURL}{wxurl} class to fetch data from a given URL.
b4e87ec3 457
5adbbc29 458The sockets sample is work in progress. Some things to do:
e5a2291a 459
ecf527c0 460\begin{itemize}\itemsep=0pt
e5a2291a 461\item More tests for basic socket functionality.
b4e87ec3 462\item More tests for protocol classes (wxProtocol and its descendants).
5adbbc29 463\item Tests for the recently added (and still in alpha stage) datagram sockets.
e5a2291a 464\item New samples which actually do something useful (suggestions accepted).
e5a2291a
GRG
465\end{itemize}
466
4c39aa3a 467
0d9c603d
VS
468\subsection{Sound sample}\label{samplesound}
469
315ebf68 470The {\tt sound} sample shows how to use \helpref{wxSound}{wxsound} for simple
0d9c603d
VS
471audio output (e.g. notifications).
472
473
2286341c
VZ
474\subsection{Statbar sample}\label{samplestatbar}
475
105521d1 476This sample shows how to create and use wxStatusBar. Although most of the
2286341c
VZ
477samples have a statusbar, they usually only create a default one and only
478do it once.
479
480Here you can see how to recreate the statusbar (with possibly different number
481of fields) and how to use it to show icons/bitmaps and/or put arbitrary
482controls into it.
483
4c39aa3a 484
d63f7562
VZ
485\subsection{Tab order sample}\label{sampletaborder}
486
487This sample allows to test keyboard navigation (mostly done using the
488\texttt{\textsc{TAB}} key, hence the sample name) between different controls.
489It shows the use of
490\helpref{wxWindow::MoveBeforeInTabOrder()}{wxwindowmovebeforeintaborder} and
5644933f
VZ
491\helpref{MoveAfterInTabOrder()}{wxwindowmoveafterintaborder} methods to change
492the default order of the windows in the navigation chain and of
493\helpref{wxWindow::Navigate()}{wxwindownavigate} for moving focus along this
494chain.
d63f7562
VZ
495
496
238ddd26
RR
497\subsection{Text sample}\label{sampletext}
498
499This sample demonstrates four features: firstly the use and many variants of
500the \helpref{wxTextCtrl}{wxtextctrl} class (single line, multi line, read only,
501password, ignoring TAB, ignoring ENTER).
502
503Secondly it shows how to intercept a \helpref{wxKeyEvent}{wxkeyevent} in both
d17f05af 504the raw form using the {\tt EVT\_KEY\_UP} and {\tt EVT\_KEY\_DOWN} macros and the
f6bcfd97 505higher level from using the {\tt EVT\_CHAR} macro. All characters will be logged
238ddd26 506in a log window at the bottom of the main window. By pressing some of the function
f6bcfd97 507keys, you can test some actions in the text ctrl as well as get statistics on the
2edb0bde 508text ctrls, which is useful for testing if these statistics actually are correct.
238ddd26 509
f5e0b4bc 510Thirdly, on platforms which support it, the sample will offer to copy text to the
238ddd26
RR
511\helpref{wxClipboard}{wxclipboard} and to paste text from it. The GTK version will
512use the so called PRIMARY SELECTION, which is the pseudo clipboard under X and
b9989817 513best known from pasting text to the XTerm program.
238ddd26
RR
514
515Last not least: some of the text controls have tooltips and the sample also shows
516how tooltips can be centrally disabled and their latency controlled.
517
4c39aa3a 518
c88275cb
RR
519\subsection{Thread sample}\label{samplethread}
520
f70c0443 521This sample demonstrates use of threads in connection with GUI programs.
c88275cb
RR
522There are two fundamentally different ways to use threads in GUI programs and
523either way has to take care of the fact that the GUI library itself usually
524is not multi-threading safe, i.e. that it might crash if two threads try to
525access the GUI class simultaneously. One way to prevent that is have a normal
f5e0b4bc 526GUI program in the main thread and some worker threads which work in the
c88275cb 527background. In order to make communication between the main thread and the
f5e0b4bc 528worker threads possible, wxWidgets offers the \helpref{wxPostEvent}{wxpostevent}
c88275cb
RR
529function and this sample makes use of this function.
530
f5e0b4bc 531The other way to use a so called Mutex (such as those offered in the \helpref{wxMutex}{wxmutex}
c88275cb 532class) that prevent threads from accessing the GUI classes as long as any other
f5e0b4bc 533thread accesses them. For this, wxWidgets has the \helpref{wxMutexGuiEnter}{wxmutexguienter}
c88275cb
RR
534and \helpref{wxMutexGuiLeave}{wxmutexguileave} functions, both of which are
535used and tested in the sample as well.
536
537See also \helpref{Multithreading overview}{wxthreadoverview} and \helpref{wxThread}{wxthread}.
538
4c39aa3a 539
5ef2e633
VZ
540\subsection{Toolbar sample}\label{sampletoolbar}
541
542The toolbar sample shows the \helpref{wxToolBar}{wxtoolbar} class in action.
543
544The following things are demonstrated:
545
ecf527c0 546\begin{itemize}\itemsep=0pt
f5e0b4bc 547\item Creating the toolbar using \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}
5ef2e633
VZ
548and \helpref{wxToolBar::AddControl}{wxtoolbaraddcontrol}: see
549MyApp::InitToolbar in the sample.
5ef2e633 550\item Using {\tt EVT\_UPDATE\_UI} handler for automatically enabling/disabling
f6bcfd97 551toolbar buttons without having to explicitly call EnableTool. This is done
5ef2e633 552in MyFrame::OnUpdateCopyAndCut.
f5e0b4bc 553\item Using \helpref{wxToolBar::DeleteTool}{wxtoolbardeletetool} and
5ef2e633
VZ
554\helpref{wxToolBar::InsertTool}{wxtoolbarinserttool} to dynamically update the
555toolbar.
5ef2e633 556\end{itemize}
963863ad 557
882bf210 558Some buttons in the main toolbar are check buttons, i.e. they stay checked when
87b6002d 559pressed. On the platforms which support it, the sample also adds a combobox
882bf210
VZ
560to the toolbar showing how you can use arbitrary controls and not only buttons
561in it.
562
563If you toggle another toolbar in the sample (using {\tt Ctrl-A}) you will also
564see the radio toolbar buttons in action: the first three buttons form a radio
87b6002d 565group, i.e. checking any of them automatically unchecks the previously
882bf210
VZ
566checked one.
567
4c39aa3a 568
963863ad
VZ
569\subsection{Treectrl sample}\label{sampletreectrl}
570
f70c0443 571This sample demonstrates using the \helpref{wxTreeCtrl}{wxtreectrl} class. Here
963863ad
VZ
572you may see how to process various notification messages sent by this control
573and also when they occur (by looking at the messages in the text control in
574the bottom part of the frame).
575
576Adding, inserting and deleting items and branches from the tree as well as
577sorting (in default alphabetical order as well as in custom one) is
578demonstrated here as well - try the corresponding menu entries.
ecf527c0 579
4c39aa3a 580
b26f2425
WS
581\subsection{Widgets sample}\label{samplewidgets}
582
583The widgets sample is the main presentation program for most simple and advanced
584native controls and complex generic widgets provided by wxWidgets.
585The sample tests their basic functionality, events, placement, modification
586in terms of colour and font as well as the possibility to change
587the controls programmatically, such as adding an item to a list box etc.
588All widgets are categorized for easy browsing.
589
f6bcfd97
BP
590\subsection{Wizard sample}\label{samplewizard}
591
f5e0b4bc 592This sample shows the so-called wizard dialog (implemented using
f6bcfd97
BP
593\helpref{wxWizard}{wxwizard} and related classes). It shows almost all
594features supported:
595
596\begin{itemize}\itemsep=0pt
597\item Using bitmaps with the wizard and changing them depending on the page
598shown (notice that wxValidationPage in the sample has a different image from
599the other ones)
f5e0b4bc 600\item Using \helpref{TransferDataFromWindow}{wxwindowtransferdatafromwindow}
f6bcfd97
BP
601to verify that the data entered is correct before passing to the next page
602(done in wxValidationPage which forces the user to check a checkbox before
603continuing).
604\item Using more elaborated techniques to allow returning to the previous
605page, but not continuing to the next one or vice versa (in wxRadioboxPage)
87b6002d 606\item This (wxRadioboxPage) page also shows how the page may process the {\tt
f6bcfd97
BP
607Cancel} button itself instead of relying on the wizard parent to do it.
608\item Normally, the order of the pages in the wizard is known at compile-time,
609but sometimes it depends on the user choices: wxCheckboxPage shows how to
f5e0b4bc 610dynamically decide which page to display next (see also
f6bcfd97
BP
611\helpref{wxWizardPage}{wxwizardpage})
612\end{itemize}
62a268cc 613