Changeset 85681 in vbox for trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxDnD.h

Timestamp:

Aug 11, 2020 9:36:37 AM (4 years ago)

Author:

vboxsync

Message:

DnD: Lots of documentation.

File:

• trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxDnD.h (modified) (9 diffs)

trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxDnD.h

@@ -29 +29 @@
 class VBoxDnDWnd;
 
+/**
+ * Class for implementing IDataObject for VBoxTray's DnD support.
+ */
 class VBoxDnDDataObject : public IDataObject
 {
@@ -80 +83 @@
                         LONG lindex = -1, DWORD dwAspect = DVASPECT_CONTENT, DVTARGETDEVICE *pTargetDevice = NULL);
 
+    /** Current drag and drop status. */
     Status      mStatus;
+    /** Internal reference count of this object. */
     LONG        mRefCount;
+    /** Number of native formats registered. This can be a different number than supplied with m_lstFormats. */
     ULONG       mcFormats;
+    /** Array of registered FORMATETC structs. Matches m_cFormats. */
     LPFORMATETC mpFormatEtc;
+    /** Array of registered STGMEDIUM structs. Matches m_cFormats. */
     LPSTGMEDIUM mpStgMedium;
+    /** Event semaphore used for waiting on status changes. */
     RTSEMEVENT  mEventDropped;
+    /** Format of currently retrieved data. */
     RTCString   mstrFormat;
+    /** The retrieved data as a raw buffer. */
     void       *mpvData;
+    /** Raw buffer size (in bytes). */
     size_t      mcbData;
 };
 
+/**
+ * Class for implementing IDropSource for VBoxTray's DnD support.
+ */
 class VBoxDnDDropSource : public IDropSource
 {
@@ -125 +140 @@
 };
 
+/**
+ * Class for implementing IDropTarget for VBoxTray's DnD support.
+ */
 class VBoxDnDDropTarget : public IDropTarget
 {
@@ -153 +171 @@
 public:
 
+    /** Returns the data as mutable raw. Use with caution! */
     void *DataMutableRaw(void) const { return mpvData; }
+
+    /** Returns the data size (in bytes). */
     size_t DataSize(void) const { return mcbData; }
+
     RTCString Formats(void) const;
     int WaitForDrop(RTMSINTERVAL msTimeout);
@@ -181 +203 @@
 };
 
+/**
+ * Class for implementing IEnumFORMATETC for VBoxTray's DnD support.
+ */
 class VBoxDnDEnumFormatEtc : public IEnumFORMATETC
 {
@@ -206 +231 @@
 private:
 
+    /** Reference count of this object. */
     LONG        m_lRefCount;
+    /** Current index for format iteration. */
     ULONG       m_nIndex;
+    /** Number of format this object contains. */
     ULONG       m_nNumFormats;
+    /** Array of FORMATETC formats this object contains. Matches m_nNumFormats. */
     LPFORMATETC m_pFormatEtc;
 };
@@ -215 +244 @@
 class VBoxDnDWnd;
 
-/*
+/**
  * A drag'n drop event from the host.
  */
@@ -371 +400 @@
      *  window messages. */
     RTTHREAD                   hThread;
+    /** Critical section to serialize access. */
     RTCRITSECT                 mCritSect;
+    /** Event semaphore to wait for new DnD events. */
     RTSEMEVENT                 mEventSem;
 #ifdef RT_OS_WINDOWS
@@ -393 +424 @@
     bool                       mfMouseButtonDown;
 # ifdef VBOX_WITH_DRAG_AND_DROP_GH
-    /** IDropTarget implementation for guest -> host
-     *  support. */
+    /** Pointer to IDropTarget implementation for
+     *  guest -> host support. */
     VBoxDnDDropTarget         *pDropTarget;
 # endif /* VBOX_WITH_DRAG_AND_DROP_GH */