]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/fildrptg.tex
Minor doc updates
[wxWidgets.git] / 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{Library}
15
16 \helpref{wxCore}{librarieslist}
17
18 \wxheading{See also}
19
20 \helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropSource}{wxdropsource},
21 \helpref{wxDropTarget}{wxdroptarget}, \helpref{wxTextDropTarget}{wxtextdroptarget}
22
23 \latexignore{\rtfignore{\wxheading{Members}}}
24
25 \membersection{wxFileDropTarget::wxFileDropTarget}\label{wxfiledroptargetwxfiledroptarget}
26
27 \func{}{wxFileDropTarget}{\void}
28
29 Constructor.
30
31 \membersection{wxFileDropTarget::OnDrop}\label{wxfiledroptargetondrop}
32
33 \func{virtual bool}{OnDrop}{\param{long }{x}, \param{long }{y}, \param{const void }{*data}, \param{size\_t }{size}}
34
35 See \helpref{wxDropTarget::OnDrop}{wxdroptargetondrop}. This function is implemented
36 appropriately for files, and calls \helpref{wxFileDropTarget::OnDropFiles}{wxfiledroptargetondropfiles}.
37
38 \membersection{wxFileDropTarget::OnDropFiles}\label{wxfiledroptargetondropfiles}
39
40 \func{virtual bool}{OnDropFiles}{\param{wxCoord }{x}, \param{wxCoord }{y}, \param{const wxArrayString\& }{filenames}}
41
42 Override this function to receive dropped files.
43
44 \wxheading{Parameters}
45
46 \docparam{x}{The x coordinate of the mouse.}
47
48 \docparam{y}{The y coordinate of the mouse.}
49
50 \docparam{filenames}{An array of filenames.}
51
52 \wxheading{Return value}
53
54 Return true to accept the data, false to veto the operation.
55
56 % VZ: this clarification is probably not needed any longer?
57 %\perlnote{In wxPerl there is just an array reference in place of {\tt nFiles}
58 %and {\tt files}.}
59