]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/droptrgt.tex
Fixed ctor declaration : some default were missing
[wxWidgets.git] / docs / latex / wx / droptrgt.tex
... / ...
CommitLineData
1\section{\class{wxDropTarget}}\label{wxdroptarget}
2
3\overview{Overview}{wxdndoverview}
4
5This class represents a target for a drag and drop operation.
6
7\wxheading{Derived from}
8
9\helpref{wxObject}{wxobject}
10
11\wxheading{Include files}
12
13<wx/dnd.h>
14
15\wxheading{See also}
16
17\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropSource}{wxdropsource},
18\helpref{wxTextDropTarget}{wxtextdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget}
19
20\latexignore{\rtfignore{\wxheading{Members}}}
21
22\membersection{wxDropTarget::wxDropTarget}\label{wxdroptargetwxdroptarget}
23
24\func{}{wxDropTarget}{\void}
25
26Constructor.
27
28\membersection{wxDropTarget::\destruct{wxDropTarget}}\label{wxdroptargetdtor}
29
30\func{}{\destruct{wxDropTarget}}{\void}
31
32Destructor.
33
34\membersection{wxDropTarget::GetFormatCount}\label{wxdroptargetgetformatcount}
35
36\constfunc{virtual size\_t}{GetFormatCount}{\void}
37
38Override this to indicate how many formats you support.
39
40\membersection{wxDropTarget::GetFormat}\label{wxdroptargetgetformat}
41
42\constfunc{virtual wxDataFormat}{GetFormat}{\param{size\_t }{n}}
43
44Override this to indicate what kind of data you support.
45
46\membersection{wxDropTarget::OnEnter}\label{wxdroptargetonenter}
47
48\func{virtual void}{OnEnter}{\void}
49
50Called when the mouse enters the drop target.
51
52\membersection{wxDropTarget::OnDrop}\label{wxdroptargetondrop}
53
54\func{virtual bool}{OnDrop}{\param{long }{x}, \param{long }{y}, \param{const void* }{data}, \param{size\_t }{size}}
55
56Called when the user drops a data object on the target. Return FALSE to veto the operation.
57
58\wxheading{Parameters}
59
60\docparam{x}{The x coordinate of the mouse.}
61
62\docparam{y}{The y coordinate of the mouse.}
63
64\docparam{data}{The data being dropped.}
65
66\docparam{size}{The size of the data being dropped.}
67
68\wxheading{Return value}
69
70Return TRUE to accept the data, FALSE to veto the operation.
71
72\membersection{wxDropTarget::OnLeave}\label{wxdroptargetonleave}
73
74\func{virtual void}{OnLeave}{\void}
75
76Called when the mouse leaves the drop target.
77