Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric6.install.html	Fri Sep 28 20:07:25 2018 +0200
+++ b/Documentation/Source/eric6.install.html	Sat Sep 29 19:32:33 2018 +0200
@@ -88,6 +88,9 @@
 <td><a href="#createWindowsLinks">createWindowsLinks</a></td>
 <td>Create Desktop and Start Menu links.</td>
 </tr><tr>
+<td><a href="#createWindowsShortcut">createWindowsShortcut</a></td>
+<td>Create Windows shortcut.</td>
+</tr><tr>
 <td><a href="#determinePyQtVariant">determinePyQtVariant</a></td>
 <td>Module function to determine the PyQt variant to be used.</td>
 </tr><tr>
@@ -97,6 +100,9 @@
 <td><a href="#exit">exit</a></td>
 <td>Exit the install script.</td>
 </tr><tr>
+<td><a href="#getWinregEntry">getWinregEntry</a></td>
+<td>Function to get an entry from the Windows Registry.</td>
+</tr><tr>
 <td><a href="#initGlobals">initGlobals</a></td>
 <td>Module function to set the values of globals that need more than a simple assignment.</td>
 </tr><tr>
@@ -118,6 +124,15 @@
 <td><a href="#usage">usage</a></td>
 <td>Display a usage message and exit.</td>
 </tr><tr>
+<td><a href="#windowsDesktopEntries">windowsDesktopEntries</a></td>
+<td>Function to generate data for the Windows Desktop links.</td>
+</tr><tr>
+<td><a href="#windowsDesktopNames">windowsDesktopNames</a></td>
+<td>Function to generate the link names for the Windows Desktop.</td>
+</tr><tr>
+<td><a href="#windowsProgramsEntry">windowsProgramsEntry</a></td>
+<td>Function to generate the name of the Start Menu top entry.</td>
+</tr><tr>
 <td><a href="#wrapperNames">wrapperNames</a></td>
 <td>Create the platform specific names for the wrapper script.</td>
 </tr>
@@ -360,6 +375,25 @@
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
+<a NAME="createWindowsShortcut" ID="createWindowsShortcut"></a>
+<h2>createWindowsShortcut</h2>
+<b>createWindowsShortcut</b>(<i>linkPath, targetPath, iconPath</i>)
+<p>
+    Create Windows shortcut.
+</p><dl>
+<dt><i>linkPath</i> (str)</dt>
+<dd>
+path of the shortcut file
+</dd><dt><i>targetPath</i> (str)</dt>
+<dd>
+path the shortcut shall point to
+</dd><dt><i>iconPath</i> (str)</dt>
+<dd>
+path of the icon file
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
 <a NAME="determinePyQtVariant" ID="determinePyQtVariant"></a>
 <h2>determinePyQtVariant</h2>
 <b>determinePyQtVariant</b>(<i></i>)
@@ -389,6 +423,32 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
+<a NAME="getWinregEntry" ID="getWinregEntry"></a>
+<h2>getWinregEntry</h2>
+<b>getWinregEntry</b>(<i>name, path</i>)
+<p>
+    Function to get an entry from the Windows Registry.
+</p><dl>
+<dt><i>name</i> (str)</dt>
+<dd>
+variable name
+</dd><dt><i>path</i> (str)</dt>
+<dd>
+registry path of the variable
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+value of requested registry variable
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+any
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
 <a NAME="initGlobals" ID="initGlobals"></a>
 <h2>initGlobals</h2>
 <b>initGlobals</b>(<i></i>)
@@ -495,6 +555,61 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
+<a NAME="windowsDesktopEntries" ID="windowsDesktopEntries"></a>
+<h2>windowsDesktopEntries</h2>
+<b>windowsDesktopEntries</b>(<i></i>)
+<p>
+    Function to generate data for the Windows Desktop links.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of tuples containing the desktop link name,
+        the link target and the icon target
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of tuples of (str, str, str)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="windowsDesktopNames" ID="windowsDesktopNames"></a>
+<h2>windowsDesktopNames</h2>
+<b>windowsDesktopNames</b>(<i></i>)
+<p>
+    Function to generate the link names for the Windows Desktop.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of desktop link names
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="windowsProgramsEntry" ID="windowsProgramsEntry"></a>
+<h2>windowsProgramsEntry</h2>
+<b>windowsProgramsEntry</b>(<i></i>)
+<p>
+    Function to generate the name of the Start Menu top entry.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+name of the Start Menu top entry
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
 <a NAME="wrapperNames" ID="wrapperNames"></a>
 <h2>wrapperNames</h2>
 <b>wrapperNames</b>(<i>dname, wfile</i>)