docs/latex/wx/dropevt.tex

   1 \section{\class{wxDropFilesEvent}}\label{wxdropfilesevent}
   2
   3 This class is used for drop files events, that is, when files have been dropped
   4 onto the window. This functionality is currently only available under Windows.
   5
   6 Important note: this is a separate implementation to the more general
   7 drag and drop implementation documented \helpref{here}{wxdndoverview}. It uses the
   8 older, Windows message-based approach of dropping files.
   9
  10 \wxheading{Derived from}
  11
  12 \helpref{wxEvent}{wxevent}\\
  13 \helpref{wxObject}{wxobject}
  14
  15 \wxheading{Include files}
  16
  17 <wx/event.h>
  18
  19 \wxheading{Event table macros}
  20
  21 To process a drop files event, use these event handler macros to direct input to a member
  22 function that takes a wxDropFilesEvent argument.
  23
  24 \twocolwidtha{7cm}
  25 \begin{twocollist}\itemsep=0pt
  26 \twocolitem{{\bf EVT\_DROP\_FILES(func)}}{Process a wxEVT\_DROP\_FILES event.}
  27 \end{twocollist}%
  28
  29 \wxheading{See also}
  30
  31 \helpref{wxWindow::OnDropFiles}{wxwindowondropfiles}, \helpref{Event handling overview}{eventhandlingoverview}
  32
  33 \latexignore{\rtfignore{\wxheading{Members}}}
  34
  35 \membersection{wxDropFilesEvent::wxDropFilesEvent}
  36
  37 \func{}{wxDropFilesEvent}{\param{WXTYPE }{id = 0}, \param{int }{noFiles = 0},\rtfsp
  38 \param{wxString* }{files = NULL}}
  39
  40 Constructor.
  41
  42 \membersection{wxDropFilesEvent::m\_files}
  43
  44 \member{wxString*}{m\_files}
  45
  46 An array of filenames.
  47
  48 \membersection{wxDropFilesEvent::m\_noFiles}
  49
  50 \member{int}{m\_noFiles}
  51
  52 The number of files dropped.
  53
  54 \membersection{wxDropFilesEvent::m\_pos}
  55
  56 \member{wxPoint}{m\_pos}
  57
  58 The point at which the drop took place.
  59
  60 \membersection{wxDropFilesEvent::GetFiles}\label{wxdropfileseventgetfiles}
  61
  62 \constfunc{wxString*}{GetFiles}{\void}
  63
  64 Returns an array of filenames.
  65
  66 \membersection{wxDropFilesEvent::GetNumberOfFiles}\label{wxdropfileseventgetnumberoffiles}
  67
  68 \constfunc{int}{GetNumberOfFiles}{\void}
  69
  70 Returns the number of files dropped.
  71
  72 \membersection{wxDropFilesEvent::GetPosition}\label{wxdropfileseventgetposition}
  73
  74 \constfunc{wxPoint}{GetPosition}{\void}
  75
  76 Returns the position at which the files were dropped.
  77
  78 Returns an array of filenames.
  79
  80