docs/latex/wx/fildrptg.tex

   1 \section{\class{wxFileDropTarget}}\label{wxfiledroptarget}
   2
   3  A drop target which accepts files (dragged from File Manager or Explorer).
   4
   5 \wxheading{Derived from}
   6
   7 \helpref{wxDropTarget}{wxdroptarget}
   8
   9 \wxheading{See also}
  10
  11 \helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropSource}{wxdropsource},
  12 \helpref{wxDropTarget}{wxdroptarget}, \helpref{wxTextDropTarget}{wxtextdroptarget}
  13
  14 \latexignore{\rtfignore{\wxheading{Members}}}
  15
  16 \membersection{wxFileDropTarget::wxFileDropTarget}\label{wxfiledroptargetwxfiledroptarget}
  17
  18 \func{}{wxFileDropTarget}{\void}
  19
  20 Constructor.
  21
  22 \membersection{wxFileDropTarget::GetFormatCount}\label{wxfiledroptargetgetformatcount}
  23
  24 \func{virtual size\_t}{GetFormatCount}{\void}
  25
  26 See \helpref{wxDropTarget::GetFormatCount}{wxdroptargetgetformatcount}. This function is implemented
  27 appropriately for files.
  28
  29 \membersection{wxFileDropTarget::GetFormat}\label{wxfiledroptargetgetformat}
  30
  31 \constfunc{virtual wxDataFormat}{GetFormat}{\param{size\_t }{n}}
  32
  33 See \helpref{wxDropTarget::GetFormat}{wxdroptargetgetformat}. This function is implemented
  34 appropriately for files.
  35
  36 \membersection{wxFileDropTarget::OnDrop}\label{wxfiledroptargetondrop}
  37
  38 \func{virtual bool}{OnDrop}{\param{long }{x}, \param{long }{y}, \param{const void }{*data}, \param{size\_t }{size}}
  39
  40 See \helpref{wxDropTarget::OnDrop}{wxdroptargetondrop}. This function is implemented
  41 appropriately for files, and calls \helpref{wxFileDropTarget::OnDropFiles}{wxfiledroptargetondropfiles}.
  42
  43 \membersection{wxFileDropTarget::OnDropFiles}\label{wxfiledroptargetondropfiles}
  44
  45 \func{virtual bool}{OnDropFiles}{\param{long }{x}, \param{long }{y}, \param{size\_t }{nFiles}, \param{const char * const}{files[]}}
  46
  47 Override this function to receive dropped files.
  48
  49 \wxheading{Parameters}
  50
  51 \docparam{x}{The x coordinate of the mouse.}
  52
  53 \docparam{y}{The y coordinate of the mouse.}
  54
  55 \docparam{nFiles}{The number of files being dropped.}
  56
  57 \docparam{files}{An array of filenames.}
  58
  59 \wxheading{Return value}
  60
  61 Return TRUE to accept the data, FALSE to veto the operation.
  62