[wxWidgets.git] / docs / latex / wx / dropevt.tex

\section{\class{wxDropFilesEvent}}\label{wxdropfilesevent}

This class is used for drop files events, that is, when files have been dropped
onto the window. This functionality is currently only available under Windows.

\wxheading{Derived from}

\helpref{wxEvent}{wxevent}\\
\helpref{wxObject}{wxobject}

\wxheading{Event table macros}

To process a drop files event, use these event handler macros to direct input to a member
function that takes a wxDropFilesEvent argument.

\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_DROP\_FILES(func)}}{Process a wxEVT\_DROP\_FILES event.}
\end{twocollist}%

\wxheading{See also}

\helpref{wxWindow::OnDropFiles}{wxwindowondropfiles}, \helpref{Event handling overview}{eventhandlingoverview}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxDropFilesEvent::wxDropFilesEvent}

\func{}{wxDropFilesEvent}{\param{WXTYPE }{id = 0}, \param{int }{noFiles = 0},\rtfsp
\param{wxString* }{files = NULL}}

Constructor.

\membersection{wxDropFilesEvent::m\_files}

\member{wxString*}{m\_files}

An array of filenames.

\membersection{wxDropFilesEvent::m\_noFiles}

\member{int}{m\_noFiles}

The number of files dropped.

\membersection{wxDropFilesEvent::m\_pos}

\member{wxPoint}{m\_pos}

The point at which the drop took place.

\membersection{wxDropFilesEvent::GetFiles}\label{wxdropfileseventgetfiles}

\constfunc{wxString*}{GetFiles}{\void}

Returns an array of filenames.

\membersection{wxDropFilesEvent::GetNumberOfFiles}\label{wxdropfileseventgetnumberoffiles}

\constfunc{int}{GetNumberOfFiles}{\void}

Returns the number of files dropped.

\membersection{wxDropFilesEvent::GetPosition}\label{wxdropfileseventgetposition}

\constfunc{wxPoint}{GetPosition}{\void}

Returns the position at which the files were dropped.

Returns an array of filenames.
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.
	5
	6	\wxheading{Derived from}
	7
	8	\helpref{wxEvent}{wxevent}\\
	9	\helpref{wxObject}{wxobject}
	10
	11	\wxheading{Event table macros}
	12
	13	To process a drop files event, use these event handler macros to direct input to a member
	14	function that takes a wxDropFilesEvent argument.
	15
	16	\twocolwidtha{7cm}
	17	\begin{twocollist}\itemsep=0pt
	18	\twocolitem{{\bf EVT\_DROP\_FILES(func)}}{Process a wxEVT\_DROP\_FILES event.}
	19	\end{twocollist}%
	20
	21	\wxheading{See also}
	22
	23	\helpref{wxWindow::OnDropFiles}{wxwindowondropfiles}, \helpref{Event handling overview}{eventhandlingoverview}
	24
	25	\latexignore{\rtfignore{\wxheading{Members}}}
	26
	27	\membersection{wxDropFilesEvent::wxDropFilesEvent}
	28
	29	\func{}{wxDropFilesEvent}{\param{WXTYPE }{id = 0}, \param{int }{noFiles = 0},\rtfsp
	30	\param{wxString* }{files = NULL}}
	31
	32	Constructor.
	33
	34	\membersection{wxDropFilesEvent::m\_files}
	35
	36	\member{wxString*}{m\_files}
	37
	38	An array of filenames.
	39
	40	\membersection{wxDropFilesEvent::m\_noFiles}
	41
	42	\member{int}{m\_noFiles}
	43
	44	The number of files dropped.
	45
	46	\membersection{wxDropFilesEvent::m\_pos}
	47
	48	\member{wxPoint}{m\_pos}
	49
	50	The point at which the drop took place.
	51
	52	\membersection{wxDropFilesEvent::GetFiles}\label{wxdropfileseventgetfiles}
	53
	54	\constfunc{wxString*}{GetFiles}{\void}
	55
	56	Returns an array of filenames.
	57
	58	\membersection{wxDropFilesEvent::GetNumberOfFiles}\label{wxdropfileseventgetnumberoffiles}
	59
	60	\constfunc{int}{GetNumberOfFiles}{\void}
	61
	62	Returns the number of files dropped.
	63
	64	\membersection{wxDropFilesEvent::GetPosition}\label{wxdropfileseventgetposition}
65
66	\constfunc{wxPoint}{GetPosition}{\void}
67
68	Returns the position at which the files were dropped.
69
70	Returns an array of filenames.
71
72