Doc updates.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@5243 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex
index 3f0a644e700aad2196755026818f7d712c976f0a..ad916f3f1d79dee809a38a3cfee012b2dfb290aa 100644 (file)
--- a/docs/latex/wx/category.tex
+++ b/docs/latex/wx/category.tex
@@ -278,6 +278,20 @@ classes, functions and macros.
 %\twocolitem{\helpref{WXTRACELEVEL}{tracelevel}}{Trace macro with levels}
 \end{twocollist}
 
 %\twocolitem{\helpref{WXTRACELEVEL}{tracelevel}}{Trace macro with levels}
 \end{twocollist}
 

+{\large {\bf Networking classes}}
+
+wxWindows provides its own classes for socket based networking.
+
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\helpref{wxSocketClient}{wxsocketclient}}{Represents a socket client}
+\twocolitem{\helpref{wxSocketServer}{wxsocketserver}}{Represents a socket server}
+\twocolitem{\helpref{wxURL}{wxurl}}{Represents a Universal Resource Locator}
+\twocolitem{\helpref{wxHTTP}{wxhttp}}{HTTP protocol class}
+\twocolitem{\helpref{wxFTP}{wxftp}}{FTP protocol class}
+\twocolitem{\helpref{wxSocketEvent}{wxsocketevent}}{A socket event}
+\end{twocollist}
+
+

 {\large {\bf Interprocess communication}}
 
 \overview{Overview}{ipcoverview}
 {\large {\bf Interprocess communication}}
 
 \overview{Overview}{ipcoverview}


@@ -293,9 +307,7 @@ function properly.]
 \twocolitem{\helpref{wxTCPClient}{wxtcpclient}}{Represents a client}
 \twocolitem{\helpref{wxTCPConnection}{wxtcpconnection}}{Represents the connection between a client and a server}
 \twocolitem{\helpref{wxTCPServer}{wxtcpserver}}{Represents a server}
 \twocolitem{\helpref{wxTCPClient}{wxtcpclient}}{Represents a client}
 \twocolitem{\helpref{wxTCPConnection}{wxtcpconnection}}{Represents the connection between a client and a server}
 \twocolitem{\helpref{wxTCPServer}{wxtcpserver}}{Represents a server}

-\twocolitem{\helpref{wxSocketClient}{wxsocketclient}}{Represents a socket client}

 %\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler}
 %\twocolitem{\helpref{wxSocketHandler}{wxsockethandler}}{Represents a socket handler}

-\twocolitem{\helpref{wxSocketServer}{wxsocketserver}}{Represents a socket server}

 \end{twocollist}
 
 {\large {\bf Document/view framework}}
 \end{twocollist}
 
 {\large {\bf Document/view framework}}


@@ -339,21 +351,6 @@ facilities.
 \twocolitem{\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}}{Represents information about the page setup dialog}
 \end{twocollist}
 
 \twocolitem{\helpref{wxPageSetupDialogData}{wxpagesetupdialogdata}}{Represents information about the page setup dialog}
 \end{twocollist}
 

-{\large {\bf Database classes}}
-
-\overview{Database classes overview}{odbcoverview}
-
-wxWindows provides two alternative sets of classes for accessing Microsoft's ODBC (Open Database Connectivity)
-product. The new version by Remstar is documented in a separate manual.
-The older classes are as follows:
-
-\begin{twocollist}\itemsep=0pt
-\twocolitem{\helpref{wxDatabase}{wxdatabase}}{Database class}
-\twocolitem{\helpref{wxQueryCol}{wxquerycol}}{Class representing a column}
-\twocolitem{\helpref{wxQueryField}{wxqueryfield}}{Class representing a field}
-\twocolitem{\helpref{wxRecordSet}{wxrecordset}}{Class representing one or more record}
-\end{twocollist}
-

 {\large {\bf Drag and drop and clipboard classes}}
 
 \overview{Drag and drop and clipboard overview}{wxdndoverview}
 {\large {\bf Drag and drop and clipboard classes}}
 
 \overview{Drag and drop and clipboard overview}{wxdndoverview}


@@ -417,8 +414,26 @@ libraries, and to provide enhanced functionality.
 \twocolitem{\helpref{wxSocketOutputStream}{wxsocketoutputstream}}{Socket output stream class}
 \end{twocollist}
 
 \twocolitem{\helpref{wxSocketOutputStream}{wxsocketoutputstream}}{Socket output stream class}
 \end{twocollist}
 

