projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| a660d684 KB |
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. | |
| f4fcc291 JS |
5 | The window must have previously been enabled for dropping by calling |
| 6 | \helpref{wxWindow::DragAcceptFiles}{wxwindowdragacceptfiles}. | |
| a660d684 | 7 | |
| dface61c JS |
8 | Important note: this is a separate implementation to the more general |
| 9 | drag and drop implementation documented \helpref{here}{wxdndoverview}. It uses the | |
| 10 | older, Windows message-based approach of dropping files. | |
| 11 | ||
| a660d684 KB |
12 | \wxheading{Derived from} |
| 13 | ||
| 14 | \helpref{wxEvent}{wxevent}\\ | |
| 15 | \helpref{wxObject}{wxobject} | |
| 16 | ||
| 954b8ae6 JS |
17 | \wxheading{Include files} |
| 18 | ||
| 19 | <wx/event.h> | |
| 20 | ||
| a7af285d VZ |
21 | \wxheading{Library} |
| 22 | ||
| 23 | \helpref{wxCore}{librarieslist} | |
| 24 | ||
| a660d684 KB |
25 | \wxheading{Event table macros} |
| 26 | ||
| 27 | To process a drop files event, use these event handler macros to direct input to a member | |
| 28 | function that takes a wxDropFilesEvent argument. | |
| 29 | ||
| 30 | \twocolwidtha{7cm} | |
| 31 | \begin{twocollist}\itemsep=0pt | |
| 32 | \twocolitem{{\bf EVT\_DROP\_FILES(func)}}{Process a wxEVT\_DROP\_FILES event.} | |
| 33 | \end{twocollist}% | |
| 34 | ||
| 35 | \wxheading{See also} | |
| 36 | ||
| f4fcc291 | 37 | \helpref{Event handling overview}{eventhandlingoverview} |
| a660d684 KB |
38 | |
| 39 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 40 | ||
| b236c10f | 41 | \membersection{wxDropFilesEvent::wxDropFilesEvent}\label{wxdropfileseventctor} |
| a660d684 KB |
42 | |
| 43 | \func{}{wxDropFilesEvent}{\param{WXTYPE }{id = 0}, \param{int }{noFiles = 0},\rtfsp | |
| 44 | \param{wxString* }{files = NULL}} | |
| 45 | ||
| 46 | Constructor. | |
| 47 | ||
| b236c10f | 48 | \membersection{wxDropFilesEvent::m\_files}\label{wxdropfileseventmfiles} |
| a660d684 KB |
49 | |
| 50 | \member{wxString*}{m\_files} | |
| 51 | ||
| 52 | An array of filenames. | |
| 53 | ||
| b236c10f | 54 | \membersection{wxDropFilesEvent::m\_noFiles}\label{wxdropfileseventmnofiles} |
| a660d684 KB |
55 | |
| 56 | \member{int}{m\_noFiles} | |
| 57 | ||
| 58 | The number of files dropped. | |
| 59 | ||
| b236c10f | 60 | \membersection{wxDropFilesEvent::m\_pos}\label{wxdropfileseventmpos} |
| a660d684 KB |
61 | |
| 62 | \member{wxPoint}{m\_pos} | |
| 63 | ||
| 64 | The point at which the drop took place. | |
| 65 | ||
| 66 | \membersection{wxDropFilesEvent::GetFiles}\label{wxdropfileseventgetfiles} | |
| 67 | ||
| 68 | \constfunc{wxString*}{GetFiles}{\void} | |
| 69 | ||
| 70 | Returns an array of filenames. | |
| 71 | ||
| 72 | \membersection{wxDropFilesEvent::GetNumberOfFiles}\label{wxdropfileseventgetnumberoffiles} | |
| 73 | ||
| 74 | \constfunc{int}{GetNumberOfFiles}{\void} | |
| 75 | ||
| 76 | Returns the number of files dropped. | |
| 77 | ||
| 78 | \membersection{wxDropFilesEvent::GetPosition}\label{wxdropfileseventgetposition} | |
| 79 | ||
| 80 | \constfunc{wxPoint}{GetPosition}{\void} | |
| 81 | ||
| 82 | Returns the position at which the files were dropped. | |
| 83 | ||
| 84 | Returns an array of filenames. | |
| 85 | ||
| 86 |