[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{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::GetFormatCount}\label{wxtextdroptargetgetformatcount}

\constfunc{virtual size\_t}{GetFormatCount}{\void}

See \helpref{wxDropTarget::GetFormatCount}{wxdroptargetgetformatcount}. This function is implemented
appropriately for text.

\membersection{wxTextDropTarget::GetFormat}\label{wxtextdroptargetgetformat}

\constfunc{virtual wxDataFormat}{GetFormat}{\param{size\_t }{n}}

See \helpref{wxDropTarget::GetFormat}{wxdroptargetgetformat}. This function is implemented
appropriately for text.

\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{long }{x}, \param{long }{y}, \param{const char }{*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 NULL-terminated string.}

\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
	9	\wxheading{See also}
	10
	11	\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropSource}{wxdropsource},
	12	\helpref{wxDropTarget}{wxdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget}
	13
	14	\latexignore{\rtfignore{\wxheading{Members}}}
	15
	16	\membersection{wxTextDropTarget::wxTextDropTarget}\label{wxtextdroptargetwxtextdroptarget}
	17
	18	\func{}{wxTextDropTarget}{\void}
	19
	20	Constructor.
	21
	22	\membersection{wxTextDropTarget::GetFormatCount}\label{wxtextdroptargetgetformatcount}
	23
	24	\constfunc{virtual size\_t}{GetFormatCount}{\void}
	25
	26	See \helpref{wxDropTarget::GetFormatCount}{wxdroptargetgetformatcount}. This function is implemented
	27	appropriately for text.
	28
	29	\membersection{wxTextDropTarget::GetFormat}\label{wxtextdroptargetgetformat}
	30
	31	\constfunc{virtual wxDataFormat}{GetFormat}{\param{size\_t }{n}}
	32
	33	See \helpref{wxDropTarget::GetFormat}{wxdroptargetgetformat}. This function is implemented
	34	appropriately for text.
	35
	36	\membersection{wxTextDropTarget::OnDrop}\label{wxtextdroptargetondrop}
	37
	38	\func{virtual bool}{OnDrop}{\param{long }{x}, \param{long }{y}, \param{const void }{*data}, \param{size\_t }{size}}
	39
	40	See \helpref{wxDropTarget::OnDrop}{wxdroptargetondrop}. This function is implemented
	41	appropriately for text, and calls \helpref{wxTextDropTarget::OnDropText}{wxtextdroptargetondroptext}.
	42
	43	\membersection{wxTextDropTarget::OnDropText}\label{wxtextdroptargetondroptext}
	44
	45	\func{virtual bool}{OnDropText}{\param{long }{x}, \param{long }{y}, \param{const char }{*data}}
	46
	47	Override this function to receive dropped text.
	48
	49	\wxheading{Parameters}
	50
	51	\docparam{x}{The x coordinate of the mouse.}
	52
	53	\docparam{y}{The y coordinate of the mouse.}
	54
	55	\docparam{data}{The data being dropped: a NULL-terminated string.}
	56
	57	\wxheading{Return value}
	58
	59	Return TRUE to accept the data, FALSE to veto the operation.
b82827dd	60