]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/fildrptg.tex
Corrected event.h for wxKeyEvent/wxMouseEvent, and corresponding docs
[wxWidgets.git] / docs / latex / wx / fildrptg.tex
... / ...
CommitLineData
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
24Constructor.
25
26\membersection{wxFileDropTarget::GetFormatCount}\label{wxfiledroptargetgetformatcount}
27
28\func{virtual size\_t}{GetFormatCount}{\void}
29
30See \helpref{wxDropTarget::GetFormatCount}{wxdroptargetgetformatcount}. This function is implemented
31appropriately for files.
32
33\membersection{wxFileDropTarget::GetFormat}\label{wxfiledroptargetgetformat}
34
35\constfunc{virtual wxDataFormat}{GetFormat}{\param{size\_t }{n}}
36
37See \helpref{wxDropTarget::GetFormat}{wxdroptargetgetformat}. This function is implemented
38appropriately for files.
39
40\membersection{wxFileDropTarget::OnDrop}\label{wxfiledroptargetondrop}
41
42\func{virtual bool}{OnDrop}{\param{long }{x}, \param{long }{y}, \param{const void }{*data}, \param{size\_t }{size}}
43
44See \helpref{wxDropTarget::OnDrop}{wxdroptargetondrop}. This function is implemented
45appropriately for files, and calls \helpref{wxFileDropTarget::OnDropFiles}{wxfiledroptargetondropfiles}.
46
47\membersection{wxFileDropTarget::OnDropFiles}\label{wxfiledroptargetondropfiles}
48
49\func{virtual bool}{OnDropFiles}{\param{long }{x}, \param{long }{y}, \param{size\_t }{nFiles}, \param{const char * const}{files[]}}
50
51Override this function to receive dropped files.
52
53\wxheading{Parameters}
54
55\docparam{x}{The x coordinate of the mouse.}
56
57\docparam{y}{The y coordinate of the mouse.}
58
59\docparam{nFiles}{The number of files being dropped.}
60
61\docparam{files}{An array of filenames.}
62
63\wxheading{Return value}
64
65Return TRUE to accept the data, FALSE to veto the operation.
66