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