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