%% Created: 02.11.99
%% RCS-ID: $Id$
%% Copyright: (c) wxWidgets team
-%% License: wxWidgets license
+%% License: wxWindows license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% NB: please keep the subsections in alphabetic order!
features of wxWidgets are they supposed to test.
There are currently more than 50 different samples as part of wxWidgets and
-this list is not complete. You should start your tour of wxWidgets with the
+this list is not complete. You should start your tour of wxWidgets with the
\helpref{minimal sample}{sampleminimal} which is the wxWidgets version of
"Hello, world!". It shows the basic structure of wxWidgets program and is the
most commented sample of all - looking at its source code is recommended.
-The next most useful sample is probably the \helpref{controls}{samplecontrols}
-one which shows many of wxWidgets standard controls, such as buttons,
-listboxes, checkboxes, comboboxes etc.
+The next most useful samples are probably \helpref{widgets}{samplewidgets}
+and \helpref{controls}{samplecontrols} which show many of wxWidgets native and
+generic controls, such as buttons, listboxes, checkboxes, comboboxes etc.
Other, more complicated controls, have their own samples. In this category you
may find the following samples showing the corresponding controls:
a good starting point for learning how to use wxWidgets.
+\subsection{Animate sample}\label{sampleanimate}
+
+The {\tt animate} sample shows how you can use \helpref{wxAnimationCtrl}{wxanimationctrl}
+control and shows concept of a platform-dependent animation encapsulated
+in \helpref{wxAnimation}{wxanimation}.
+
+
\subsection{Art provider sample}\label{sampleartprovider}
The {\tt artprov} sample shows how you can customize the look of standard
menu) and also how to process the notifications from it.
-\subsection{Checklist sample}\label{samplechecklist}
-
-This sample demonstrates the use of the \helpref{wxCheckListBox}{wxchecklistbox}
-class intercepting check, select and double click events. It also tests the
-use of various methods modifying the control, such as by deleting items
-from it or inserting new ones (these functions are actually implemented in
-the parent class \helpref{wxListBox}{wxlistbox} so the sample tests that class
-as well). The layout of the dialog is created using a \helpref{wxBoxSizer}{wxboxsizer}
-demonstrating a simple dynamic layout.
-
-
\subsection{Config sample}\label{sampleconfig}
This sample demonstrates the \helpref{wxConfig}{wxconfigbase} classes in a platform
modification in terms of colour and font as well as the possibility to change
the controls programmatically, such as adding an item to a list box etc. Apart
from that, the sample uses a \helpref{wxNotebook}{wxnotebook} and tests most
-features of this special control (using bitmap in the tabs, using
+features of this special control (using bitmap in the tabs, using
\helpref{wxSizers}{wxsizer} and \helpref{constraints}{wxlayoutconstraints} within
notebook pages, advancing pages programmatically and vetoing a page change
by intercepting the \helpref{wxNotebookEvent}{wxnotebookevent}.
\subsection{Database sample}\label{sampledb}
The database sample is a small test program showing how to use the ODBC
-classes written by Remstar Intl. Obviously, this sample requires a
+classes written by Remstar Intl. Obviously, this sample requires a
database with ODBC support to be correctly installed on your system.
+\subsection{DebugRpt sample}\label{sampledebugrpt}
+
+This sample shows how to use \helpref{wxDebugReport}{wxdebugreport} class to
+generate a debug report in case of a program crash or otherwise. On start up,
+it proposes to either crash itself (by dereferencing a NULL pointer) or
+generate debug report without doing it. Next it initializes the debug report
+with standard information adding a custom file to it (just a timestamp) and
+allows to view the information gathered using
+\helpref{wxDebugReportPreview}{wxdebugreportpreview}.
+
+For the report processing part of the sample to work you should make available
+a Web server accepting form uploads, otherwise
+\helpref{wxDebugReportUpload}{wxdebugreportupload} will report an error.
+
+
\subsection{Dialogs sample}\label{sampledialogs}
This sample shows how to use the common dialogs available from wxWidgets. These
\subsection{Dialup sample}\label{sampledialup}
-This sample shows the \helpref{wxDialUpManager}{wxdialupmanager}
-class. It displays in the status bar the information gathered through its
+This sample shows the \helpref{wxDialUpManager}{wxdialupmanager}
+class. In the status bar, it displays the information gathered through its
interface: in particular, the current connection status (online or offline) and
whether the connection is permanent (in which case a string `LAN' appears in
the third status bar field - but note that you may be on a LAN not
drag and drop operations in a real-life program.
When you run the sample, its screen is split in several parts. On the top,
-there are two listboxes which show the standard derivations of
-\helpref{wxDropTarget}{wxdroptarget}:
-\helpref{wxTextDropTarget}{wxtextdroptarget} and
+there are two listboxes which show the standard derivations of
+\helpref{wxDropTarget}{wxdroptarget}:
+\helpref{wxTextDropTarget}{wxtextdroptarget} and
\helpref{wxFileDropTarget}{wxfiledroptarget}.
The middle of the sample window is taken by the log window which shows what is
(and, under Windows, also as metafiles which are supported by most of Windows
programs as well - try Write/Wordpad, for example).
-Take a look at DnDShapeDataObject class to see how you may use
+Take a look at DnDShapeDataObject class to see how you may use
\helpref{wxDataObject}{wxdataobject} to achieve this.
-\subsection{Dynamic sample}\label{sampledynamic}
-
-This sample is a very small sample that demonstrates the use of the
-\helpref{wxEvtHandler::Connect}{wxevthandlerconnect} method. This method
-should be used whenever it is not known at compile time which control
-will receive which event or which controls are actually going to be in
-a dialog or frame. This is most typically the case for any scripting
-language that would work as a wrapper for wxWidgets or programs where
-forms or similar datagrams can be created by the users.
-
-See also the \helpref{event sample}{sampleevent}
-
-
\subsection{Event sample}\label{sampleevent}
The event sample demonstrates various features of the wxWidgets events. It
shows using dynamic events and connecting/disconnecting the event handlers
-during the run time and also using
+during run time and also using
\helpref{PushEventHandler()}{wxwindowpusheventhandler} and
\helpref{PopEventHandler()}{wxwindowpopeventhandler}.
-It replaces the old dynamic sample.
-
\subsection{Except(ions) sample}\label{sampleexcept}
\subsection{Exec sample}\label{sampleexec}
-The exec sample demonstrates the \helpref{wxExecute}{wxexecute} and
+The exec sample demonstrates the \helpref{wxExecute}{wxexecute} and
\helpref{wxShell}{wxshell} functions. Both of them are used to execute the
external programs and the sample shows how to do this synchronously (waiting
until the program terminates) or asynchronously (notification will come later).
It also shows how to capture the output of the child process in both
-synchronous and asynchronous cases and how to kill the processes with
-\helpref{wxProcess::Kill}{wxprocesskill} and test for their existence with
+synchronous and asynchronous cases and how to kill the processes with
+\helpref{wxProcess::Kill}{wxprocesskill} and test for their existence with
\helpref{wxProcess::Exists}{wxprocessexists}.
\subsection{Font sample}\label{samplefont}
-The font sample demonstrates \helpref{wxFont}{wxfont},
-\helpref{wxFontEnumerator}{wxfontenumerator} and
+The font sample demonstrates \helpref{wxFont}{wxfont},
+\helpref{wxFontEnumerator}{wxfontenumerator} and
\helpref{wxFontMapper}{wxfontmapper} classes. It allows you to see the fonts
available (to wxWidgets) on the computer and shows all characters of the
chosen font as well.
Eight HTML samples (you can find them in directory {\tt samples/html})
cover all features of the HTML sub-library.
-{\bf Test} demonstrates how to create \helpref{wxHtmlWindow}{wxhtmlwindow}
+{\bf Test} demonstrates how to create \helpref{wxHtmlWindow}{wxhtmlwindow}
and also shows most supported HTML tags.
{\bf Widget} shows how you can embed ordinary controls or windows within an
{\bf About} may give you an idea how to write good-looking About boxes.
{\bf Zip} demonstrates use of virtual file systems in wxHTML. The zip archives
-handler (ships with wxWidgets) allows you to access HTML pages stored
+handler (ships with wxWidgets) allows you to access HTML pages stored
in a compressed archive as if they were ordinary files.
{\bf Virtual} is yet another virtual file systems demo. This one generates pages at run-time.
You may find it useful if you need to display some reports in your application.
-{\bf Printing} explains use of \helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting}
-class which serves as as-simple-as-possible interface for printing HTML
+{\bf Printing} explains use of \helpref{wxHtmlEasyPrinting}{wxhtmleasyprinting}
+class which serves as as-simple-as-possible interface for printing HTML
documents without much work. In fact, only few function calls are sufficient.
-{\bf Help} and {\bf Helpview} are variations on displaying HTML help
-(compatible with MS HTML Help Workshop). {\it Help} shows how to embed
+{\bf Help} and {\bf Helpview} are variations on displaying HTML help
+(compatible with MS HTML Help Workshop). {\it Help} shows how to embed
\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} in your application
while {\it Helpview} is a simple tool that only pops up the help window and
displays help books given at command line.
\subsection{Image sample}\label{sampleimage}
-The image sample demonstrates the use of the \helpref{wxImage}{wximage} class
+The image sample demonstrates use of the \helpref{wxImage}{wximage} class
and shows how to download images in a variety of formats, currently PNG, GIF,
TIFF, JPEG, BMP, PNM and PCX. The top of the sample shows two rectangles, one
-of which is drawn directly in the window, the other one is drawn into a
+of which is drawn directly in the window, the other one is drawn into a
\helpref{wxBitmap}{wxbitmap}, converted to a wxImage, saved as a PNG image
and then reloaded from the PNG file again so that conversions between wxImage
and wxBitmap as well as loading and saving PNG files are tested.
At the bottom of the main frame there is a test for using a monochrome bitmap by
drawing into a \helpref{wxMemoryDC}{wxmemorydc}. The bitmap is then drawn
-specifying the foreground and background colours with
-\helpref{wxDC::SetTextForeground}{wxdcsettextforeground} and
+specifying the foreground and background colours with
+\helpref{wxDC::SetTextForeground}{wxdcsettextforeground} and
\helpref{wxDC::SetTextBackground}{wxdcsettextbackground} (on the left). The
bitmap is then converted to a wxImage and the foreground colour (black) is
replaced with red using \helpref{wxImage::Replace}{wximagereplace}.
+This sample also contains the code for testing the image rotation and resizing
+and using raw bitmap access, see the corresponding menu commands.
+
\subsection{Internat(ionalization) sample}\label{sampleinternat}
The not very clearly named internat sample demonstrates the wxWidgets
internationalization (i18n for short from now on) features. To be more
precise, it only shows localization support, i.e. support for translating the
-program messages in another language while true i18n would also involve
+program messages into another language while true i18n would also involve
changing the other aspects of the programs behaviour.
More information about this sample can be found in the {\tt readme.txt} file in
by wxWidgets. When starting the program, you will see a frame with some
controls and some graphics. The controls will change their size whenever
you resize the entire frame and the exact behaviour of the size changes
-is determined using the \helpref{wxLayoutConstraints}{wxlayoutconstraints}
-class. See also the \helpref{overview}{constraintsoverview} and the
-\helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}
+is determined using the \helpref{wxLayoutConstraints}{wxlayoutconstraints}
+class. See also the \helpref{overview}{constraintsoverview} and the
+\helpref{wxIndividualLayoutConstraint}{wxindividuallayoutconstraint}
class for further information.
The menu in this sample offers two more tests, one showing how to use
a \helpref{wxBoxSizer}{wxboxsizer} in a simple dialog and the other one
-showing how to use sizers in connection with a \helpref{wxNotebook}{wxnotebook}
+showing how to use sizers in connection with a \helpref{wxNotebook}{wxnotebook}
class. See also \helpref{wxSizer}{wxsizer}.
(several thousands) items into the control.
+\subsection{Mediaplayer sample}\label{samplemediaplayer}
+
+This sample demonstrates how to use all the features of
+\helpref{wxMediaCtrl}{wxmediactrl} and play various types of sound, video,
+and other files.
+
+
+It replaces the old dynamic sample.
\subsection{Notebook sample}\label{samplenotebook}
-This samples shows two controls at once: although initially it was written to
-demonstrate \helpref{wxNotebook}{wxnotebook} only, it can now be also used
-to see \helpref{wxListbook}{wxlistbook} in action. To switch between the two
-controls you need to manually change \texttt{TEST\_LISTBOOK} definition in the
-file \texttt{notebook.h} and rebuild the sample.
+This samples shows \helpref{wxBookCtrl}{wxbookctrloverview} family of controls.
+Although initially it was written to demonstrate \helpref{wxNotebook}{wxnotebook}
+only, it can now be also used to see \helpref{wxListbook}{wxlistbook},
+\helpref{wxChoicebook}{wxchoicebook} and \helpref{wxTreebook}{wxtreebook} in action.
+Test each of the controls, their orientation, images and pages using commands through menu.
\subsection{Render sample}\label{samplerender}
-This sample shows how to replace the default wxWidgets
+This sample shows how to replace the default wxWidgets
\helpref{renderer}{wxrenderernative} and also how to write a shared library
(DLL) implementing a renderer and load and unload it during the run-time.
-\subsection{Rotate sample}\label{samplerotate}
-
-This is a simple example which demonstrates how to rotate an image with
-the \helpref{wxImage::Rotate}{wximagerotate} method. The rotation can
-be done without interpolation (left mouse button) which will be faster,
-or with interpolation (right mouse button) which is slower but gives
-better results.
-
-
\subsection{Scroll subwindow sample}\label{samplescrollsub}
-This sample demonstrates the use of the \helpref{wxScrolledWindow}{wxscrolledwindow}
-class including placing subwindows into it and drawing simple graphics. It uses the
+This sample demonstrates use of the \helpref{wxScrolledWindow}{wxscrolledwindow}
+class including placing subwindows into it and drawing simple graphics. It uses the
\helpref{SetTargetWindow}{wxscrolledwindowsettargetwindow} method and thus the effect
of scrolling does not show in the scrolled window itself, but in one of its subwindows.
Additionally, this samples demonstrates how to optimize drawing operations in wxWidgets,
-in particular using the \helpref{wxWindow::IsExposed}{wxwindowisexposed} method with
-the aim to prevent unnecessary drawing in the window and thus reducing or removing
+in particular using the \helpref{wxWindow::IsExposed}{wxwindowisexposed} method with
+the aim to prevent unnecessary drawing in the window and thus reducing or removing
flicker on screen.
The sockets sample demonstrates how to use the communication facilities
provided by \helpref{wxSocket}{wxsocketbase}. There are two different
-applications in this sample: a server, which is implemented using a
+applications in this sample: a server, which is implemented using a
\helpref{wxSocketServer}{wxsocketserver} object, and a client, which
is implemented as a \helpref{wxSocketClient}{wxsocketclient}.
The server binds to the local address, using TCP port number 3000,
sets up an event handler to be notified of incoming connection requests
({\bf wxSOCKET\_CONNECTION} events), and sits there, waiting for clients
-({\it listening} in the socket parlance). For each accepted connection,
+({\it listening}, in socket parlance). For each accepted connection,
a new \helpref{wxSocketBase}{wxsocketbase} object is created. These
socket objects are independent from the server that created them, so
they set up their own event handler, and then request to be notified
-of {\bf wxSOCKET\_INPUT} (incoming data) or {\bf wxSOCKET\_LOST}
+of {\bf wxSOCKET\_INPUT} (incoming data) or {\bf wxSOCKET\_LOST}
(connection closed at the remote end) events. In the sample, the event
handler is the same for all connections; to find out which socket the
event is addressed to, the \helpref{GetSocket}{wxsocketeventgetsocket} function
TCP port number is hard-coded as 3000). Once connected, a number of
tests are possible. Currently, three tests are implemented. They show
how to use the basic IO calls in \helpref{wxSocketBase}{wxsocketbase},
-such as \helpref{Read}{wxsocketbaseread}, \helpref{Write}{wxsocketbasewrite},
+such as \helpref{Read}{wxsocketbaseread}, \helpref{Write}{wxsocketbasewrite},
\helpref{ReadMsg}{wxsocketbasereadmsg} and \helpref{WriteMsg}{wxsocketbasewritemsg},
and how to set up the correct IO flags depending on what you are going to
do. See the comments in the code for more information. Note that because
controls into it.
+\subsection{Tab order sample}\label{sampletaborder}
+
+This sample allows to test keyboard navigation (mostly done using the
+\texttt{\textsc{TAB}} key, hence the sample name) between different controls.
+It shows the use of
+\helpref{wxWindow::MoveBeforeInTabOrder()}{wxwindowmovebeforeintaborder} and
+\helpref{MoveAfterInTabOrder()}{wxwindowmoveafterintaborder} methods to change
+the default order of the windows in the navigation chain and of
+\helpref{wxWindow::Navigate()}{wxwindownavigate} for moving focus along this
+chain.
+
+
\subsection{Text sample}\label{sampletext}
This sample demonstrates four features: firstly the use and many variants of
keys, you can test some actions in the text ctrl as well as get statistics on the
text ctrls, which is useful for testing if these statistics actually are correct.
-Thirdly, on platforms which support it, the sample will offer to copy text to the
+Thirdly, on platforms which support it, the sample will offer to copy text to the
\helpref{wxClipboard}{wxclipboard} and to paste text from it. The GTK version will
use the so called PRIMARY SELECTION, which is the pseudo clipboard under X and
best known from pasting text to the XTerm program.
\subsection{Thread sample}\label{samplethread}
-This sample demonstrates the use of threads in connection with GUI programs.
+This sample demonstrates use of threads in connection with GUI programs.
There are two fundamentally different ways to use threads in GUI programs and
either way has to take care of the fact that the GUI library itself usually
is not multi-threading safe, i.e. that it might crash if two threads try to
access the GUI class simultaneously. One way to prevent that is have a normal
-GUI program in the main thread and some worker threads which work in the
+GUI program in the main thread and some worker threads which work in the
background. In order to make communication between the main thread and the
-worker threads possible, wxWidgets offers the \helpref{wxPostEvent}{wxpostevent}
+worker threads possible, wxWidgets offers the \helpref{wxPostEvent}{wxpostevent}
function and this sample makes use of this function.
-The other way to use a so called Mutex (such as those offered in the \helpref{wxMutex}{wxmutex}
+The other way to use a so called Mutex (such as those offered in the \helpref{wxMutex}{wxmutex}
class) that prevent threads from accessing the GUI classes as long as any other
-thread accesses them. For this, wxWidgets has the \helpref{wxMutexGuiEnter}{wxmutexguienter}
+thread accesses them. For this, wxWidgets has the \helpref{wxMutexGuiEnter}{wxmutexguienter}
and \helpref{wxMutexGuiLeave}{wxmutexguileave} functions, both of which are
used and tested in the sample as well.
The following things are demonstrated:
\begin{itemize}\itemsep=0pt
-\item Creating the toolbar using \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}
+\item Creating the toolbar using \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}
and \helpref{wxToolBar::AddControl}{wxtoolbaraddcontrol}: see
MyApp::InitToolbar in the sample.
\item Using {\tt EVT\_UPDATE\_UI} handler for automatically enabling/disabling
toolbar buttons without having to explicitly call EnableTool. This is done
in MyFrame::OnUpdateCopyAndCut.
-\item Using \helpref{wxToolBar::DeleteTool}{wxtoolbardeletetool} and
+\item Using \helpref{wxToolBar::DeleteTool}{wxtoolbardeletetool} and
\helpref{wxToolBar::InsertTool}{wxtoolbarinserttool} to dynamically update the
toolbar.
\end{itemize}
\subsection{Treectrl sample}\label{sampletreectrl}
-This sample demonstrates using \helpref{wxTreeCtrl}{wxtreectrl} class. Here
+This sample demonstrates using the \helpref{wxTreeCtrl}{wxtreectrl} class. Here
you may see how to process various notification messages sent by this control
and also when they occur (by looking at the messages in the text control in
the bottom part of the frame).
demonstrated here as well - try the corresponding menu entries.
+\subsection{Widgets sample}\label{samplewidgets}
+
+The widgets sample is the main presentation program for most simple and advanced
+native controls and complex generic widgets provided by wxWidgets.
+The sample tests their basic functionality, events, placement, modification
+in terms of colour and font as well as the possibility to change
+the controls programmatically, such as adding an item to a list box etc.
+All widgets are categorized for easy browsing.
+
\subsection{Wizard sample}\label{samplewizard}
-This sample shows so-called wizard dialog (implemented using
+This sample shows the so-called wizard dialog (implemented using
\helpref{wxWizard}{wxwizard} and related classes). It shows almost all
features supported:
\item Using bitmaps with the wizard and changing them depending on the page
shown (notice that wxValidationPage in the sample has a different image from
the other ones)
-\item Using \helpref{TransferDataFromWindow}{wxwindowtransferdatafromwindow}
+\item Using \helpref{TransferDataFromWindow}{wxwindowtransferdatafromwindow}
to verify that the data entered is correct before passing to the next page
(done in wxValidationPage which forces the user to check a checkbox before
continuing).
Cancel} button itself instead of relying on the wizard parent to do it.
\item Normally, the order of the pages in the wizard is known at compile-time,
but sometimes it depends on the user choices: wxCheckboxPage shows how to
-dynamically decide which page to display next (see also
+dynamically decide which page to display next (see also
\helpref{wxWizardPage}{wxwizardpage})
\end{itemize}
projects / wxWidgets.git / blobdiff