docs/latex/wx/txtdrptg.tex

   1 \section{\class{wxTextDropTarget}}\label{wxtextdroptarget}
   2
   3 A predefined drop target for dealing with text data.
   4
   5 \wxheading{Derived from}
   6
   7 \helpref{wxDropTarget}{wxdroptarget}
   8
   9 \wxheading{Include files}
  10
  11 <wx/dnd.h>
  12
  13 \wxheading{See also}
  14
  15 \helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropSource}{wxdropsource},
  16 \helpref{wxDropTarget}{wxdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget}
  17
  18 \latexignore{\rtfignore{\wxheading{Members}}}
  19
  20 \membersection{wxTextDropTarget::wxTextDropTarget}\label{wxtextdroptargetwxtextdroptarget}
  21
  22 \func{}{wxTextDropTarget}{\void}
  23
  24 Constructor.
  25
  26 \membersection{wxTextDropTarget::GetFormatCount}\label{wxtextdroptargetgetformatcount}
  27
  28 \constfunc{virtual size\_t}{GetFormatCount}{\void}
  29
  30 See \helpref{wxDropTarget::GetFormatCount}{wxdroptargetgetformatcount}. This function is implemented
  31 appropriately for text.
  32
  33 \membersection{wxTextDropTarget::GetFormat}\label{wxtextdroptargetgetformat}
  34
  35 \constfunc{virtual wxDataFormat}{GetFormat}{\param{size\_t }{n}}
  36
  37 See \helpref{wxDropTarget::GetFormat}{wxdroptargetgetformat}. This function is implemented
  38 appropriately for text.
  39
  40 \membersection{wxTextDropTarget::OnDrop}\label{wxtextdroptargetondrop}
  41
  42 \func{virtual bool}{OnDrop}{\param{long }{x}, \param{long }{y}, \param{const void }{*data}, \param{size\_t }{size}}
  43
  44 See \helpref{wxDropTarget::OnDrop}{wxdroptargetondrop}. This function is implemented
  45 appropriately for text, and calls \helpref{wxTextDropTarget::OnDropText}{wxtextdroptargetondroptext}.
  46
  47 \membersection{wxTextDropTarget::OnDropText}\label{wxtextdroptargetondroptext}
  48
  49 \func{virtual bool}{OnDropText}{\param{long }{x}, \param{long }{y}, \param{const char }{*data}}
  50
  51 Override this function to receive dropped text.
  52
  53 \wxheading{Parameters}
  54
  55 \docparam{x}{The x coordinate of the mouse.}
  56
  57 \docparam{y}{The y coordinate of the mouse.}
  58
  59 \docparam{data}{The data being dropped: a NULL-terminated string.}
  60
  61 \wxheading{Return value}
  62
  63 Return TRUE to accept the data, FALSE to veto the operation.
  64