X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b666df2c102d1e183532adf0c003e63b1a591e2f..d5db80c26999bab5ad0ee610aeaa59ffb0e9c1c6:/docs/latex/wx/dropsrc.tex diff --git a/docs/latex/wx/dropsrc.tex b/docs/latex/wx/dropsrc.tex index 95a49d778f..f25dff1898 100644 --- 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} + + + \wxheading{Types} \index{wxDragResult}wxDragResult is defined as follows: @@ -33,43 +37,34 @@ 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 required by wxGTK and therefore should always be set. -\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} - \membersection{wxDropSource::\destruct{wxDropSource}}\label{wxdropsourcedtor} \func{virtual }{\destruct{wxDropSource}}{\void} \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. Under GTK, data -is always 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 @@ -77,12 +72,12 @@ slow. \wxheading{Parameters} -\docparam{effect}{The effect to implement. One of wxDragCopy, wxDragMove. MSW only. } +\docparam{effect}{The effect to implement. One of wxDragCopy, wxDragMove and wxDragNone. } -\docparam{bScrolling}{TRUE if the window is scrolling. MSW only. } +\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.