Changeset 81286 in vbox for trunk/src/VBox/Main/idl/VirtualBox.xidl

Timestamp:

Oct 15, 2019 4:37:37 PM (5 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

133981

Message:

Shared Clipboard/Transfers: Added IMachine::clipboardFileTransfersEnabled attribute (getter/setter) for enabling/disabling the feature. Disabled by default.

File:

• trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (5 diffs)

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -5853 +5853 @@
   <interface
     name="IMachine" extends="$unknown"
-    uuid="13a7c7cb-02fd-4962-a578-5660a5035776"
+    uuid="0020076B-00D0-494E-0023-C293000086A7"
     wsmap="managed"
     wrap-hint-server-addinterfaces="IInternalMachineControl"
@@ -6404 +6404 @@
         Synchronization mode between the host OS clipboard
         and the guest OS clipboard.
+      </desc>
+    </attribute>
+
+    <attribute name="clipboardFileTransfersEnabled" type="boolean">
+      <desc>
+        Sets or retrieves whether clipboard file transfers are allowed or not.
+
+        When set to @a true, clipboard file transfers between supported
+        host and guest OSes are allowed.
       </desc>
     </attribute>
@@ -21775 +21784 @@
       <param name="clipboardMode" type="ClipboardMode" dir="in">
         <desc>The new shared clipboard mode.</desc>
+      </param>
+    </method>
+
+    <method name="onClipboardFileTransferModeChange">
+      <desc>
+        Notification when the shared clipboard file transfers mode changes.
+      </desc>
+      <param name="enabled" type="boolean" dir="in">
+        <desc>Flag whether clipboard file transfers are allowed or not.</desc>
       </param>
     </method>
@@ -24082 +24100 @@
       </desc>
     </const>
+    <const name="OnClipboardFileTransferModeChanged" value="104">
+      <desc>
+        See <link to="IClipboardFileTransferModeChangedEvent">IClipboardFileTransferModeChangedEvent</link>.
+      </desc>
+    </const>
     <!-- End event marker -->
     <!-- @todo rename to 'End' as it is exclusive (we use 'last' to be inclusive). -->
-    <const name="Last" value="104">
+    <const name="Last" value="105">
       <desc>
         Must be last event, used for iterations and structures relying on numerical event values.
@@ -24903 +24926 @@
       <desc>
         The new clipboard mode.
+      </desc>
+    </attribute>
+  </interface>
+
+  <interface
+    name="IClipboardFileTransferModeChangedEvent" extends="IEvent"
+    uuid="00391758-00B1-4E9D-0000-11FA00F9D583"
+    wsmap="managed" autogen="VBoxEvent" id="OnClipboardFileTransferModeChanged"
+    >
+    <desc>
+      Notification when the shared clipboard file transfer mode changes.
+    </desc>
+    <attribute name="enabled" type="boolean" readonly="yes">
+      <desc>
+        Whether file transfers are allowed or not.
       </desc>
     </attribute>