git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	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	The window must have previously been enabled for dropping by calling
	6	\helpref{wxWindow::DragAcceptFiles}{wxwindowdragacceptfiles}.
	7
	8	Important note: this is a separate implementation to the more general
	9	drag and drop implementation documented \helpref{here}{wxdndoverview}. It uses the
	10	older, 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{Event table macros}
	22
	23	To process a drop files event, use these event handler macros to direct input to a member
	24	function that takes a wxDropFilesEvent argument.
	25
	26	\twocolwidtha{7cm}
	27	\begin{twocollist}\itemsep=0pt
	28	\twocolitem{{\bf EVT\_DROP\_FILES(func)}}{Process a wxEVT\_DROP\_FILES event.}
	29	\end{twocollist}%
	30
	31	\wxheading{See also}
	32
	33	\helpref{Event handling overview}{eventhandlingoverview}
	34
	35	\latexignore{\rtfignore{\wxheading{Members}}}
	36
	37	\membersection{wxDropFilesEvent::wxDropFilesEvent}\label{wxdropfileseventctor}
	38
	39	\func{}{wxDropFilesEvent}{\param{WXTYPE }{id = 0}, \param{int }{noFiles = 0},\rtfsp
	40	\param{wxString* }{files = NULL}}
	41
	42	Constructor.
	43
	44	\membersection{wxDropFilesEvent::m\_files}\label{wxdropfileseventmfiles}
	45
	46	\member{wxString*}{m\_files}
	47
	48	An array of filenames.
	49
	50	\membersection{wxDropFilesEvent::m\_noFiles}\label{wxdropfileseventmnofiles}
	51
	52	\member{int}{m\_noFiles}
	53
	54	The number of files dropped.
	55
	56	\membersection{wxDropFilesEvent::m\_pos}\label{wxdropfileseventmpos}
	57
	58	\member{wxPoint}{m\_pos}
	59
	60	The point at which the drop took place.
	61
	62	\membersection{wxDropFilesEvent::GetFiles}\label{wxdropfileseventgetfiles}
	63
	64	\constfunc{wxString*}{GetFiles}{\void}
	65
	66	Returns an array of filenames.
	67
	68	\membersection{wxDropFilesEvent::GetNumberOfFiles}\label{wxdropfileseventgetnumberoffiles}
	69
	70	\constfunc{int}{GetNumberOfFiles}{\void}
	71
	72	Returns the number of files dropped.
	73
	74	\membersection{wxDropFilesEvent::GetPosition}\label{wxdropfileseventgetposition}
	75
	76	\constfunc{wxPoint}{GetPosition}{\void}
	77
	78	Returns the position at which the files were dropped.
	79
	80	Returns an array of filenames.
	81
	82