]>
Commit | Line | Data |
---|---|---|
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{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{wxTextDropTarget}{wxtextdroptarget} | |
17 | ||
18 | \latexignore{\rtfignore{\wxheading{Members}}} | |
19 | ||
20 | \membersection{wxFileDropTarget::wxFileDropTarget}\label{wxfiledroptargetwxfiledroptarget} | |
21 | ||
22 | \func{}{wxFileDropTarget}{\void} | |
23 | ||
24 | Constructor. | |
25 | ||
26 | \membersection{wxFileDropTarget::OnDrop}\label{wxfiledroptargetondrop} | |
27 | ||
28 | \func{virtual bool}{OnDrop}{\param{long }{x}, \param{long }{y}, \param{const void }{*data}, \param{size\_t }{size}} | |
29 | ||
30 | See \helpref{wxDropTarget::OnDrop}{wxdroptargetondrop}. This function is implemented | |
31 | appropriately for files, and calls \helpref{wxFileDropTarget::OnDropFiles}{wxfiledroptargetondropfiles}. | |
32 | ||
33 | \membersection{wxFileDropTarget::OnDropFiles}\label{wxfiledroptargetondropfiles} | |
34 | ||
35 | \func{virtual bool}{OnDropFiles}{\param{long }{x}, \param{long }{y}, \param{size\_t }{nFiles}, \param{const char * const}{files[]}} | |
36 | ||
37 | Override this function to receive dropped files. | |
38 | ||
39 | \wxheading{Parameters} | |
40 | ||
41 | \docparam{x}{The x coordinate of the mouse.} | |
42 | ||
43 | \docparam{y}{The y coordinate of the mouse.} | |
44 | ||
45 | \docparam{nFiles}{The number of files being dropped.} | |
46 | ||
47 | \docparam{files}{An array of filenames.} | |
48 | ||
49 | \wxheading{Return value} | |
50 | ||
51 | Return TRUE to accept the data, FALSE to veto the operation. | |
52 | ||
53 | \perlnote{In wxPerl there is just an array reference in place of {\tt nFiles} | |
54 | and {\tt files}.} |