git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	\section{\class{wxDropSource}}\label{wxdropsource}
	2
	3	\overview{Overview}{wxdndoverview}
	4
	5	This class represents a source for a drag and drop operation.
	6
	7	\wxheading{Derived from}
	8
	9	\helpref{wxObject}{wxobject}
	10
	11	\wxheading{Include files}
	12
	13	<wx/dnd.h>
	14
	15	\wxheading{Types}
	16
	17	\index{wxDragResult}wxDragResult is defined as follows:
	18
	19	{\small\begin{verbatim}
	20	enum wxDragResult
	21	{
	22	wxDragError, // error prevented the d&d operation from completing
	23	wxDragNone, // drag target didn't accept the data
	24	wxDragCopy, // the data was successfully copied
	25	wxDragMove, // the data was successfully moved
	26	wxDragCancel // the operation was cancelled by user (not an error)
	27	};
	28	\end{verbatim}%
	29	}
	30
	31	\wxheading{See also}
	32
	33	\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropTarget}{wxdroptarget},
	34	\helpref{wxTextDropTarget}{wxtextdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget}
	35
	36	\latexignore{\rtfignore{\wxheading{Members}}}
	37
	38	\membersection{wxDropSource::wxDropSource}\label{wxdropsourcewxdropsource}
	39
	40	\func{}{wxDropSource}{\param{wxWindow*}{ win = NULL}}
	41
	42	Default/wxGTK-specific constructor. If you use the default constructor you must
	43	call \helpref{wxDropSource::SetData}{wxdropsourcesetdata} later.
	44
	45	{\it win} is required by wxGTK and therefore should always be set.
	46
	47	\membersection{wxDropSource::\destruct{wxDropSource}}\label{wxdropsourcedtor}
	48
	49	\func{virtual }{\destruct{wxDropSource}}{\void}
	50
	51	\membersection{wxDropSource::SetData}\label{wxdropsourcesetdata}
	52
	53	\func{void}{SetData}{\param{wxDataObject\&}{ data}}
	54
	55	Sets the data \helpref{data object}{wxdataobject} associated with the drop source.
	56
	57	\membersection{wxDropSource::DoDragDrop}\label{wxdropsourcedodragdrop}
	58
	59	\func{virtual wxDragResult}{DoDragDrop}{\param{bool }{allowMove = FALSE}}
	60
	61	Do it (call this in response to a mouse button press, for example).
	62
	63	If {\bf allowMove} is FALSE, data can only be copied.
	64
	65	\membersection{wxDropSource::GiveFeedback}\label{wxdropsourcegivefeedback}
	66
	67	\func{virtual bool}{GiveFeedback}{\param{wxDragResult }{effect}, \param{bool }{scrolling}}
	68
	69	Overridable: you may give some custom UI feedback during the drag and drop operation
	70	in this function. It is called on each mouse move, so your implementation must not be too
	71	slow.
	72
	73	\wxheading{Parameters}
	74
	75	\docparam{effect}{The effect to implement. One of wxDragCopy, wxDragMove and wxDragNone. }
	76
	77	\docparam{scrolling}{TRUE if the window is scrolling. MSW only. }
	78
	79	\wxheading{Return value}
	80
	81	Return FALSE if you want default feedback, or TRUE if you implement your own
	82	feedback. The return values is ignored under GTK.
	83