Changeset 20081 in vbox for trunk/src/VBox/Main/idl

Timestamp:

May 27, 2009 12:55:11 PM (16 years ago)

Author:

vboxsync

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

47823

Message:

Main: initial code for upload to cloud (second try)

File:

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

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

@@ -2890 +2890 @@
     </method>
 
+  </interface>
+
+  <!--
+  // IVFSExplorer
+  /////////////////////////////////////////////////////////////////////////
+  -->
+
+  <enum
+    name="VFSType"
+    uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
+  >
+    <desc>
+      Supported virtual file systems of VFSExplorer.
+    </desc>
+
+    <const name="File" value="1" />
+    <const name="Cloud" value="2" />
+    <const name="S3" value="3" />
+    <const name="WebDav" value="4" />
+  </enum>
+
+  <enum
+    name="VFSFileType"
+    uuid="714333cd-44e2-415f-a245-d378fa9b1242"
+  >
+    <desc>
+      File types known by VFSExplorer.
+    </desc>
+
+    <const name="Unknown" value="1" />
+    <const name="Fifo" value="2" />
+    <const name="DevChar" value="3" />
+    <const name="Directory" value="4" />
+    <const name="DevBlock" value="5" />
+    <const name="File" value="6" />
+    <const name="SymLink" value="7" />
+    <const name="Socket" value="8" />
+    <const name="WhiteOut" value="9" />
+  </enum>
+
+  <interface
+     name="IVFSExplorer" extends="$unknown"
+     uuid="fd7da337-80ef-4a5c-9122-918435e33003"
+     wsmap="managed"
+     >
+    <desc>
+      The VFSExplorer interface unify the access to different file system
+      types. This includes local file systems as well remote file systems like
+      the S3 one. For a list of supported types see <link to="VFSType" />.
+    </desc>
+
+    <attribute name="path" type="wstring" readonly="yes">
+      <desc>Return the current path in the virtual file system.</desc>
+    </attribute>
+
+    <attribute name="type" type="VFSType" readonly="yes">
+      <desc>Return the file system type which is currently in use.</desc>
+    </attribute>
+
+    <method name="update">
+      <desc>This method updates the internal list of files/directories from the
+      current directory level. Use <link to="entryList" /> to get the full list
+      after a call to this method.</desc>
+
+      <param name="aProgress" type="IProgress" dir="return">
+        <desc>Progress object to track the operation completion.</desc>
+      </param>
+    </method>
+
+    <method name="entryList">
+      <desc>Fetch the list of files/directories after a call to <link
+      to="update" />. The user is responcible for keeping this internal list up
+      do date.</desc>
+
+      <param name="aNames" type="wstring" safearray="yes" dir="out">
+        <desc>The list of names for the entries.</desc>
+      </param>
+
+      <param name="aTypes" type="unsigned long" safearray="yes" dir="out">
+        <desc>The list of types for the entries.</desc>
+      </param>
+    </method>
+
+    <method name="exists">
+        <desc>Check if the given file list exists in the current directory
+        level.</desc>
+
+      <param name="aNames" type="wstring" safearray="yes" dir="in">
+        <desc>The names to check.</desc>
+      </param>
+
+      <param name="aExists" type="wstring" safearray="yes" dir="return">
+        <desc>The names which exists.</desc>
+      </param>
+    </method>
+
+    <method name="remove">
+        <desc>Remove the given file names from the current directory
+        level.</desc>
+
+      <param name="aNames" type="wstring" safearray="yes" dir="in">
+        <desc>The names to remove.</desc>
+      </param>
+
+      <param name="aProgress" type="IProgress" dir="return">
+        <desc>Progress object to track the operation completion.</desc>
+      </param>
+    </method>
+    
   </interface>
 
@@ -3043 +3152 @@
   <interface
      name="IAppliance" extends="$unknown"
-     uuid="30bfa6b8-9eda-4b0a-b218-a86813248ccd"
+     uuid="07495095-d16c-4911-8964-5914341ced5d"
      wsmap="managed"
      >
@@ -3229 +3338 @@
     </method>
 
+    <method name="createVFSExplorer">
+      <desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
+
+      <param name="aUri" type="wstring" dir="in">
+        <desc>The URI describing the file system to use.</desc>
+      </param>
+
+      <param name="aExplorer" type="IVFSExplorer" dir="return">
+        <desc></desc>
+      </param>
+    </method>
+
     <method name="write">
       <desc>
@@ -3253 +3374 @@
       </param>
       <param name="aProgress" type="IProgress" dir="return">
-          <desc></desc>
+        <desc>Progress object to track the operation completion.</desc>
       </param>
     </method>