+There are currently more than 50 different samples as part of wxWindows and
+this list is not complete.
+
+\subsection{Minimal sample}\label{sampleminimal}
+
+The minimal sample is what most people will know under the term Hello World,
+i.e. a minimal program that doesn't demonstrate anything apart from what is
+needed to write a program that will display a "hello" dialog. This is usually
+a good starting point for learning how to use wxWindows.
+
+\subsection{Calendar sample}\label{samplecalendar}
+
+This font shows the \helpref{calendar control}{wxcalendarctrl} in action. It
+shows how to configure the control (see the different options in the calendar
+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 modifiying the control, such as by deleting items
+from it or inserting new once (these fucntions are actually implememted 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
+indepedent way, i.e. it uses text based files to store a given configuration under
+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
+dialogs are desrcibed in details in the \helpref{Common dialogs overview}{commondialogsoverview}.
+
+\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
+languge that would work as a wrapper for wxWindows or programs where
+forms or similar datagrams can be created by the uses.
+
+\subsection{Exec sample}\label{sampleexec}
+
+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).
+
+\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
+\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 wxWindows,
+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.
+
projects / wxWidgets.git / blobdiff