docs/latex/wx/fildrptg.tex

   1 \section{\class{wxFileDropTarget}}\label{wxfiledroptarget}
   2
   3 This is a \helpref{drop target}{wxdroptarget} which accepts files (dragged
   4 from File Manager or Explorer).
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxDropTarget}{wxdroptarget}
   9
  10 \wxheading{Include files}
  11
  12 <wx/dnd.h>
  13
  14 \wxheading{See also}
  15
  16 \helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropSource}{wxdropsource},
  17 \helpref{wxDropTarget}{wxdroptarget}, \helpref{wxTextDropTarget}{wxtextdroptarget}
  18
  19 \latexignore{\rtfignore{\wxheading{Members}}}
  20
  21 \membersection{wxFileDropTarget::wxFileDropTarget}\label{wxfiledroptargetwxfiledroptarget}
  22
  23 \func{}{wxFileDropTarget}{\void}
  24
  25 Constructor.
  26
  27 \membersection{wxFileDropTarget::OnDrop}\label{wxfiledroptargetondrop}
  28
  29 \func{virtual bool}{OnDrop}{\param{long }{x}, \param{long }{y}, \param{const void }{*data}, \param{size\_t }{size}}
  30
  31 See \helpref{wxDropTarget::OnDrop}{wxdroptargetondrop}. This function is implemented
  32 appropriately for files, and calls \helpref{wxFileDropTarget::OnDropFiles}{wxfiledroptargetondropfiles}.
  33
  34 \membersection{wxFileDropTarget::OnDropFiles}\label{wxfiledroptargetondropfiles}
  35
  36 \func{virtual bool}{OnDropFiles}{\param{wxCoord }{x}, \param{wxCoord }{y}, \param{const wxArrayString\& }{filenames}}
  37
  38 Override this function to receive dropped files.
  39
  40 \wxheading{Parameters}
  41
  42 \docparam{x}{The x coordinate of the mouse.}
  43
  44 \docparam{y}{The y coordinate of the mouse.}
  45
  46 \docparam{filenames}{An array of filenames.}
  47
  48 \wxheading{Return value}
  49
  50 Return TRUE to accept the data, FALSE to veto the operation.
  51
  52 % VZ: this clarification is probably not needed any longer?
  53 %\perlnote{In wxPerl there is just an array reference in place of {\tt nFiles}
  54 %and {\tt files}.}
  55