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