+{\large {\bf Threading classes}}
+
+\overview{Multithreading overview}{wxthreadoverview}

 
 

-{\large {\bf HTML}}
+wxWindows provides a set of classes to make use of the native thread
+capabilities of the various platforms.
+
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\helpref{wxThread}{wxthread}}{Thread class}
+\twocolitem{\helpref{wxMutex}{wxmutex}}{Mutex class}
+\twocolitem{\helpref{wxMutexLocker}{wxmutexlocker}}{Mutex locker utility class}
+\twocolitem{\helpref{wxCriticalSection}{wxcriticalsection}}{Critical section class}
+\twocolitem{\helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}}{ritical section locker utility class}
+\twocolitem{\helpref{wxConditiion}{wxcondition}}{Condition class}
+\end{twocollist}
+
+{\large {\bf HTML classes}}
+
+wxWindows provides a set of classes to display text in HTML format. These
+class include a help system based on the HTML widget.

 
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}}{HTML help controller class}
 
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}}{HTML help controller class}


@@ -431,14 +446,10 @@ libraries, and to provide enhanced functionality.
 \twocolitem{\helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}}{HTML tag handler, pluginable into wxHtmlWinParser}
 \end{twocollist}
 
 \twocolitem{\helpref{wxHtmlWinTagHandler}{wxhtmlwintaghandler}}{HTML tag handler, pluginable into wxHtmlWinParser}
 \end{twocollist}
 

-
-

 {\large {\bf Miscellaneous}}
 
 \begin{twocollist}\itemsep=0pt
 {\large {\bf Miscellaneous}}
 
 \begin{twocollist}\itemsep=0pt

-\twocolitem{\helpref{wxAcceleratorTable}{wxacceleratortable}}{Accelerator table}

 \twocolitem{\helpref{wxApp}{wxapp}}{Application class}
 \twocolitem{\helpref{wxApp}{wxapp}}{Application class}

-\twocolitem{\helpref{wxAutomationObject}{wxautomationobject}}{OLE automation class}

 \twocolitem{\helpref{wxConfig}{wxconfigbase}}{Classes for configuration reading/writing}
 \twocolitem{\helpref{wxHelpController}{wxhelpcontroller}}{Family of classes for controlling help windows}
 \twocolitem{\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}}{An alternative window layout facility}
 \twocolitem{\helpref{wxConfig}{wxconfigbase}}{Classes for configuration reading/writing}
 \twocolitem{\helpref{wxHelpController}{wxhelpcontroller}}{Family of classes for controlling help windows}
 \twocolitem{\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}}{An alternative window layout facility}


@@ -446,5 +457,22 @@ libraries, and to provide enhanced functionality.
 \twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class}
 \twocolitem{\helpref{wxStopWatch}{wxstopwatch}}{Stop watch class}
 \twocolitem{\helpref{wxSystemSettings}{wxsystemsettings}}{System settings class}
 \twocolitem{\helpref{wxTimer}{wxtimer}}{Timer class}
 \twocolitem{\helpref{wxStopWatch}{wxstopwatch}}{Stop watch class}
 \twocolitem{\helpref{wxSystemSettings}{wxsystemsettings}}{System settings class}

+\twocolitem{\helpref{wxAcceleratorTable}{wxacceleratortable}}{Accelerator table}
+\twocolitem{\helpref{wxAutomationObject}{wxautomationobject}}{OLE automation class}
+\end{twocollist}
+
+{\large {\bf Database classes}}
+
+\overview{Database classes overview}{odbcoverview}
+
+wxWindows provides two alternative sets of classes for accessing Microsoft's ODBC (Open Database Connectivity)
+product. The new version by Remstar is documented in a separate manual.
+The older classes are as follows:
+
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\helpref{wxDatabase}{wxdatabase}}{Database class}
+\twocolitem{\helpref{wxQueryCol}{wxquerycol}}{Class representing a column}
+\twocolitem{\helpref{wxQueryField}{wxqueryfield}}{Class representing a field}
+\twocolitem{\helpref{wxRecordSet}{wxrecordset}}{Class representing one or more record}

 \end{twocollist}
 
 \end{twocollist}
 

diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex
index bc7aa8578bbfe45932fae0c3c377ca79b0961f21..d0da3dde40492ee94212bae116f7452c1016db88 100644 (file)
--- a/docs/latex/wx/classes.tex
+++ b/docs/latex/wx/classes.tex
@@ -20,6 +20,7 @@
 \input button.tex
 \input strmbfrd.tex
 \input calclevt.tex
 \input button.tex
 \input strmbfrd.tex
 \input calclevt.tex

+\input calctrl.tex

 \input checkbox.tex
 \input checklst.tex
 \input choice.tex
 \input checkbox.tex
 \input checklst.tex
 \input choice.tex

diff --git a/docs/latex/wx/manual.tex b/docs/latex/wx/manual.tex
index c7c1ac9b17be395a88eba5d2e67ddb66aac71162..efaa61b5ea9afc6018c1305a96275fa00f6382a4 100644 (file)
--- a/docs/latex/wx/manual.tex
+++ b/docs/latex/wx/manual.tex
@@ -31,7 +31,7 @@
 }}
 \winhelpignore{\author{Julian Smart, Robert Roebling, Vadim Zeitlin,
 Robin Dunn, et al}
 }}
 \winhelpignore{\author{Julian Smart, Robert Roebling, Vadim Zeitlin,
 Robin Dunn, et al}

-\date{November 20th 1999}
+\date{January 6th 2000}

 }
 \makeindex
 \begin{document}
 }
 \makeindex
 \begin{document}

diff --git a/docs/latex/wx/tsamples.tex b/docs/latex/wx/tsamples.tex
index a94b0b31849ed66c842b0791d3125986f53384e6..886f5fc994e9aa933d698dab0b9895c6d2126a03 100644 (file)
--- a/docs/latex/wx/tsamples.tex
+++ b/docs/latex/wx/tsamples.tex
@@ -19,6 +19,16 @@ make it easier to find the relevant one if a simple grep through all sources
 didn't help. They also provide some notes about using the samples and what
 features of wxWindows are they supposed to test.
 
 didn't help. They also provide some notes about using the samples and what
 features of wxWindows are they supposed to test.
 

+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
 \subsection{Calendar sample}\label{samplecalendar}
 
 This font shows the \helpref{calendar control}{wxcalendarctrl} in action. It


@@ -49,6 +59,16 @@ features of this class.
 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}.
 
 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{Scroll subwindow sample}\label{samplescrollsub}
 
 This sample demonstrates the use of the \helpref{wxScrolledWindow}{wxscrolledwindow}
 \subsection{Scroll subwindow sample}\label{samplescrollsub}
 
 This sample demonstrates the use of the \helpref{wxScrolledWindow}{wxscrolledwindow}


@@ -135,6 +155,44 @@ documents without much work. In fact, only few function calls are sufficient.
 while {\it Helpview} is simple tool that only pops up help window and
 displays help books given at command line.
 
 while {\it Helpview} is simple tool that only pops up help window and
 displays help books given at command line.
 

+\subsection{Layout sample}\label{samplelayout}
+
+The layout sample demonstrates the two different layout systems offered
+by wxWindows. 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}
+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}
+class. See also \helpref{wxNotebookSizer}{wxnotebooksizer} and 
+\helpref{wxSizer}{wxsizer}.
+
+\subsection{Text sample}\label{sampletext}
+
+This sample demonstrates four features: firstly the use and many variants of
+the \helpref{wxTextCtrl}{wxtextctrl} class (single line, multi line, read only,
+password, ignoring TAB, ignoring ENTER).
+
+Secondly it shows how to intercept a \helpref{wxKeyEvent}{wxkeyevent} in both
+the raw form using the {\tt EVT_KEY_UP} and {\tt EVT_KEY_DOWN} macros and the
+higherlevel from using the {\tt EVT_CHAR} macro. All characters will be logged
+in a log window at the bottom of the main window. By pressing some of the function
+keys, you can test some actions in the text ctrl as well as get statitics on the
+text ctrls, which is useful for testing if these statitics actually are correct.
+
+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. 
+
+Last not least: some of the text controls have tooltips and the sample also shows
+how tooltips can be centrally disabled and their latency controlled.
+

 \subsection{Thread sample}\label{samplethread}
 
 This sample demonstrates the use of threads in connection with GUI programs.
 \subsection{Thread sample}\label{samplethread}
 
 This sample demonstrates the use of threads in connection with GUI programs.