docs/latex/wx/dropsrc.tex

   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 \func{}{wxDropSource}{\param{wxDataObject\& }{data}, \param{wxWindow*}{ win = NULL}}
  48
  49 \wxheading{Parameters}
  50
  51 \docparam{data}{A reference to the \helpref{data object}{wxdataobject} associated with the drop source.}
  52
  53 \docparam{win}{Only used by wxGTK. TODO}
  54
  55 \membersection{wxDropSource::\destruct{wxDropSource}}\label{wxdropsourcedtor}
  56
  57 \func{virtual }{\destruct{wxDropSource}}{\void}
  58
  59 \membersection{wxDropSource::SetData}\label{wxdropsourcesetdata}
  60
  61 \func{void}{SetData}{\param{wxDataObject\&}{ data}}
  62
  63 Sets the data \helpref{data object}{wxdataobject} associated with the drop source.
  64
  65 \membersection{wxDropSource::DoDragDrop}\label{wxdropsourcedodragdrop}
  66
  67 \func{virtual wxDragResult}{DoDragDrop}{\param{bool }{bAllowMove = FALSE}}
  68
  69 Do it (call this in response to a mouse button press, for example).
  70
  71 If {\bf bAllowMove} is FALSE, data can only be copied. Under GTK, data
  72 is always copied.
  73
  74 \membersection{wxDropSource::GiveFeedback}\label{wxdropsourcegivefeedback}
  75
  76 \func{virtual bool}{GiveFeedback}{\param{wxDragResult }{effect}, \param{bool }{bScrolling}}
  77
  78 Overridable: you may give some custom UI feedback during the drag and drop operation
  79 in this function. It is called on each mouse move, so your implementation must not be too
  80 slow.
  81
  82 \wxheading{Parameters}
  83
  84 \docparam{effect}{The effect to implement. One of wxDragCopy, wxDragMove. MSW only. }
  85
  86 \docparam{bScrolling}{TRUE if the window is scrolling. MSW only. }
  87
  88 \wxheading{Return value}
  89
  90 Return FALSE if you want default feedback, or TRUE if you implement your own
  91 feedback.
  92