]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/dropevt.tex
Added wxRect::Intersect() documentation (patch 1868322 from Laurent Humbertclaude).
[wxWidgets.git] / docs / latex / wx / dropevt.tex
... / ...
CommitLineData
1\section{\class{wxDropFilesEvent}}\label{wxdropfilesevent}
2
3This class is used for drop files events, that is, when files have been dropped
4onto the window. This functionality is currently only available under Windows.
5The window must have previously been enabled for dropping by calling
6\helpref{wxWindow::DragAcceptFiles}{wxwindowdragacceptfiles}.
7
8Important note: this is a separate implementation to the more general
9drag and drop implementation documented \helpref{here}{wxdndoverview}. It uses the
10older, Windows message-based approach of dropping files.
11
12\wxheading{Derived from}
13
14\helpref{wxEvent}{wxevent}\\
15\helpref{wxObject}{wxobject}
16
17\wxheading{Include files}
18
19<wx/event.h>
20
21\wxheading{Library}
22
23\helpref{wxCore}{librarieslist}
24
25\wxheading{Event table macros}
26
27To process a drop files event, use these event handler macros to direct input to a member
28function 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
37\helpref{Event handling overview}{eventhandlingoverview}
38
39\latexignore{\rtfignore{\wxheading{Members}}}
40
41\membersection{wxDropFilesEvent::wxDropFilesEvent}\label{wxdropfileseventctor}
42
43\func{}{wxDropFilesEvent}{\param{WXTYPE }{id = 0}, \param{int }{noFiles = 0},\rtfsp
44\param{wxString* }{files = NULL}}
45
46Constructor.
47
48\membersection{wxDropFilesEvent::m\_files}\label{wxdropfileseventmfiles}
49
50\member{wxString*}{m\_files}
51
52An array of filenames.
53
54\membersection{wxDropFilesEvent::m\_noFiles}\label{wxdropfileseventmnofiles}
55
56\member{int}{m\_noFiles}
57
58The number of files dropped.
59
60\membersection{wxDropFilesEvent::m\_pos}\label{wxdropfileseventmpos}
61
62\member{wxPoint}{m\_pos}
63
64The point at which the drop took place.
65
66\membersection{wxDropFilesEvent::GetFiles}\label{wxdropfileseventgetfiles}
67
68\constfunc{wxString*}{GetFiles}{\void}
69
70Returns an array of filenames.
71
72\membersection{wxDropFilesEvent::GetNumberOfFiles}\label{wxdropfileseventgetnumberoffiles}
73
74\constfunc{int}{GetNumberOfFiles}{\void}
75
76Returns the number of files dropped.
77
78\membersection{wxDropFilesEvent::GetPosition}\label{wxdropfileseventgetposition}
79
80\constfunc{wxPoint}{GetPosition}{\void}
81
82Returns the position at which the files were dropped.
83
84Returns an array of filenames.
85
86