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

Timestamp:

Dec 9, 2010 2:44:38 PM (14 years ago)

Author:

vboxsync

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

68709

Message:

ExtPack: First part of the extension pack license code.

File:

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

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

@@ -14367 +14367 @@
     </attribute>
     <attribute name="license" type="wstring" readonly="yes">
-      <desc>The HTML license text for the extension pack.</desc>
+      <desc>
+        The default HTML license text for the extension pack.  Same as
+        calling queryLicense("", "", "html").
+      </desc>
     </attribute>
     <attribute name="showLicense" type="boolean" readonly="yes">
@@ -14387 +14390 @@
       </desc>
     </attribute>
+
+    <method name="queryLicense">
+      <desc>
+        Full feature version of the license attribute.
+      </desc>
+      <param name="preferredLocale" type="wstring" dir="in">
+        <desc>
+          The preferred license locale. Pass an empty string to get the default
+          license.
+        </desc>
+      </param>
+      <param name="preferredLanguage" type="wstring" dir="in">
+        <desc>
+          The preferred license language. Pass an empty string to get the
+          default language for the locale.
+        </desc>
+      </param>
+      <param name="format" type="wstring" dir="in">
+        <desc>
+          The license format: html, rtf or txt. If a license is present there
+          will always be an HTML of it, the rich text format (RTF) and plain
+          text (txt) versions are optional. If
+        </desc>
+      </param>
+      <param name="licenseText" type="wstring" dir="return">
+        <desc>The license text.</desc>
+      </param>
+    </method>
+
   </interface>
 
@@ -14407 +14439 @@
         <desc>The object ID.  What exactly this is </desc>
       </param>
-      <param name="returnInterface" type="$unknown" dir="out">
+      <param name="returnInterface" type="$unknown" dir="return">
         <desc>The queried interface.</desc>
       </param>