From: Julian Smart Date: Thu, 13 Feb 2003 18:28:36 +0000 (+0000) Subject: DOc fixes X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/80793cda3ecd4432779bb09fdcea539784b840cd?hp=6faf4b5f59a3c148a177629d9798c1eb95787a2f DOc fixes git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@19209 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index c7c0e0478a..5a77af4789 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -309,7 +309,7 @@ creation of objects given class names. \overview{Overview}{wxlogoverview} -wxWindows provides several classes and functions for the message logging. +wxWindows provides several classes and functions for message logging. Please see the \helpref{wxLog overview}{wxlogoverview} for more details. \twocolwidtha{6cm} diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index b932f7a6fd..e8bad3500f 100644 --- a/docs/latex/wx/image.tex +++ b/docs/latex/wx/image.tex @@ -828,7 +828,7 @@ Specifies whether there is a mask or not. The area of the mask is determined by \membersection{wxImage::SetMaskColour}\label{wximagesetmaskcolour} -\func{void}{SetMaskColour}{\param{unsigned char }{red}, \param{unsigned char }{blue}, \param{unsigned char }{green}} +\func{void}{SetMaskColour}{\param{unsigned char }{red}, \param{unsigned char }{green}, \param{unsigned char }{blue}} Sets the mask colour for this image (and tells the image to use the mask). diff --git a/docs/latex/wx/tdb.tex b/docs/latex/wx/tdb.tex index 4ff6da4cc9..4117ae35d4 100644 --- a/docs/latex/wx/tdb.tex +++ b/docs/latex/wx/tdb.tex @@ -341,7 +341,7 @@ to when first starting to use the classes. Throughout the steps, small snippets of code are provided to show the syntax of performing the step. A complete code snippet is provided at the end of this overview that shows a complete working flow of all these steps (see -\helpref{wxODBC - Sample Code {\tt\#}1}{wxodbcsamplecode1}). +\helpref{wxODBC - Sample Code}{wxodbcsamplecode1}). {\bf Define datasource connection information} @@ -938,7 +938,7 @@ The ODBC classes support for Unicode is yet in early experimental stage and hasn't been tested extensively. It might work for you or it might not: please report the bugs/problems you have encountered in the latter case. -\subsection{wxODBC - Sample Code {\tt\#}1}\label{wxodbcsamplecode1} +\subsection{wxODBC - Sample Code}\label{wxodbcsamplecode1} Simplest example of establishing/opening a connection to an ODBC datasource, binding variables to the columns for read/write usage, opening an diff --git a/docs/latex/wx/tdnd.tex b/docs/latex/wx/tdnd.tex index fe251ebb55..7e2737f23f 100644 --- a/docs/latex/wx/tdnd.tex +++ b/docs/latex/wx/tdnd.tex @@ -20,7 +20,7 @@ and identify its format(s) using the \helpref{wxDataFormat}{wxdataformat} class. To be a {\it drag source}, i.e. to provide the data which may be dragged by -user elsewhere, you should implement the following steps: +the user elsewhere, you should implement the following steps: \begin{itemize}\itemsep=0pt \item {\bf Preparation:} First of all, a data object must be created and @@ -29,17 +29,17 @@ initialized with the data you wish to drag. For example: \begin{verbatim} wxTextDataObject my_data("This text will be dragged."); \end{verbatim} -\item{\bf Drag start:} To start dragging process (typically in response to a +\item{\bf Drag start:} To start the dragging process (typically in response to a mouse click) you must call \helpref{wxDropSource::DoDragDrop}{wxdropsourcedodragdrop} like this: \begin{verbatim} wxDropSource dragSource( this ); dragSource.SetData( my_data ); - wxDragResult result = dragSource.DoDragDrop( true ); + wxDragResult result = dragSource.DoDragDrop( TRUE ); \end{verbatim} -\item {\bf Dragging:} The call to DoDragDrop() blocks the program until the user release the -mouse button (unless you override \helpref{GiveFeedback}{wxdropsourcegivefeedback} function +\item {\bf Dragging:} The call to DoDragDrop() blocks the program until the user releases the +mouse button (unless you override the \helpref{GiveFeedback}{wxdropsourcegivefeedback} function to do something special). When the mouse moves in a window of a program which understands the same drag-and-drop protocol (any program under Windows or any program supporting the XDnD protocol under X Windows), the corresponding \helpref{wxDropTarget}{wxdroptarget} methods @@ -57,28 +57,28 @@ is one of the values of {\tt wxDragResult} enum (explained \helpref{here}{wxdrop \end{verbatim} \end{itemize} -To be a {\it drop target}, i.e. to receive the data dropped by user you should +To be a {\it drop target}, i.e. to receive the data dropped by the user you should follow the instructions below: \begin{itemize}\itemsep=0pt -\item {\bf Initialization:} For a window to be drop target, it needs to have +\item {\bf Initialization:} For a window to be a drop target, it needs to have an associated \helpref{wxDropTarget}{wxdroptarget} object. Normally, you will call \helpref{wxWindow::SetDropTarget}{wxwindowsetdroptarget} during window -creation associating you drop target with it. You must derive a class from +creation associating your drop target with it. You must derive a class from wxDropTarget and override its pure virtual methods. Alternatively, you may derive from \helpref{wxTextDropTarget}{wxtextdroptarget} or \helpref{wxFileDropTarget}{wxfiledroptarget} and override their OnDropText() or OnDropFiles() method. \item {\bf Drop:} When the user releases the mouse over a window, wxWindows -queries the associated wxDropTarget object if it accepts the data. For this, +asks the associated wxDropTarget object if it accepts the data. For this, a \helpref{wxDataObject}{wxdataobject} must be associated with the drop target and this data object will be responsible for the format negotiation between the drag source and the drop target. If all goes well, then \helpref{OnData}{wxdroptargetondata} will get called and the wxDataObject belonging to the drop target can get filled with data. \item {\bf The end:} After processing the data, DoDragDrop() returns either -wxDragCopy or wxDragMove depending on the state of the keys (, -and ) at the moment of drop. There is currently no way for the drop +wxDragCopy or wxDragMove depending on the state of the keys , +and at the moment of the drop. There is currently no way for the drop target to change this return code. \end{itemize}