|
|
|
|
@@ -21,12 +21,12 @@ didn't help. They also provide some notes about using the samples and what
|
|
|
|
|
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}
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
@@ -96,7 +96,7 @@ 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. 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}.
|
|
|
|
|
@@ -125,7 +125,7 @@ The various controls tested are listed here:
|
|
|
|
|
\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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@@ -137,7 +137,7 @@ dialogs are described in detail in the \helpref{Common dialogs overview}{commond
|
|
|
|
|
|
|
|
|
|
\subsection{Dialup sample}\label{sampledialup}
|
|
|
|
|
|
|
|
|
|
This sample shows the \helpref{wxDialUpManager}{wxdialupmanager}
|
|
|
|
|
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
|
|
|
|
|
@@ -156,9 +156,9 @@ trivial and may be safely used as a basis for implementing the clipboard and
|
|
|
|
|
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
|
|
|
|
|
@@ -184,7 +184,7 @@ bitmaps which allows them to be pasted/dropped in many other applications
|
|
|
|
|
(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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@@ -205,7 +205,7 @@ See also the \helpref{event sample}{sampleevent}
|
|
|
|
|
|
|
|
|
|
The event sample demonstrates various features of the wxWidgets events. It
|
|
|
|
|
shows using dynamic events and connecting/disconnecting the event handlers
|
|
|
|
|
during run time and also using
|
|
|
|
|
during run time and also using
|
|
|
|
|
\helpref{PushEventHandler()}{wxwindowpusheventhandler} and
|
|
|
|
|
\helpref{PopEventHandler()}{wxwindowpopeventhandler}.
|
|
|
|
|
|
|
|
|
|
@@ -226,21 +226,21 @@ sample.
|
|
|
|
|
|
|
|
|
|
\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.
|
|
|
|
|
@@ -256,7 +256,7 @@ TODO.
|
|
|
|
|
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
|
|
|
|
|
@@ -266,18 +266,18 @@ the library to work with unsupported tags.
|
|
|
|
|
{\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.
|
|
|
|
|
@@ -288,15 +288,15 @@ displays help books given at command line.
|
|
|
|
|
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}.
|
|
|
|
|
@@ -320,14 +320,14 @@ The layout sample demonstrates the two different layout systems offered
|
|
|
|
|
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}.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@@ -346,15 +346,16 @@ The sample also provides some timings for adding/deleting/sorting a lot of
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
to see \helpref{wxListbook}{wxlistbook} and \helpref{wxChoicebook}{wxchoicebook}
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
\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.
|
|
|
|
|
|
|
|
|
|
@@ -371,14 +372,14 @@ better results.
|
|
|
|
|
|
|
|
|
|
\subsection{Scroll subwindow sample}\label{samplescrollsub}
|
|
|
|
|
|
|
|
|
|
This sample demonstrates 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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@@ -386,7 +387,7 @@ 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}.
|
|
|
|
|
|
|
|
|
|
@@ -397,7 +398,7 @@ sets up an event handler to be notified of incoming connection requests
|
|
|
|
|
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
|
|
|
|
|
@@ -414,7 +415,7 @@ to specify the address of the server you are going to connect to (the
|
|
|
|
|
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
|
|
|
|
|
@@ -465,7 +466,7 @@ in a log window at the bottom of the main window. By pressing some of the functi
|
|
|
|
|
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.
|
|
|
|
|
@@ -481,14 +482,14 @@ 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.
|
|
|
|
|
|
|
|
|
|
@@ -502,13 +503,13 @@ The toolbar sample shows the \helpref{wxToolBar}{wxtoolbar} class in action.
|
|
|
|
|
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}
|
|
|
|
|
@@ -538,7 +539,7 @@ demonstrated here as well - try the corresponding menu entries.
|
|
|
|
|
|
|
|
|
|
\subsection{Wizard sample}\label{samplewizard}
|
|
|
|
|
|
|
|
|
|
This sample shows the 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:
|
|
|
|
|
|
|
|
|
|
@@ -546,7 +547,7 @@ 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).
|
|
|
|
|
@@ -556,7 +557,7 @@ page, but not continuing to the next one or vice versa (in wxRadioboxPage)
|
|
|
|
|
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}
|
|
|
|
|
|
|
|
|
|
|
Włodzimierz Skiba