]>
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 | |
fabe121c WS |
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 | ||
c9d0bc8a VS |
63 | \subsection{Art provider sample}\label{sampleartprovider} |
64 | ||
65 | The {\tt artprov} sample shows how you can customize the look of standard | |
fc2171bd | 66 | wxWidgets dialogs by replacing default bitmaps/icons with your own versions. |
f4fcc291 | 67 | It also shows how you can use wxArtProvider to |
c9d0bc8a VS |
68 | get stock bitmaps for use in your application. |
69 | ||
4c39aa3a | 70 | |
4f6aed9c VZ |
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 | ||
4c39aa3a | 77 | |
cddfbd9f RR |
78 | \subsection{Config sample}\label{sampleconfig} |
79 | ||
80 | This sample demonstrates the \helpref{wxConfig}{wxconfigbase} classes in a platform | |
2edb0bde | 81 | independent way, i.e. it uses text based files to store a given configuration under |
cddfbd9f RR |
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 | ||
4c39aa3a | 87 | |
32ab332f RR |
88 | \subsection{Controls sample}\label{samplecontrols} |
89 | ||
90 | The controls sample is the main test program for most simple controls used in | |
fc2171bd | 91 | wxWidgets. The sample tests their basic functionality, events, placement, |
32ab332f | 92 | modification in terms of colour and font as well as the possibility to change |
87b6002d | 93 | the controls programmatically, such as adding an item to a list box etc. Apart |
32ab332f | 94 | from that, the sample uses a \helpref{wxNotebook}{wxnotebook} and tests most |
f5e0b4bc | 95 | features of this special control (using bitmap in the tabs, using |
32ab332f | 96 | \helpref{wxSizers}{wxsizer} and \helpref{constraints}{wxlayoutconstraints} within |
f6bcfd97 | 97 | notebook pages, advancing pages programmatically and vetoing a page change |
32ab332f RR |
98 | by intercepting the \helpref{wxNotebookEvent}{wxnotebookevent}. |
99 | ||
100 | The various controls tested are listed here: | |
ecf527c0 | 101 | |
32ab332f RR |
102 | \begin{twocollist}\itemsep=0pt |
103 | \twocolitem{\helpref{wxButton}{wxbutton}}{Push button control, displaying text} | |
104 | \twocolitem{\helpref{wxBitmapButton}{wxbitmapbutton}}{Push button control, displaying a bitmap} | |
105 | \twocolitem{\helpref{wxCheckBox}{wxcheckbox}}{Checkbox control} | |
106 | \twocolitem{\helpref{wxChoice}{wxchoice}}{Choice control (a combobox without the editable area)} | |
107 | \twocolitem{\helpref{wxComboBox}{wxcombobox}}{A choice with an editable area} | |
108 | \twocolitem{\helpref{wxGauge}{wxgauge}}{A control to represent a varying quantity, such as time remaining} | |
109 | \twocolitem{\helpref{wxStaticBox}{wxstaticbox}}{A static, or group box for visually grouping related controls} | |
110 | \twocolitem{\helpref{wxListBox}{wxlistbox}}{A list of strings for single or multiple selection} | |
111 | \twocolitem{wxSpinCtrl}{A spin ctrl with a text field and a `up-down' control} | |
112 | \twocolitem{\helpref{wxSpinButton}{wxspinbutton}}{A spin or `up-down' control} | |
113 | \twocolitem{\helpref{wxStaticText}{wxstatictext}}{One or more lines of non-editable text} | |
114 | \twocolitem{\helpref{wxStaticBitmap}{wxstaticbitmap}}{A control to display a bitmap} | |
115 | \twocolitem{\helpref{wxRadioBox}{wxradiobox}}{A group of radio buttons} | |
116 | \twocolitem{\helpref{wxRadioButton}{wxradiobutton}}{A round button to be used with others in a mutually exclusive way} | |
117 | \twocolitem{\helpref{wxSlider}{wxslider}}{A slider that can be dragged by the user} | |
118 | \end{twocollist} | |
119 | ||
4c39aa3a | 120 | |
32ab332f RR |
121 | \subsection{Database sample}\label{sampledb} |
122 | ||
123 | The database sample is a small test program showing how to use the ODBC | |
f5e0b4bc | 124 | classes written by Remstar Intl. Obviously, this sample requires a |
19320af4 | 125 | database with ODBC support to be correctly installed on your system. |
32ab332f | 126 | |
4c39aa3a | 127 | |
df1b5a2a VZ |
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 | |
b26f2425 | 135 | allows to view the information gathered using |
df1b5a2a VZ |
136 | \helpref{wxDebugReportPreview}{wxdebugreportpreview}. |
137 | ||
138 | For the report processing part of the sample to work you should make available | |
b26f2425 | 139 | a Web server accepting form uploads, otherwise |
df1b5a2a VZ |
140 | \helpref{wxDebugReportUpload}{wxdebugreportupload} will report an error. |
141 | ||
142 | ||
cddfbd9f RR |
143 | \subsection{Dialogs sample}\label{sampledialogs} |
144 | ||
fc2171bd | 145 | This sample shows how to use the common dialogs available from wxWidgets. These |
87b6002d | 146 | dialogs are described in detail in the \helpref{Common dialogs overview}{commondialogsoverview}. |
f6bcfd97 | 147 | |
4c39aa3a | 148 | |
f6bcfd97 BP |
149 | \subsection{Dialup sample}\label{sampledialup} |
150 | ||
f5e0b4bc | 151 | This sample shows the \helpref{wxDialUpManager}{wxdialupmanager} |
f70c0443 | 152 | class. In the status bar, it displays the information gathered through its |
2edb0bde | 153 | interface: in particular, the current connection status (online or offline) and |
f6bcfd97 | 154 | whether the connection is permanent (in which case a string `LAN' appears in |
87b6002d | 155 | the third status bar field - but note that you may be on a LAN not |
f6bcfd97 BP |
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. | |
cddfbd9f | 161 | |
4c39aa3a | 162 | |
b9989817 VZ |
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, | |
f5e0b4bc WS |
170 | there are two listboxes which show the standard derivations of |
171 | \helpref{wxDropTarget}{wxdroptarget}: | |
172 | \helpref{wxTextDropTarget}{wxtextdroptarget} and | |
b9989817 VZ |
173 | \helpref{wxFileDropTarget}{wxfiledroptarget}. |
174 | ||
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 | |
87b6002d | 182 | clipboard (or, in the case of the Windows version, also a metafile) - it will be |
b9989817 VZ |
183 | shown in a new frame. |
184 | ||
185 | So far, everything we mentioned was implemented with minimal amount of code | |
fc2171bd | 186 | using standard wxWidgets classes. The more advanced features are demonstrated |
b9989817 VZ |
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 | ||
f5e0b4bc | 198 | Take a look at DnDShapeDataObject class to see how you may use |
b9989817 VZ |
199 | \helpref{wxDataObject}{wxdataobject} to achieve this. |
200 | ||
4c39aa3a | 201 | |
6164f93c VZ |
202 | \subsection{Event sample}\label{sampleevent} |
203 | ||
fc2171bd | 204 | The event sample demonstrates various features of the wxWidgets events. It |
6164f93c | 205 | shows using dynamic events and connecting/disconnecting the event handlers |
f5e0b4bc | 206 | during run time and also using |
6164f93c VZ |
207 | \helpref{PushEventHandler()}{wxwindowpusheventhandler} and |
208 | \helpref{PopEventHandler()}{wxwindowpopeventhandler}. | |
209 | ||
4c39aa3a VZ |
210 | |
211 | \subsection{Except(ions) sample}\label{sampleexcept} | |
212 | ||
fc2171bd | 213 | This very simple sample shows how to use C++ exceptions in wxWidgets programs, |
4c39aa3a VZ |
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$ | |
87b6002d | 219 | and compile your code with C++ exceptions support to be able to build this |
4c39aa3a VZ |
220 | sample. |
221 | ||
222 | ||
0d7ea902 VZ |
223 | \subsection{Exec sample}\label{sampleexec} |
224 | ||
f5e0b4bc | 225 | The exec sample demonstrates the \helpref{wxExecute}{wxexecute} and |
0d7ea902 VZ |
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 | ||
f6bcfd97 | 230 | It also shows how to capture the output of the child process in both |
f5e0b4bc WS |
231 | synchronous and asynchronous cases and how to kill the processes with |
232 | \helpref{wxProcess::Kill}{wxprocesskill} and test for their existence with | |
50567b69 | 233 | \helpref{wxProcess::Exists}{wxprocessexists}. |
f6bcfd97 | 234 | |
4c39aa3a | 235 | |
775a998e VZ |
236 | \subsection{Font sample}\label{samplefont} |
237 | ||
f5e0b4bc WS |
238 | The font sample demonstrates \helpref{wxFont}{wxfont}, |
239 | \helpref{wxFontEnumerator}{wxfontenumerator} and | |
775a998e | 240 | \helpref{wxFontMapper}{wxfontmapper} classes. It allows you to see the fonts |
fc2171bd | 241 | available (to wxWidgets) on the computer and shows all characters of the |
775a998e VZ |
242 | chosen font as well. |
243 | ||
4c39aa3a | 244 | |
963863ad VZ |
245 | \subsection{Grid sample}\label{samplegrid} |
246 | ||
247 | TODO. | |
248 | ||
4c39aa3a | 249 | |
61eff74f VS |
250 | \subsection{HTML samples}\label{samplehtml} |
251 | ||
252 | Eight HTML samples (you can find them in directory {\tt samples/html}) | |
87b6002d | 253 | cover all features of the HTML sub-library. |
61eff74f | 254 | |
f5e0b4bc | 255 | {\bf Test} demonstrates how to create \helpref{wxHtmlWindow}{wxhtmlwindow} |
87b6002d | 256 | and also shows most supported HTML tags. |
61eff74f | 257 | |
87b6002d | 258 | {\bf Widget} shows how you can embed ordinary controls or windows within an |
61eff74f VS |
259 | HTML page. It also nicely explains how to write new tag handlers and extend |
260 | the library to work with unsupported tags. | |
261 | ||
87b6002d | 262 | {\bf About} may give you an idea how to write good-looking About boxes. |
61eff74f VS |
263 | |
264 | {\bf Zip} demonstrates use of virtual file systems in wxHTML. The zip archives | |
f5e0b4bc | 265 | handler (ships with wxWidgets) allows you to access HTML pages stored |
87b6002d | 266 | in a compressed archive as if they were ordinary files. |
61eff74f | 267 | |
f6bcfd97 | 268 | {\bf Virtual} is yet another virtual file systems demo. This one generates pages at run-time. |
61eff74f VS |
269 | You may find it useful if you need to display some reports in your application. |
270 | ||
f5e0b4bc WS |
271 | {\bf Printing} explains use of \helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting} |
272 | class which serves as as-simple-as-possible interface for printing HTML | |
61eff74f VS |
273 | documents without much work. In fact, only few function calls are sufficient. |
274 | ||
f5e0b4bc WS |
275 | {\bf Help} and {\bf Helpview} are variations on displaying HTML help |
276 | (compatible with MS HTML Help Workshop). {\it Help} shows how to embed | |
61eff74f | 277 | \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} in your application |
87b6002d | 278 | while {\it Helpview} is a simple tool that only pops up the help window and |
61eff74f VS |
279 | displays help books given at command line. |
280 | ||
4c39aa3a | 281 | |
963863ad VZ |
282 | \subsection{Image sample}\label{sampleimage} |
283 | ||
f70c0443 | 284 | The image sample demonstrates use of the \helpref{wxImage}{wximage} class |
963863ad | 285 | and shows how to download images in a variety of formats, currently PNG, GIF, |
87b6002d | 286 | TIFF, JPEG, BMP, PNM and PCX. The top of the sample shows two rectangles, one |
f5e0b4bc | 287 | of which is drawn directly in the window, the other one is drawn into a |
963863ad VZ |
288 | \helpref{wxBitmap}{wxbitmap}, converted to a wxImage, saved as a PNG image |
289 | and then reloaded from the PNG file again so that conversions between wxImage | |
87b6002d | 290 | and wxBitmap as well as loading and saving PNG files are tested. |
963863ad | 291 | |
87b6002d | 292 | At the bottom of the main frame there is a test for using a monochrome bitmap by |
963863ad | 293 | drawing into a \helpref{wxMemoryDC}{wxmemorydc}. The bitmap is then drawn |
f5e0b4bc WS |
294 | specifying the foreground and background colours with |
295 | \helpref{wxDC::SetTextForeground}{wxdcsettextforeground} and | |
963863ad VZ |
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 | ||
39d66339 VZ |
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 | ||
4c39aa3a | 303 | |
fb848f58 VZ |
304 | \subsection{Internat(ionalization) sample}\label{sampleinternat} |
305 | ||
fc2171bd | 306 | The not very clearly named internat sample demonstrates the wxWidgets |
87b6002d | 307 | internationalization (i18n for short from now on) features. To be more |
fb848f58 | 308 | precise, it only shows localization support, i.e. support for translating the |
f70c0443 | 309 | program messages into another language while true i18n would also involve |
fb848f58 VZ |
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 | |
a81705a3 | 313 | its directory. Please see also \helpref{i18n overview}{internationalization}. |
fb848f58 | 314 | |
4c39aa3a | 315 | |
238ddd26 RR |
316 | \subsection{Layout sample}\label{samplelayout} |
317 | ||
318 | The layout sample demonstrates the two different layout systems offered | |
fc2171bd | 319 | by wxWidgets. When starting the program, you will see a frame with some |
238ddd26 RR |
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 | |
f5e0b4bc WS |
322 | is determined using the \helpref{wxLayoutConstraints}{wxlayoutconstraints} |
323 | class. See also the \helpref{overview}{constraintsoverview} and the | |
324 | \helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint} | |
238ddd26 RR |
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 | |
f5e0b4bc | 329 | showing how to use sizers in connection with a \helpref{wxNotebook}{wxnotebook} |
c6eb7785 | 330 | class. See also \helpref{wxSizer}{wxsizer}. |
238ddd26 | 331 | |
4c39aa3a | 332 | |
963863ad | 333 | \subsection{Listctrl sample}\label{samplelistctrl} |
32ab332f | 334 | |
87b6002d | 335 | This sample shows the \helpref{wxListCtrl}{wxlistctrl} control. Different modes |
963863ad VZ |
336 | supported by the control (list, icons, small icons, report) may be chosen from |
337 | the menu. | |
32ab332f | 338 | |
963863ad | 339 | The sample also provides some timings for adding/deleting/sorting a lot of |
3e6c2880 VZ |
340 | (several thousands) items into the control. |
341 | ||
342 | ||
db55c58f RN |
343 | \subsection{Mediaplayer sample}\label{samplemediaplayer} |
344 | ||
345 | This sample demonstrates how to use all the features of | |
61c083e7 | 346 | \helpref{wxMediaCtrl}{wxmediactrl} and play various types of sound, video, |
db55c58f RN |
347 | and other files. |
348 | ||
349 | ||
350 | It replaces the old dynamic sample. | |
4c39aa3a | 351 | |
c16b8e18 VZ |
352 | \subsection{Notebook sample}\label{samplenotebook} |
353 | ||
b742a43b | 354 | This samples shows \helpref{wxBookCtrl}{wxbookctrloverview} family of controls. |
566a06e8 | 355 | Although initially it was written to demonstrate \helpref{wxNotebook}{wxnotebook} |
eca15c0d VZ |
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. | |
c16b8e18 VZ |
359 | |
360 | ||
4c39aa3a | 361 | |
3e6c2880 VZ |
362 | \subsection{Render sample}\label{samplerender} |
363 | ||
f5e0b4bc | 364 | This sample shows how to replace the default wxWidgets |
3e6c2880 VZ |
365 | \helpref{renderer}{wxrenderernative} and also how to write a shared library |
366 | (DLL) implementing a renderer and load and unload it during the run-time. | |
367 | ||
32ab332f | 368 | |
4c39aa3a | 369 | |
b9989817 VZ |
370 | \subsection{Scroll subwindow sample}\label{samplescrollsub} |
371 | ||
f5e0b4bc WS |
372 | This sample demonstrates use of the \helpref{wxScrolledWindow}{wxscrolledwindow} |
373 | class including placing subwindows into it and drawing simple graphics. It uses the | |
b9989817 VZ |
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 | ||
fc2171bd | 377 | Additionally, this samples demonstrates how to optimize drawing operations in wxWidgets, |
f5e0b4bc WS |
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 | |
b9989817 VZ |
380 | flicker on screen. |
381 | ||
4c39aa3a | 382 | |
e5a2291a GRG |
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 | |
f5e0b4bc | 387 | applications in this sample: a server, which is implemented using a |
5adbbc29 GRG |
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 | |
87b6002d | 393 | ({\bf wxSOCKET\_CONNECTION} events), and sits there, waiting for clients |
f70c0443 | 394 | ({\it listening}, in socket parlance). For each accepted connection, |
5adbbc29 GRG |
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 | |
f5e0b4bc | 398 | of {\bf wxSOCKET\_INPUT} (incoming data) or {\bf wxSOCKET\_LOST} |
5adbbc29 GRG |
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 | |
f6bcfd97 BP |
401 | event is addressed to, the \helpref{GetSocket}{wxsocketeventgetsocket} function |
402 | is used. | |
e5a2291a GRG |
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}, | |
f5e0b4bc | 415 | such as \helpref{Read}{wxsocketbaseread}, \helpref{Write}{wxsocketbasewrite}, |
e5a2291a GRG |
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 | |
5adbbc29 GRG |
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. | |
e5a2291a | 422 | |
87b6002d | 423 | There is also a URL test which shows how to use |
f6bcfd97 | 424 | the \helpref{wxURL}{wxurl} class to fetch data from a given URL. |
b4e87ec3 | 425 | |
5adbbc29 | 426 | The sockets sample is work in progress. Some things to do: |
e5a2291a | 427 | |
ecf527c0 | 428 | \begin{itemize}\itemsep=0pt |
e5a2291a | 429 | \item More tests for basic socket functionality. |
b4e87ec3 | 430 | \item More tests for protocol classes (wxProtocol and its descendants). |
5adbbc29 | 431 | \item Tests for the recently added (and still in alpha stage) datagram sockets. |
e5a2291a | 432 | \item New samples which actually do something useful (suggestions accepted). |
e5a2291a GRG |
433 | \end{itemize} |
434 | ||
4c39aa3a | 435 | |
0d9c603d VS |
436 | \subsection{Sound sample}\label{samplesound} |
437 | ||
315ebf68 | 438 | The {\tt sound} sample shows how to use \helpref{wxSound}{wxsound} for simple |
0d9c603d VS |
439 | audio output (e.g. notifications). |
440 | ||
441 | ||
2286341c VZ |
442 | \subsection{Statbar sample}\label{samplestatbar} |
443 | ||
105521d1 | 444 | This sample shows how to create and use wxStatusBar. Although most of the |
2286341c VZ |
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 | ||
4c39aa3a | 452 | |
d63f7562 VZ |
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 | |
5644933f VZ |
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. | |
d63f7562 VZ |
463 | |
464 | ||
238ddd26 RR |
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 | |
d17f05af | 472 | the raw form using the {\tt EVT\_KEY\_UP} and {\tt EVT\_KEY\_DOWN} macros and the |
f6bcfd97 | 473 | higher level from using the {\tt EVT\_CHAR} macro. All characters will be logged |
238ddd26 | 474 | in a log window at the bottom of the main window. By pressing some of the function |
f6bcfd97 | 475 | keys, you can test some actions in the text ctrl as well as get statistics on the |
2edb0bde | 476 | text ctrls, which is useful for testing if these statistics actually are correct. |
238ddd26 | 477 | |
f5e0b4bc | 478 | Thirdly, on platforms which support it, the sample will offer to copy text to the |
238ddd26 RR |
479 | \helpref{wxClipboard}{wxclipboard} and to paste text from it. The GTK version will |
480 | use the so called PRIMARY SELECTION, which is the pseudo clipboard under X and | |
b9989817 | 481 | best known from pasting text to the XTerm program. |
238ddd26 RR |
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 | ||
4c39aa3a | 486 | |
c88275cb RR |
487 | \subsection{Thread sample}\label{samplethread} |
488 | ||
f70c0443 | 489 | This sample demonstrates use of threads in connection with GUI programs. |
c88275cb RR |
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 | |
f5e0b4bc | 494 | GUI program in the main thread and some worker threads which work in the |
c88275cb | 495 | background. In order to make communication between the main thread and the |
f5e0b4bc | 496 | worker threads possible, wxWidgets offers the \helpref{wxPostEvent}{wxpostevent} |
c88275cb RR |
497 | function and this sample makes use of this function. |
498 | ||
f5e0b4bc | 499 | The other way to use a so called Mutex (such as those offered in the \helpref{wxMutex}{wxmutex} |
c88275cb | 500 | class) that prevent threads from accessing the GUI classes as long as any other |
f5e0b4bc | 501 | thread accesses them. For this, wxWidgets has the \helpref{wxMutexGuiEnter}{wxmutexguienter} |
c88275cb RR |
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 | ||
4c39aa3a | 507 | |
5ef2e633 VZ |
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 | ||
ecf527c0 | 514 | \begin{itemize}\itemsep=0pt |
f5e0b4bc | 515 | \item Creating the toolbar using \helpref{wxToolBar::AddTool}{wxtoolbaraddtool} |
5ef2e633 VZ |
516 | and \helpref{wxToolBar::AddControl}{wxtoolbaraddcontrol}: see |
517 | MyApp::InitToolbar in the sample. | |
5ef2e633 | 518 | \item Using {\tt EVT\_UPDATE\_UI} handler for automatically enabling/disabling |
f6bcfd97 | 519 | toolbar buttons without having to explicitly call EnableTool. This is done |
5ef2e633 | 520 | in MyFrame::OnUpdateCopyAndCut. |
f5e0b4bc | 521 | \item Using \helpref{wxToolBar::DeleteTool}{wxtoolbardeletetool} and |
5ef2e633 VZ |
522 | \helpref{wxToolBar::InsertTool}{wxtoolbarinserttool} to dynamically update the |
523 | toolbar. | |
5ef2e633 | 524 | \end{itemize} |
963863ad | 525 | |
882bf210 | 526 | Some buttons in the main toolbar are check buttons, i.e. they stay checked when |
87b6002d | 527 | pressed. On the platforms which support it, the sample also adds a combobox |
882bf210 VZ |
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 | |
87b6002d | 533 | group, i.e. checking any of them automatically unchecks the previously |
882bf210 VZ |
534 | checked one. |
535 | ||
4c39aa3a | 536 | |
963863ad VZ |
537 | \subsection{Treectrl sample}\label{sampletreectrl} |
538 | ||
f70c0443 | 539 | This sample demonstrates using the \helpref{wxTreeCtrl}{wxtreectrl} class. Here |
963863ad VZ |
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. | |
ecf527c0 | 547 | |
4c39aa3a | 548 | |
b26f2425 WS |
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 | ||
f6bcfd97 BP |
558 | \subsection{Wizard sample}\label{samplewizard} |
559 | ||
f5e0b4bc | 560 | This sample shows the so-called wizard dialog (implemented using |
f6bcfd97 BP |
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) | |
f5e0b4bc | 568 | \item Using \helpref{TransferDataFromWindow}{wxwindowtransferdatafromwindow} |
f6bcfd97 BP |
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) | |
87b6002d | 574 | \item This (wxRadioboxPage) page also shows how the page may process the {\tt |
f6bcfd97 BP |
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 | |
f5e0b4bc | 578 | dynamically decide which page to display next (see also |
f6bcfd97 BP |
579 | \helpref{wxWizardPage}{wxwizardpage}) |
580 | \end{itemize} | |
62a268cc | 581 |