]> git.saurik.com Git - wxWidgets.git/commitdiff
Explicitly document wxDrag_XXX flags.
authorVadim Zeitlin <vadim@wxwidgets.org>
Sun, 29 Apr 2012 23:22:18 +0000 (23:22 +0000)
committerVadim Zeitlin <vadim@wxwidgets.org>
Sun, 29 Apr 2012 23:22:18 +0000 (23:22 +0000)
They were mentioned in DoDragDrop() documentation but not documented on their
own. Do it now to be able to refer to them from elsewhere.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71322 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/dnd.h

index fef09feb989e5c9b85238bfb7bc90622f1e4ec46..44bfbc2944aa353138a901a1658f83d3e57d48c7 100644 (file)
@@ -6,6 +6,16 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+/**
+    Possible flags for drag and drop operations.
+ */
+enum
+{
+    wxDrag_CopyOnly    = 0, ///< Allow only copying.
+    wxDrag_AllowMove   = 1, ///< Allow moving too (copying is always allowed).
+    wxDrag_DefaultMove = 3  ///< Allow moving and make it default operation.
+};
+
 /**
     @class wxTextDropTarget
 
@@ -286,10 +296,11 @@ public:
         example.
 
         @param flags
-            If wxDrag_AllowMove is included in the flags, data may be moved and
-            not only copied (default). If wxDrag_DefaultMove is specified
-            (which includes the previous flag), this is even the default
-            operation.
+            If ::wxDrag_AllowMove is included in the flags, data may be moved
+            and not only copied as is the case for the default
+            ::wxDrag_CopyOnly. If ::wxDrag_DefaultMove is specified
+            (which includes the previous flag), moving is not only possible but
+            becomes the default operation.
 
         @return The operation requested by the user, may be ::wxDragCopy,
                  ::wxDragMove, ::wxDragLink, ::wxDragCancel or ::wxDragNone if