X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..ecf527c06b7ab2f1101fdc050783d846f4b34f93:/docs/latex/wx/dropsrc.tex diff --git a/docs/latex/wx/dropsrc.tex b/docs/latex/wx/dropsrc.tex index 2fc43ea65b..1711e603ec 100644 --- a/docs/latex/wx/dropsrc.tex +++ b/docs/latex/wx/dropsrc.tex @@ -1,12 +1,13 @@ \section{\class{wxDropSource}}\label{wxdropsource} -\overview{Overview}{wxdndoverview} - This class represents a source for a drag and drop operation. +See \helpref{Drag'n'Drop overview}{wxdndoverview} and \helpref{wxDataObject overview}{wxdataobjectoverview} +for more information. + \wxheading{Derived from} -\helpref{wxObject}{wxobject} +None \wxheading{Include files} @@ -18,19 +19,19 @@ This class represents a source for a drag and drop operation. {\small\begin{verbatim} enum wxDragResult - { +{ wxDragError, // error prevented the d&d operation from completing wxDragNone, // drag target didn't accept the data wxDragCopy, // the data was successfully copied wxDragMove, // the data was successfully moved wxDragCancel // the operation was cancelled by user (not an error) - }; -\end{verbatim}% +}; +\end{verbatim} } \wxheading{See also} -\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropTarget}{wxdroptarget}, +\helpref{wxDropTarget}{wxdroptarget}, \helpref{wxTextDropTarget}{wxtextdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget} \latexignore{\rtfignore{\wxheading{Members}}} @@ -40,17 +41,9 @@ enum wxDragResult \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.} +call \helpref{SetData}{wxdropsourcesetdata} later. -\docparam{win}{Only used by wxGTK. TODO} +Note that {\it win} is required by the GTK port and therefore should always be set. \membersection{wxDropSource::\destruct{wxDropSource}}\label{wxdropsourcedtor} @@ -60,20 +53,20 @@ call \helpref{wxDropSource::SetData}{wxdropsourcesetdata} later. \func{void}{SetData}{\param{wxDataObject\&}{ data}} -Sets the data \helpref{data object}{wxdataobject} associated with the drop source. +Sets the data \helpref{wxDataObject}{wxdataobject} associated with the +drop source. This will not delete any previously associated data. \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 @@ -81,12 +74,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.