Some doc fixes

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

diff --git a/docs/latex/wx/tdnd.tex b/docs/latex/wx/tdnd.tex
index cbd0d8ea5aba5c6f3bb0bc7153b95b98fbbbc8f7..ecdb4cf770cb45f389f1b3b6721ed403163226fb 100644 (file)
--- a/docs/latex/wx/tdnd.tex
+++ b/docs/latex/wx/tdnd.tex
@@ -1,17 +1,24 @@
 \section{Drag-and-drop and clipboard overview}\label{wxdndoverview}
 
-Classes: \helpref{wxDataObject}{wxdataobject}
-
-% \helpref{wxTextDataObject}{wxtextdataobject}
-% \helpref{wxDropSource}{wxdropsource}
-% \helpref{wxDropTarget}{wxdroptarget}
-% \helpref{wxTextDropTarget}{wxtextdroptarget}
-% \helpref{wxFileDropTarget}{wxfiledroptarget}
-
-Samples: see the dnd sample.
-
-Headers: <wx/dataobj.h>, <wx/dropsrc.h and <wx/droptgt.h>>
-(note that wxUSE\_DRAG\_AND\_DROP must be defined in setup.h)
+Classes: \helpref{wxDataObject}{wxdataobject}, 
+\helpref{wxTextDataObject}{wxtextdataobject}, 
+\helpref{wxDropSource}{wxdropsource}, 
+\helpref{wxDropTarget}{wxdroptarget}, 
+\helpref{wxTextDropTarget}{wxtextdroptarget}, 
+\helpref{wxFileDropTarget}{wxfiledroptarget}
+
+It has to be noted that the API for drag and drop in wxWindows is not
+yet finished which is mostly due to the fact that DnD support under
+GTK 1.0 is very rudimentary and entirely different from the XDnD
+protocoll used by GTK 1.2. This also entails that not all of the documentation
+concerning DnD might be correct and some of the code might get broken
+in the future. The next release of wxWindows will be based on GTK 1.2
+and will hopefully include a much improved DnD support. The general
+design on the wxDropSource side will be the same but especially the
+wxDropTarget is almost certain to change.
+
+Note that wxUSE\_DRAG\_AND\_DROP must be defined in setup.h in order
+to use Drag'n'Drop in wxWindows.
 
 This overview describes wxWindows support for drag and drop and clipboard
 operations. Both of these topics are discussed here because, in fact, they're
@@ -35,35 +42,27 @@ user elsewhere, you should implement the following steps:
 initialized with the data you wish to drag. For example:
 
 \begin{verbatim}
-       wxTextDataObject data("This string will be dragged.");
+       wxDataObject *my_data = new wxTextDataObject data("This string will be dragged.");
 \end{verbatim}
 
-Of course, the data object may contain arbitrary data of any type, but for
-this you should derive your own class from \helpref{wxDataObject}{wxdataobject} overriding all of its pure virtual
-functions.
-
 \item{\bf Drag start:} To start dragging process (typically in response to a
 mouse click) you must call \helpref{DoDragDrop}{wxdropsourcedodragdrop} function
 of wxDropSource object which should be constructed like this:
 
 \begin{verbatim}
-       wxDropSource dragSource(data, this);
-
-       // or also:
-
-       wxDropSource dragSource(this);
-       dragSource.SetData(data);
+       wxDropSource dragSource( this );
+       dragSource.SetData( my_data );
 \end{verbatim}
 
 \item {\bf Dragging:} The call to DoDragDrop() blocks until the user release the
 mouse button (unless you override \helpref{GiveFeedback}{wxdropsourcegivefeedback} function
 to do something special). When the mouse moves in a window of a program which understands the
-same drag-and-drop protocol (any program under Windows or any program supporting XDnD protocol
-under X Windows), the corresponding \helpref{wxDropTarget}{wxdroptarget} methods
+same drag-and-drop protocol (any program under Windows or any program supporting GTK 1.0
+DnD protocol under X Windows), the corresponding \helpref{wxDropTarget}{wxdroptarget} methods
 are called - see below.
 
 \item {\bf Processing the result:} DoDragDrop() returns an {\it effect code} which
-is one of the values of \helpref{wxDragResult}{wxdragresult} enum. Codes
+is one of the values of \helpref{wxDragResult}{wxdropsource} enum. Codes
 of wxDragError, wxDragNone and wxDragCancel have the obvious meaning and mean
 that there is nothing to do on the sending end (except of possibly logging the
 error in the first case). wxDragCopy means that the data has been successfully
@@ -79,7 +78,7 @@ follow the instructions below:
 \begin{itemize}\itemsep=0pt
 \item {\bf Initialization:} For a window to be drop target, it needs to have
 an associated \helpref{wxDropTarget}{wxdroptarget} object. Normally, you will
-call wxWindow::\helpref{SetDropTarget}{wxwindowsetdroptarget} during window
+call \helpref{wxWindow::SetDropTarget}{wxwindowsetdroptarget} during window
 creation associating you drop target with it. You must derive a class from
 wxDropTarget and override its pure virtual methods. Alternatively, you may
 derive from \helpref{wxTextDropTarget}{wxtextdroptarget} or
@@ -92,7 +91,7 @@ this, \helpref{GetFormatCount}{wxdroptargetgetformatcount} and \helpref{GetForma
 used and if the format is
 supported (i.e. is one of returned by GetFormat()), 
 then \helpref{OnDrop}{wxdroptargetondrop} is called. 
-Otherwise, \helpref{wxDragNone}{stdformat} is returned by DoDragDrop() and
+Otherwise, wxDragNone is returned by DoDragDrop() and
 nothing happens.
 
 \item {\bf The end:} After processing the data, DoDragDrop() returns either