Some doc changes

[wxWidgets.git] / docs / latex / wx / dropsrc.tex

diff --git a/docs/latex/wx/dropsrc.tex b/docs/latex/wx/dropsrc.tex
index 077ad1c69f76f973e89256c5523c3240938ac21a..f25dff189895462fc47e71a076a68b55b270bdaf 100644 (file)
--- a/docs/latex/wx/dropsrc.tex
+++ b/docs/latex/wx/dropsrc.tex
@@ -8,6 +8,10 @@ This class represents a source for a drag and drop operation.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/dnd.h>
+
 \wxheading{Types}
 
 \index{wxDragResult}wxDragResult is defined as follows:
@@ -33,20 +37,12 @@ enum wxDragResult
 
 \membersection{wxDropSource::wxDropSource}\label{wxdropsourcewxdropsource}
 
-\func{}{wxDropSource}{\param{wxWindow }{*win = NULL}}
+\func{}{wxDropSource}{\param{wxWindow*}{ win = NULL}}
 
 Default/wxGTK-specific constructor. If you use the default constructor you must
 call \helpref{wxDropSource::SetData}{wxdropsourcesetdata} later.
 
-{\it win} is only used by wxGTK. TODO: in what circumstances?
-
-\func{}{wxDropSource}{\param{wxDataObject }{\&data}, \param{wxWindow }{*win = NULL}}
-
-\wxheading{Parameters}
-
-\docparam{data}{A reference to the \helpref{data object}{wxdataobject} associated with the drop source.}
-
-\docparam{win}{Only used by wxGTK. TODO}
+{\it win} is required by wxGTK and therefore should always be set.
 
 \membersection{wxDropSource::\destruct{wxDropSource}}\label{wxdropsourcedtor}
 
@@ -54,21 +50,21 @@ call \helpref{wxDropSource::SetData}{wxdropsourcesetdata} later.
 
 \membersection{wxDropSource::SetData}\label{wxdropsourcesetdata}
 
-\func{void}{SetData}{\param{wxDataObject }{\&data}}
+\func{void}{SetData}{\param{wxDataObject\&}{ data}}
 
 Sets the data \helpref{data object}{wxdataobject} associated with the drop source.
 
 \membersection{wxDropSource::DoDragDrop}\label{wxdropsourcedodragdrop}
 
-\func{virtual wxDragResult}{DoDragDrop}{\param{bool }{bAllowMove = FALSE}}
+\func{virtual wxDragResult}{DoDragDrop}{\param{bool }{allowMove = FALSE}}
 
 Do it (call this in response to a mouse button press, for example).
 
-If {\bf bAllowMove} is FALSE, data can only be copied.
+If {\bf allowMove} is FALSE, data can only be copied.
 
 \membersection{wxDropSource::GiveFeedback}\label{wxdropsourcegivefeedback}
 
-\func{virtual bool}{GiveFeedback}{\param{wxDragResult }{effect}, \param{bool }{bScrolling}}
+\func{virtual bool}{GiveFeedback}{\param{wxDragResult }{effect}, \param{bool }{scrolling}}
 
 Overridable: you may give some custom UI feedback during the drag and drop operation
 in this function. It is called on each mouse move, so your implementation must not be too
@@ -76,12 +72,12 @@ slow.
 
 \wxheading{Parameters}
 
-\docparam{effect}{The effect to implement. One of wxDragCopy, wxDragMove.}
+\docparam{effect}{The effect to implement. One of wxDragCopy, wxDragMove and wxDragNone. }
 
-\docparam{bScrolling}{TRUE if the window is scrolling.}
+\docparam{scrolling}{TRUE if the window is scrolling. MSW only. }
 
 \wxheading{Return value}
 
 Return FALSE if you want default feedback, or TRUE if you implement your own
-feedback.
+feedback. The return values is ignored under GTK.