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

\section{\class{wxTextDropTarget}}\label{wxtextdroptarget}

A predefined drop target for dealing with text data.

\wxheading{Derived from}

\helpref{wxDropTarget}{wxdroptarget}

\wxheading{Include files}

<wx/dnd.h>

\wxheading{See also}

\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropSource}{wxdropsource}, 
\helpref{wxDropTarget}{wxdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget}

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

\membersection{wxTextDropTarget::wxTextDropTarget}\label{wxtextdroptargetwxtextdroptarget}

\func{}{wxTextDropTarget}{\void}

Constructor.

\membersection{wxTextDropTarget::OnDrop}\label{wxtextdroptargetondrop}

\func{virtual bool}{OnDrop}{\param{long }{x}, \param{long }{y}, \param{const void }{*data}, \param{size\_t }{size}}

See \helpref{wxDropTarget::OnDrop}{wxdroptargetondrop}. This function is implemented
appropriately for text, and calls \helpref{wxTextDropTarget::OnDropText}{wxtextdroptargetondroptext}.

\membersection{wxTextDropTarget::OnDropText}\label{wxtextdroptargetondroptext}

\func{virtual bool}{OnDropText}{\param{wxCoord }{x}, \param{wxCoord }{y}, \param{const wxString\&}{ data}}

Override this function to receive dropped text.

\wxheading{Parameters}

\docparam{x}{The x coordinate of the mouse.}

\docparam{y}{The y coordinate of the mouse.}

\docparam{data}{The data being dropped: a wxString.}

\wxheading{Return value}

Return true to accept the data, false to veto the operation.
Commit	Line	Data
dface61c JS	1	\section{\class{wxTextDropTarget}}\label{wxtextdroptarget}
	2
	3	A predefined drop target for dealing with text data.
	4
	5	\wxheading{Derived from}
	6
	7	\helpref{wxDropTarget}{wxdroptarget}
	8
954b8ae6 JS	9	\wxheading{Include files}
	10
	11	<wx/dnd.h>
	12
dface61c JS	13	\wxheading{See also}
	14
	15	\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropSource}{wxdropsource},
	16	\helpref{wxDropTarget}{wxdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget}
	17
	18	\latexignore{\rtfignore{\wxheading{Members}}}
	19
	20	\membersection{wxTextDropTarget::wxTextDropTarget}\label{wxtextdroptargetwxtextdroptarget}
	21
	22	\func{}{wxTextDropTarget}{\void}
	23
	24	Constructor.
	25
dface61c JS	26	\membersection{wxTextDropTarget::OnDrop}\label{wxtextdroptargetondrop}
	27
	28	\func{virtual bool}{OnDrop}{\param{long }{x}, \param{long }{y}, \param{const void }{*data}, \param{size\_t }{size}}
	29
	30	See \helpref{wxDropTarget::OnDrop}{wxdroptargetondrop}. This function is implemented
	31	appropriately for text, and calls \helpref{wxTextDropTarget::OnDropText}{wxtextdroptargetondroptext}.
	32
	33	\membersection{wxTextDropTarget::OnDropText}\label{wxtextdroptargetondroptext}
	34
01a01d10	35	\func{virtual bool}{OnDropText}{\param{wxCoord }{x}, \param{wxCoord }{y}, \param{const wxString\&}{ data}}
dface61c JS	36
	37	Override this function to receive dropped text.
	38
	39	\wxheading{Parameters}
	40
	41	\docparam{x}{The x coordinate of the mouse.}
	42
	43	\docparam{y}{The y coordinate of the mouse.}
	44
01a01d10	45	\docparam{data}{The data being dropped: a wxString.}
dface61c JS	46
	47	\wxheading{Return value}
	48
cc81d32f	49	Return true to accept the data, false to veto the operation.
b82827dd	50