]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/dropsrc.tex
Use const
[wxWidgets.git] / docs / latex / wx / dropsrc.tex
... / ...
CommitLineData
1\section{\class{wxDropSource}}\label{wxdropsource}
2
3This class represents a source for a drag and drop operation.
4
5See \helpref{Drag and drop overview}{wxdndoverview} and \helpref{wxDataObject overview}{wxdataobjectoverview}
6for more information.
7
8\wxheading{Derived from}
9
10None
11
12\wxheading{Include files}
13
14<wx/dnd.h>
15
16\wxheading{Library}
17
18\helpref{wxCore}{librarieslist}
19
20\wxheading{Types}
21
22\index{wxDragResult}wxDragResult is defined as follows:
23
24\begin{verbatim}
25enum wxDragResult
26{
27 wxDragError, // error prevented the d&d operation from completing
28 wxDragNone, // drag target didn't accept the data
29 wxDragCopy, // the data was successfully copied
30 wxDragMove, // the data was successfully moved (MSW only)
31 wxDragLink, // operation is a drag-link
32 wxDragCancel // the operation was cancelled by user (not an error)
33};
34\end{verbatim}
35
36\wxheading{See also}
37
38\helpref{wxDropTarget}{wxdroptarget},
39\helpref{wxTextDropTarget}{wxtextdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget}
40
41\latexignore{\rtfignore{\wxheading{Members}}}
42
43\membersection{wxDropSource::wxDropSource}\label{wxdropsourcewxdropsource}
44
45\func{}{wxDropSource}{\param{wxWindow*}{ win = NULL},\param{const wxIconOrCursor\& }{iconCopy = wxNullIconOrCursor}, \param{const wxIconOrCursor\& }{iconMove = wxNullIconOrCursor}, \param{const wxIconOrCursor\& }{iconNone = wxNullIconOrCursor}}
46
47\func{}{wxDropSource}{\param{wxDataObject\&}{ data}, \param{wxWindow*}{ win = NULL},\param{const wxIconOrCursor\& }{iconCopy = wxNullIconOrCursor}, \param{const wxIconOrCursor\& }{iconMove = wxNullIconOrCursor}, \param{const wxIconOrCursor\& }{iconNone = wxNullIconOrCursor}}
48
49The constructors for wxDataObject.
50
51If you use the constructor without {\it data} parameter you must call
52\helpref{SetData}{wxdropsourcesetdata} later.
53
54Note that the exact type of {\it iconCopy} and subsequent parameters differs
55between wxMSW and wxGTK: these are cursors under Windows but icons for GTK.
56You should use the macro \helpref{wxDROP\_ICON}{wxdropicon} in portable
57programs instead of directly using either of these types.
58
59\wxheading{Parameters}
60
61\docparam{win}{The window which initiates the drag and drop operation.}
62
63\docparam{iconCopy}{The icon or cursor used for feedback for copy operation.}
64
65\docparam{iconMove}{The icon or cursor used for feedback for move operation.}
66
67\docparam{iconNone}{The icon or cursor used for feedback when operation can't be done.}
68
69{\it win} is the window which initiates the drag and drop operation.
70
71\membersection{wxDropSource::\destruct{wxDropSource}}\label{wxdropsourcedtor}
72
73\func{virtual }{\destruct{wxDropSource}}{\void}
74
75\membersection{wxDropSource::SetData}\label{wxdropsourcesetdata}
76
77\func{void}{SetData}{\param{wxDataObject\&}{ data}}
78
79Sets the data \helpref{wxDataObject}{wxdataobject} associated with the
80drop source. This will not delete any previously associated data.
81
82\membersection{wxDropSource::DoDragDrop}\label{wxdropsourcedodragdrop}
83
84\func{virtual wxDragResult}{DoDragDrop}{\param{int }{flags = {\tt wxDrag\_CopyOnly}}}
85
86Do it (call this in response to a mouse button press, for example). This starts
87the drag-and-drop operation which will terminate when the user releases the
88mouse.
89
90\wxheading{Parameters}
91
92\docparam{flags}{If {\tt wxDrag\_AllowMove} is included in the flags, data may
93be moved and not only copied (default). If {\tt wxDrag\_DefaultMove} is
94specified (which includes the previous flag), this is even the default
95operation}.
96
97\wxheading{Return value}
98
99Returns the operation requested by the user, may be {\tt wxDragCopy}, {\tt
100wxDragMove}, {\tt wxDragLink}, {\tt wxDragCancel} or {\tt wxDragNone} if an error occurred.
101
102\membersection{wxDropSource::GetDataObject}\label{wxdropsourcegetdataobject}
103
104\func{wxDataObject *}{GetDataObject}{\void}
105
106Returns the wxDataObject object that has been assigned previously.
107
108\membersection{wxDropSource::GiveFeedback}\label{wxdropsourcegivefeedback}
109
110\func{virtual bool}{GiveFeedback}{\param{wxDragResult }{effect}}
111
112Overridable: you may give some custom UI feedback during the drag and drop operation
113in this function. It is called on each mouse move, so your implementation must not be too
114slow.
115
116\wxheading{Parameters}
117
118\docparam{effect}{The effect to implement. One of {\tt wxDragCopy}, {\tt wxDragMove}, {\tt wxDragLink} and {\tt wxDragNone}. }
119
120\docparam{scrolling}{true if the window is scrolling. MSW only. }
121
122\wxheading{Return value}
123
124Return false if you want default feedback, or true if you implement your own
125feedback. The return values is ignored under GTK.
126
127\membersection{wxDropSource::SetCursor}\label{wxdropsourcesetcursor}
128
129\func{void}{SetCursor}{\param{wxDragResult }{res}, \param{const wxCursor\& }{cursor}}
130
131Set the icon to use for a certain drag result.
132
133\wxheading{Parameters}
134
135\docparam{res}{The drag result to set the icon for. }
136
137\docparam{cursor}{The ion to show when this drag result occurs. }
138