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