Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.create_windows_links.html
eric6/Documentation/Source/eric6.create_windows_links.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.create_windows_links</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.create_windows_links</h1> | |
| 23 <p> | |
| 24 Installation script for the eric6 IDE and all eric6 related tools. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>PythonMarkers</td></tr><tr><td>includePythonVariant</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <h3>Functions</h3> | |
| 35 <table> | |
| 36 <tr> | |
| 37 <td><a href="#createWindowsShortcut">createWindowsShortcut</a></td> | |
| 38 <td>Create Windows shortcut.</td> | |
| 39 </tr><tr> | |
| 40 <td><a href="#getWinregEntry">getWinregEntry</a></td> | |
| 41 <td>Function to get an entry from the Windows Registry.</td> | |
| 42 </tr><tr> | |
| 43 <td><a href="#main">main</a></td> | |
| 44 <td>Create Desktop and Start Menu links.</td> | |
| 45 </tr><tr> | |
| 46 <td><a href="#windowsDesktopEntries">windowsDesktopEntries</a></td> | |
| 47 <td>Function to generate data for the Windows Desktop links.</td> | |
| 48 </tr><tr> | |
| 49 <td><a href="#windowsDesktopNames">windowsDesktopNames</a></td> | |
| 50 <td>Function to generate the link names for the Windows Desktop.</td> | |
| 51 </tr><tr> | |
| 52 <td><a href="#windowsProgramsEntry">windowsProgramsEntry</a></td> | |
| 53 <td>Function to generate the name of the Start Menu top entry.</td> | |
| 54 </tr> | |
| 55 </table> | |
| 56 <hr /><hr /> | |
| 57 <a NAME="createWindowsShortcut" ID="createWindowsShortcut"></a> | |
| 58 <h2>createWindowsShortcut</h2> | |
| 59 <b>createWindowsShortcut</b>(<i>linkPath, targetPath, iconPath</i>) | |
| 60 <p> | |
| 61 Create Windows shortcut. | |
| 62 </p><dl> | |
| 63 <dt><i>linkPath</i> (str)</dt> | |
| 64 <dd> | |
| 65 path of the shortcut file | |
| 66 </dd><dt><i>targetPath</i> (str)</dt> | |
| 67 <dd> | |
| 68 path the shortcut shall point to | |
| 69 </dd><dt><i>iconPath</i> (str)</dt> | |
| 70 <dd> | |
| 71 path of the icon file | |
| 72 </dd> | |
| 73 </dl> | |
| 74 <div align="right"><a href="#top">Up</a></div> | |
| 75 <hr /><hr /> | |
| 76 <a NAME="getWinregEntry" ID="getWinregEntry"></a> | |
| 77 <h2>getWinregEntry</h2> | |
| 78 <b>getWinregEntry</b>(<i>name, path</i>) | |
| 79 <p> | |
| 80 Function to get an entry from the Windows Registry. | |
| 81 </p><dl> | |
| 82 <dt><i>name</i> (str)</dt> | |
| 83 <dd> | |
| 84 variable name | |
| 85 </dd><dt><i>path</i> (str)</dt> | |
| 86 <dd> | |
| 87 registry path of the variable | |
| 88 </dd> | |
| 89 </dl><dl> | |
| 90 <dt>Returns:</dt> | |
| 91 <dd> | |
| 92 value of requested registry variable | |
| 93 </dd> | |
| 94 </dl><dl> | |
| 95 <dt>Return Type:</dt> | |
| 96 <dd> | |
| 97 any | |
| 98 </dd> | |
| 99 </dl> | |
| 100 <div align="right"><a href="#top">Up</a></div> | |
| 101 <hr /><hr /> | |
| 102 <a NAME="main" ID="main"></a> | |
| 103 <h2>main</h2> | |
| 104 <b>main</b>(<i>argv</i>) | |
| 105 <p> | |
| 106 Create Desktop and Start Menu links. | |
| 107 </p><dl> | |
| 108 <dt><i>argv</i> (list of str)</dt> | |
| 109 <dd> | |
| 110 list of command line arguments | |
| 111 </dd> | |
| 112 </dl> | |
| 113 <div align="right"><a href="#top">Up</a></div> | |
| 114 <hr /><hr /> | |
| 115 <a NAME="windowsDesktopEntries" ID="windowsDesktopEntries"></a> | |
| 116 <h2>windowsDesktopEntries</h2> | |
| 117 <b>windowsDesktopEntries</b>(<i></i>) | |
| 118 <p> | |
| 119 Function to generate data for the Windows Desktop links. | |
| 120 </p><dl> | |
| 121 <dt>Returns:</dt> | |
| 122 <dd> | |
| 123 list of tuples containing the desktop link name, | |
| 124 the link target and the icon target | |
| 125 </dd> | |
| 126 </dl><dl> | |
| 127 <dt>Return Type:</dt> | |
| 128 <dd> | |
| 129 list of tuples of (str, str, str) | |
| 130 </dd> | |
| 131 </dl> | |
| 132 <div align="right"><a href="#top">Up</a></div> | |
| 133 <hr /><hr /> | |
| 134 <a NAME="windowsDesktopNames" ID="windowsDesktopNames"></a> | |
| 135 <h2>windowsDesktopNames</h2> | |
| 136 <b>windowsDesktopNames</b>(<i></i>) | |
| 137 <p> | |
| 138 Function to generate the link names for the Windows Desktop. | |
| 139 </p><dl> | |
| 140 <dt>Returns:</dt> | |
| 141 <dd> | |
| 142 list of desktop link names | |
| 143 </dd> | |
| 144 </dl><dl> | |
| 145 <dt>Return Type:</dt> | |
| 146 <dd> | |
| 147 list of str | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <div align="right"><a href="#top">Up</a></div> | |
| 151 <hr /><hr /> | |
| 152 <a NAME="windowsProgramsEntry" ID="windowsProgramsEntry"></a> | |
| 153 <h2>windowsProgramsEntry</h2> | |
| 154 <b>windowsProgramsEntry</b>(<i></i>) | |
| 155 <p> | |
| 156 Function to generate the name of the Start Menu top entry. | |
| 157 </p><dl> | |
| 158 <dt>Returns:</dt> | |
| 159 <dd> | |
| 160 name of the Start Menu top entry | |
| 161 </dd> | |
| 162 </dl><dl> | |
| 163 <dt>Return Type:</dt> | |
| 164 <dd> | |
| 165 str | |
| 166 </dd> | |
| 167 </dl> | |
| 168 <div align="right"><a href="#top">Up</a></div> | |
| 169 <hr /> | |
| 170 </body></html> |
