eric: changeset 6595:5665f93a1018

--- a/APIs/Python3/eric6.api	Sat Nov 17 19:36:46 2018 +0100
+++ b/APIs/Python3/eric6.api	Sat Nov 17 19:37:46 2018 +0100
@@ -12598,6 +12598,14 @@
 eric6.cleanupSource.main?4(argv)
 eric6.compileUiFiles.compileUiFiles?4()
 eric6.compileUiFiles.main?4(argv)
+eric6.create_windows_links.PythonMarkers?7
+eric6.create_windows_links.createWindowsShortcut?4(linkPath, targetPath, iconPath)
+eric6.create_windows_links.getWinregEntry?4(name, path)
+eric6.create_windows_links.includePythonVariant?7
+eric6.create_windows_links.main?4(argv)
+eric6.create_windows_links.windowsDesktopEntries?4()
+eric6.create_windows_links.windowsDesktopNames?4()
+eric6.create_windows_links.windowsProgramsEntry?4()
 eric6.eric6.args?7
 eric6.eric6.excepthook?4(excType, excValue, tracebackobj)
 eric6.eric6.handleSingleApplication?4(ddindex)
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Help/source.qhp	Sat Nov 17 19:36:46 2018 +0100
+++ b/Documentation/Help/source.qhp	Sat Nov 17 19:37:46 2018 +0100
@@ -1477,6 +1477,7 @@
           </section>
           <section title="eric6.cleanupSource" ref="eric6.cleanupSource.html" />
           <section title="eric6.compileUiFiles" ref="eric6.compileUiFiles.html" />
+          <section title="eric6.create_windows_links" ref="eric6.create_windows_links.html" />
           <section title="eric6.eric6" ref="eric6.eric6.html" />
           <section title="eric6.eric6_api" ref="eric6.eric6_api.html" />
           <section title="eric6.eric6_browser" ref="eric6.eric6_browser.html" />
@@ -18733,7 +18734,9 @@
       <keyword name="createPyWrapper" id="createPyWrapper" ref="eric6.install.html#createPyWrapper" />
       <keyword name="createTranslatorPage" id="createTranslatorPage" ref="eric6.Plugins.PluginTranslator.html#createTranslatorPage" />
       <keyword name="createWindowsLinks" id="createWindowsLinks" ref="eric6.install.html#createWindowsLinks" />
+      <keyword name="createWindowsShortcut" id="createWindowsShortcut" ref="eric6.create_windows_links.html#createWindowsShortcut" />
       <keyword name="createWindowsShortcut" id="createWindowsShortcut" ref="eric6.install.html#createWindowsShortcut" />
+      <keyword name="create_windows_links (Module)" id="create_windows_links (Module)" ref="eric6.create_windows_links.html" />
       <keyword name="critical" id="critical" ref="eric6.E5Gui.E5MessageBox.html#critical" />
       <keyword name="crypto (Package)" id="crypto (Package)" ref="index-eric6.Utilities.crypto.html" />
       <keyword name="cursors (Package)" id="cursors (Package)" ref="index-eric6.IconEditor.cursors.html" />
@@ -18997,6 +19000,7 @@
       <keyword name="getWebBrowser" id="getWebBrowser" ref="eric6.Preferences.__init__.html#getWebBrowser" />
       <keyword name="getWebEngineVersions" id="getWebEngineVersions" ref="eric6.WebBrowser.Tools.WebBrowserTools.html#getWebEngineVersions" />
       <keyword name="getWindowsExecutablePath" id="getWindowsExecutablePath" ref="eric6.Utilities.__init__.html#getWindowsExecutablePath" />
+      <keyword name="getWinregEntry" id="getWinregEntry" ref="eric6.create_windows_links.html#getWinregEntry" />
       <keyword name="getWinregEntry" id="getWinregEntry" ref="eric6.install.html#getWinregEntry" />
       <keyword name="getWinregEntry" id="getWinregEntry" ref="eric6.uninstall.html#getWinregEntry" />
       <keyword name="get_checks" id="get_checks" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.pycodestyle.html#get_checks" />
@@ -19100,6 +19104,7 @@
       <keyword name="main" id="main" ref="eric6.Plugins.WizardPlugins.QRegularExpressionWizard.QRegularExpressionWizardServer.html#main" />
       <keyword name="main" id="main" ref="eric6.cleanupSource.html#main" />
       <keyword name="main" id="main" ref="eric6.compileUiFiles.html#main" />
+      <keyword name="main" id="main" ref="eric6.create_windows_links.html#main" />
       <keyword name="main" id="main" ref="eric6.eric6.html#main" />
       <keyword name="main" id="main" ref="eric6.eric6_api.html#main" />
       <keyword name="main" id="main" ref="eric6.eric6_browser.html#main" />
