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