X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0d7ea902499bf302628cc12aa4705fb162b6fefd..8febdd39057cf2b4984561cc2f55acc9a0d07aca:/docs/latex/wx/tsamples.tex

diff --git a/docs/latex/wx/tsamples.tex b/docs/latex/wx/tsamples.tex
index 85f43f1693..f57c502f9f 100644
--- a/docs/latex/wx/tsamples.tex
+++ b/docs/latex/wx/tsamples.tex
@@ -54,6 +54,45 @@ Unix and uses the Registry under Windows.
 See \helpref{wxConfig overview}{wxconfigoverview} for the descriptions of all
 features of this class.
 
+\subsection{Controls sample}\label{samplecontrols}
+
+The controls sample is the main test program for most simple controls used in
+wxWindows. 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 item to a list box etc. Apart
+from that, the sample uses a \helpref{wxNotebook}{wxnotebook} and tests most
+fetaures of this special control (using bitmap in the tabs, using
+\helpref{wxSizers}{wxsizer} and \helpref{constraints}{wxlayoutconstraints} within
+notebook pages, advanving pages programmatically and vetoing a page change
+by intercepting the \helpref{wxNotebookEvent}{wxnotebookevent}.
+
+The various controls tested are listed here:
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\helpref{wxButton}{wxbutton}}{Push button control, displaying text}
+\twocolitem{\helpref{wxBitmapButton}{wxbitmapbutton}}{Push button control, displaying a bitmap}
+\twocolitem{\helpref{wxCheckBox}{wxcheckbox}}{Checkbox control}
+\twocolitem{\helpref{wxChoice}{wxchoice}}{Choice control (a combobox without the editable area)}
+\twocolitem{\helpref{wxComboBox}{wxcombobox}}{A choice with an editable area}
+\twocolitem{\helpref{wxGauge}{wxgauge}}{A control to represent a varying quantity, such as time remaining}
+\twocolitem{\helpref{wxStaticBox}{wxstaticbox}}{A static, or group box for visually grouping related controls}
+\twocolitem{\helpref{wxListBox}{wxlistbox}}{A list of strings for single or multiple selection}
+\twocolitem{wxSpinCtrl}{A spin ctrl with a text field and a `up-down' control}
+\twocolitem{\helpref{wxSpinButton}{wxspinbutton}}{A spin or `up-down' control}
+\twocolitem{\helpref{wxStaticText}{wxstatictext}}{One or more lines of non-editable text}
+\twocolitem{\helpref{wxStaticBitmap}{wxstaticbitmap}}{A control to display a bitmap}
+\twocolitem{\helpref{wxRadioBox}{wxradiobox}}{A group of radio buttons}
+\twocolitem{\helpref{wxRadioButton}{wxradiobutton}}{A round button to be used with others in a mutually exclusive way}
+\twocolitem{\helpref{wxSlider}{wxslider}}{A slider that can be dragged by the user}
+\end{twocollist}
+
+\subsection{Database sample}\label{sampledb}
+
+The database sample is a small test program showing how to use the ODBC
+classes written by Remstar Intl. These classes are documented in a separate
+manual available from the wxWindows homepage. Obviously, this sample
+requires a database with ODBC support to be correctly installed on your
+system.
+
 \subsection{Dialogs sample}\label{sampledialogs}
 
 This sample shows how to use the common dialogs available from wxWindows. These
@@ -182,6 +221,89 @@ showing how to use sizers in connection with a \helpref{wxNotebook}{wxnotebook}
 class. See also \helpref{wxNotebookSizer}{wxnotebooksizer} and 
 \helpref{wxSizer}{wxsizer}.
 
+\subsection{Image sample}\label{sampleimage}
+
+The image sample demonstrates the 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 to rectangles, one
+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 save PNG files are tested.
+
+At the bottom of the main frame is a test for using a mono-chrome 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 
+\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}.
+
+\subsection{Sockets sample}\label{samplesockets}
+
+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 as a
+\helpref{wxSocketServer}{wxsocketserver} object, and a client, which is
+implemented with \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} event), and stands there, waiting (listening
+in the socket parlance) for clients. For each incoming client, a new
+\helpref{wxSocketBase}{wxsocketbase} object is created, which represents
+the connection. Connections are independent from the server that created
+them, so they set up their own event handler, and stay awaiting for
+{\bf wxSOCKET\_INPUT} (incoming data) or {\bf wxSOCKET\_LOST} (connection
+closed at the remote end) events. This event handler is the same for all
+connections, and demonstrates how to determine which socket the event
+is addressed to by using the \helpref{Socket}{wxsocketeventsocket} function
+in the \helpref{wxSocketEvent}{wxsocketevent} class.
+
+Although it might take some time to get used to the event-oriented
+system upon which wxSocket is built, the benefits are many. See, for
+example, that the server application, while being single-threaded
+(and of course without using fork() or ugly select() loops) can handle
+an arbitrary number of connections.
+
+The client starts up unconnected, so you can use the Connect... option
+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},
+\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 (a lengthy explanation
+on socket flags is available in \helpref{SetFlags}{wxsocketbasesetflags}).
+Note that because both clients and connection objects in the server set
+up an event handler to catch {\bf wxSOCKET\_LOST} events, each one is
+immediately notified if the other end closes the connection.
+
+The sockets sample is work in progress. Coming soon:
+
+\begin{itemize}
+
+\item More tests for basic socket functionality.
+
+\item Tests for the recently added datagram socket classes.
+
+\item Tests for protocol classes (wxProtocol and its descendants).
+
+\item New samples which actually do something useful (suggestions accepted).
+
+\end{itemize}
+
+\subsection{Statbar sample}\label{samplestatbar}
+
+This sample shows how to create and use wxStaticBar. Although most of the
+samples have a statusbar, they usually only create a default one and only
+do it once.
+
+Here you can see how to recreate the statusbar (with possibly different number
+of fields) and how to use it to show icons/bitmaps and/or put arbitrary
+controls into it.
+
 \subsection{Text sample}\label{sampletext}
 
 This sample demonstrates four features: firstly the use and many variants of