@@ -19415,9 +19420,12 @@
       <keyword name="win32_GetUserName" id="win32_GetUserName" ref="eric6.Utilities.__init__.html#win32_GetUserName" />
       <keyword name="win32_Kill" id="win32_Kill" ref="eric6.Utilities.__init__.html#win32_Kill" />
       <keyword name="win32_getRealName" id="win32_getRealName" ref="eric6.Utilities.__init__.html#win32_getRealName" />
+      <keyword name="windowsDesktopEntries" id="windowsDesktopEntries" ref="eric6.create_windows_links.html#windowsDesktopEntries" />
       <keyword name="windowsDesktopEntries" id="windowsDesktopEntries" ref="eric6.install.html#windowsDesktopEntries" />
+      <keyword name="windowsDesktopNames" id="windowsDesktopNames" ref="eric6.create_windows_links.html#windowsDesktopNames" />
       <keyword name="windowsDesktopNames" id="windowsDesktopNames" ref="eric6.install.html#windowsDesktopNames" />
       <keyword name="windowsDesktopNames" id="windowsDesktopNames" ref="eric6.uninstall.html#windowsDesktopNames" />
+      <keyword name="windowsProgramsEntry" id="windowsProgramsEntry" ref="eric6.create_windows_links.html#windowsProgramsEntry" />
       <keyword name="windowsProgramsEntry" id="windowsProgramsEntry" ref="eric6.install.html#windowsProgramsEntry" />
       <keyword name="windowsProgramsEntry" id="windowsProgramsEntry" ref="eric6.uninstall.html#windowsProgramsEntry" />
       <keyword name="worker" id="worker" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleChecker.html#worker" />
@@ -20582,6 +20590,7 @@
       <file>eric6.WebBrowser.ZoomManager.ZoomValuesModel.html</file>
       <file>eric6.cleanupSource.html</file>
       <file>eric6.compileUiFiles.html</file>
+      <file>eric6.create_windows_links.html</file>
       <file>eric6.eric6.html</file>
       <file>eric6.eric6_api.html</file>
       <file>eric6.eric6_browser.html</file>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.create_windows_links.html	Sat Nov 17 19:37:46 2018 +0100
@@ -0,0 +1,170 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.create_windows_links</title>
+<meta charset="UTF-8">
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric6.create_windows_links</h1>
+<p>
+Installation script for the eric6 IDE and all eric6 related tools.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>PythonMarkers</td></tr><tr><td>includePythonVariant</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#createWindowsShortcut">createWindowsShortcut</a></td>
+<td>Create Windows shortcut.</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="#main">main</a></td>
+<td>Create Desktop and Start Menu links.</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>
+</table>
+<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="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="main" ID="main"></a>
+<h2>main</h2>
+<b>main</b>(<i>argv</i>)
+<p>
+    Create Desktop and Start Menu links.
+</p><dl>
+<dt><i>argv</i> (list of str)</dt>
+<dd>
+list of command line arguments
+</dd>
+</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 />
+</body></html>
\ No newline at end of file
--- a/Documentation/Source/eric6.install.html	Sat Nov 17 19:36:46 2018 +0100
+++ b/Documentation/Source/eric6.install.html	Sat Nov 17 19:37:46 2018 +0100
@@ -477,9 +477,9 @@
 <p>
     The main function of the script.
 </p><dl>
-<dt><i>argv</i></dt>
+<dt><i>argv</i> (list of str)</dt>
 <dd>
-the list of command line arguments.
+list of command line arguments
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
--- a/Documentation/Source/index-eric6.html	Sat Nov 17 19:36:46 2018 +0100
+++ b/Documentation/Source/index-eric6.html	Sat Nov 17 19:37:46 2018 +0100
@@ -146,6 +146,9 @@
 <td><a href="eric6.compileUiFiles.html">compileUiFiles</a></td>
 <td>Script for eric6 to compile all .ui files to Python source.</td>
 </tr><tr>
+<td><a href="eric6.create_windows_links.html">create_windows_links</a></td>
+<td>Installation script for the eric6 IDE and all eric6 related tools.</td>
+</tr><tr>
 <td><a href="eric6.eric6.html">eric6</a></td>
 <td>Eric6 Python IDE.</td>
 </tr><tr>
APIs/Python3/eric6.api		file \| annotate \| diff \| comparison \| revisions
Documentation/Help/source.qch		file \| annotate \| diff \| comparison \| revisions
Documentation/Help/source.qhp		file \| annotate \| diff \| comparison \| revisions
Documentation/Source/eric6.create_windows_links.html		file \| annotate \| diff \| comparison \| revisions
Documentation/Source/eric6.install.html		file \| annotate \| diff \| comparison \| revisions
Documentation/Source/index-eric6.html		file \| annotate \| diff \| comparison \| revisions