docs/latex/wx/dropsrc.tex

   1 \section{\class{wxDropSource}}\label{wxdropsource}
   2
   3 This class represents a source for a drag and drop operation.
   4
   5 See \helpref{Drag'n'Drop overview}{wxdndoverview} and \helpref{wxDataObject overview}{wxdataobjectoverview}
   6 for more information.
   7
   8 \wxheading{Derived from}
   9
  10 None
  11
  12 \wxheading{Include files}
  13
  14 <wx/dnd.h>
  15
  16 \wxheading{Types}
  17
  18 \index{wxDragResult}wxDragResult is defined as follows:
  19
  20 begin{verbatim}
  21 enum wxDragResult
  22 {
  23     wxDragError,    // error prevented the d&d operation from completing
  24     wxDragNone,     // drag target didn't accept the data
  25     wxDragCopy,     // the data was successfully copied
  26     wxDragMove,     // the data was successfully moved
  27     wxDragCancel    // the operation was cancelled by user (not an error)
  28 };
  29 \end{verbatim}
  30
  31 \wxheading{See also}
  32
  33 \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{SetData}{wxdropsourcesetdata} later.
  44
  45 Note that {\it win} is required by the GTK port 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{wxDataObject}{wxdataobject} associated with the
  56 drop source. This will not delete any previously associated data.
  57
  58 \membersection{wxDropSource::DoDragDrop}\label{wxdropsourcedodragdrop}
  59
  60 \func{virtual wxDragResult}{DoDragDrop}{\param{bool }{allowMove = FALSE}}
  61
  62 Do it (call this in response to a mouse button press, for example).
  63
  64 If {\bf allowMove} is FALSE, data can only be copied.
  65
  66 \membersection{wxDropSource::GiveFeedback}\label{wxdropsourcegivefeedback}
  67
  68 \func{virtual bool}{GiveFeedback}{\param{wxDragResult }{effect}, \param{bool }{scrolling}}
  69
  70 Overridable: you may give some custom UI feedback during the drag and drop operation
  71 in this function. It is called on each mouse move, so your implementation must not be too
  72 slow.
  73
  74 \wxheading{Parameters}
  75
  76 \docparam{effect}{The effect to implement. One of wxDragCopy, wxDragMove and wxDragNone. }
  77
  78 \docparam{scrolling}{TRUE if the window is scrolling. MSW only. }
  79
  80 \wxheading{Return value}
  81
  82 Return FALSE if you want default feedback, or TRUE if you implement your own
  83 feedback. The return values is ignored under GTK.
  84