]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/droptrgt.tex
added and documented wxDEFINE_SCOPED_PTR_TYPE; improved docs a bit
[wxWidgets.git] / docs / latex / wx / droptrgt.tex
index db5b38d78a45beb96f64b12d279c2b9bd6d297c3..413dae6f1b1796d115e46d362680fdc4711910fd 100644 (file)
@@ -1,7 +1,5 @@
 \section{\class{wxDropTarget}}\label{wxdroptarget}
 
 \section{\class{wxDropTarget}}\label{wxdroptarget}
 
-\overview{Overview}{wxdndoverview}
-
 This class represents a target for a drag and drop operation. A \helpref{wxDataObject}{wxdataobject}
 can be associated with it and by default, this object will be filled with the data from the
 drag source, if the data formats supported by the data object match the drag source data 
 This class represents a target for a drag and drop operation. A \helpref{wxDataObject}{wxdataobject}
 can be associated with it and by default, this object will be filled with the data from the
 drag source, if the data formats supported by the data object match the drag source data 
@@ -13,6 +11,9 @@ the whole window area, but only a small portion of it. The normal sequence of ca
 \helpref{OnEnter}{wxdroptargetonenter}, possibly many times \helpref{OnDragOver}{wxdroptargetondragover},
 \helpref{OnDrop}{wxdroptargetondrop} and finally \helpref{OnData}{wxdroptargetondata}.
 
 \helpref{OnEnter}{wxdroptargetonenter}, possibly many times \helpref{OnDragOver}{wxdroptargetondragover},
 \helpref{OnDrop}{wxdroptargetondrop} and finally \helpref{OnData}{wxdroptargetondata}.
 
+See \helpref{Drag and drop overview}{wxdndoverview} and \helpref{wxDataObject overview}{wxdataobjectoverview}
+for more information.
+
 \wxheading{Derived from}
 
 None
 \wxheading{Derived from}
 
 None
@@ -25,7 +26,7 @@ None
 
 \index{wxDragResult}wxDragResult is defined as follows:
 
 
 \index{wxDragResult}wxDragResult is defined as follows:
 
-{\small\begin{verbatim}
+\begin{verbatim}
 enum wxDragResult
 {
     wxDragError,    // error prevented the d&d operation from completing
 enum wxDragResult
 {
     wxDragError,    // error prevented the d&d operation from completing
@@ -35,11 +36,10 @@ enum wxDragResult
     wxDragCancel    // the operation was cancelled by user (not an error)
 };
 \end{verbatim}
     wxDragCancel    // the operation was cancelled by user (not an error)
 };
 \end{verbatim}
-}
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 
-\helpref{Drag and drop overview}{wxdndoverview}, \helpref{wxDropSource}{wxdropsource}, 
+\helpref{wxDropSource}{wxdropsource}, 
 \helpref{wxTextDropTarget}{wxtextdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget},
 \helpref{wxDataFormat}{wxdataformat}, \helpref{wxDataObject}{wxdataobject}
 
 \helpref{wxTextDropTarget}{wxtextdroptarget}, \helpref{wxFileDropTarget}{wxfiledroptarget},
 \helpref{wxDataFormat}{wxdataformat}, \helpref{wxDataObject}{wxdataobject}
 
@@ -70,7 +70,7 @@ calling its \helpref{wxDataObject::SetData}{wxdataobjectsetdata} method.
 
 \func{virtual wxDragResult}{OnData}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxDragResult}{ def}}
 
 
 \func{virtual wxDragResult}{OnData}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxDragResult}{ def}}
 
-Called after \helpref{OnDrop}{wxdroptargetondrop} returns TRUE. By default this
+Called after \helpref{OnDrop}{wxdroptargetondrop} returns true. By default this
 will usually \helpref{GetData}{wxdroptargetgetdata} and will return the suggested
 default value {\it def}.
 
 will usually \helpref{GetData}{wxdroptargetgetdata} and will return the suggested
 default value {\it def}.
 
@@ -78,7 +78,7 @@ default value {\it def}.
 
 \func{virtual bool}{OnDrop}{\param{wxCoord }{x}, \param{wxCoord }{y}}
 
 
 \func{virtual bool}{OnDrop}{\param{wxCoord }{x}, \param{wxCoord }{y}}
 
-Called when the user drops a data object on the target. Return FALSE to veto the operation.
+Called when the user drops a data object on the target. Return false to veto the operation.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 
@@ -88,7 +88,7 @@ Called when the user drops a data object on the target. Return FALSE to veto the
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 
-Return TRUE to accept the data, FALSE to veto the operation.
+Return true to accept the data, false to veto the operation.
 
 \membersection{wxDropTarget::OnEnter}\label{wxdroptargetonenter}
 
 
 \membersection{wxDropTarget::OnEnter}\label{wxdroptargetonenter}
 
@@ -141,3 +141,4 @@ Called when the mouse leaves the drop target.
 
 Sets the data \helpref{wxDataObject}{wxdataobject} associated with the 
 drop target and deletes any previously associated data object.
 
 Sets the data \helpref{wxDataObject}{wxdataobject} associated with the 
 drop target and deletes any previously associated data object.
+