Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/create_windows_links.html
eric6/Documentation/Source/create_windows_links.html
- changeset 7273
- 391d6b7b1eff
- parent 7204
- cbf6d88004ce
- child 7960
- e8fc383322f7
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>create_windows_links</h1> | 23 <h1>create_windows_links</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Installation script for the eric6 IDE and all eric6 related tools. | 26 Installation script for the eric6 IDE and all eric6 related tools. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 32 <tr><td>None</td></tr> | 36 <tr><td>None</td></tr> |
| 33 </table> | 37 </table> |
| 34 <h3>Functions</h3> | 38 <h3>Functions</h3> |
| 39 | |
| 35 <table> | 40 <table> |
| 41 | |
| 36 <tr> | 42 <tr> |
| 37 <td><a href="#createWindowsShortcut">createWindowsShortcut</a></td> | 43 <td><a href="#createWindowsShortcut">createWindowsShortcut</a></td> |
| 38 <td>Create Windows shortcut.</td> | 44 <td>Create Windows shortcut.</td> |
| 39 </tr><tr> | 45 </tr> |
| 46 <tr> | |
| 40 <td><a href="#getWinregEntry">getWinregEntry</a></td> | 47 <td><a href="#getWinregEntry">getWinregEntry</a></td> |
| 41 <td>Function to get an entry from the Windows Registry.</td> | 48 <td>Function to get an entry from the Windows Registry.</td> |
| 42 </tr><tr> | 49 </tr> |
| 50 <tr> | |
| 43 <td><a href="#main">main</a></td> | 51 <td><a href="#main">main</a></td> |
| 44 <td>Create Desktop and Start Menu links.</td> | 52 <td>Create Desktop and Start Menu links.</td> |
| 45 </tr><tr> | 53 </tr> |
| 54 <tr> | |
| 46 <td><a href="#windowsDesktopEntries">windowsDesktopEntries</a></td> | 55 <td><a href="#windowsDesktopEntries">windowsDesktopEntries</a></td> |
| 47 <td>Function to generate data for the Windows Desktop links.</td> | 56 <td>Function to generate data for the Windows Desktop links.</td> |
| 48 </tr><tr> | 57 </tr> |
| 58 <tr> | |
| 49 <td><a href="#windowsDesktopNames">windowsDesktopNames</a></td> | 59 <td><a href="#windowsDesktopNames">windowsDesktopNames</a></td> |
| 50 <td>Function to generate the link names for the Windows Desktop.</td> | 60 <td>Function to generate the link names for the Windows Desktop.</td> |
| 51 </tr><tr> | 61 </tr> |
| 62 <tr> | |
| 52 <td><a href="#windowsProgramsEntry">windowsProgramsEntry</a></td> | 63 <td><a href="#windowsProgramsEntry">windowsProgramsEntry</a></td> |
| 53 <td>Function to generate the name of the Start Menu top entry.</td> | 64 <td>Function to generate the name of the Start Menu top entry.</td> |
| 54 </tr> | 65 </tr> |
| 55 </table> | 66 </table> |
| 56 <hr /><hr /> | 67 <hr /> |
| 68 <hr /> | |
| 57 <a NAME="createWindowsShortcut" ID="createWindowsShortcut"></a> | 69 <a NAME="createWindowsShortcut" ID="createWindowsShortcut"></a> |
| 58 <h2>createWindowsShortcut</h2> | 70 <h2>createWindowsShortcut</h2> |
| 59 <b>createWindowsShortcut</b>(<i>linkPath, targetPath, iconPath</i>) | 71 <b>createWindowsShortcut</b>(<i>linkPath, targetPath, iconPath</i>) |
| 72 | |
| 60 <p> | 73 <p> |
| 61 Create Windows shortcut. | 74 Create Windows shortcut. |
| 62 </p><dl> | 75 </p> |
| 76 <dl> | |
| 77 | |
| 63 <dt><i>linkPath</i> (str)</dt> | 78 <dt><i>linkPath</i> (str)</dt> |
| 64 <dd> | 79 <dd> |
| 65 path of the shortcut file | 80 path of the shortcut file |
| 66 </dd><dt><i>targetPath</i> (str)</dt> | 81 </dd> |
| 82 <dt><i>targetPath</i> (str)</dt> | |
| 67 <dd> | 83 <dd> |
| 68 path the shortcut shall point to | 84 path the shortcut shall point to |
| 69 </dd><dt><i>iconPath</i> (str)</dt> | 85 </dd> |
| 86 <dt><i>iconPath</i> (str)</dt> | |
| 70 <dd> | 87 <dd> |
| 71 path of the icon file | 88 path of the icon file |
| 72 </dd> | 89 </dd> |
| 73 </dl> | 90 </dl> |
| 74 <div align="right"><a href="#top">Up</a></div> | 91 <div align="right"><a href="#top">Up</a></div> |
| 75 <hr /><hr /> | 92 <hr /> |
| 93 <hr /> | |
| 76 <a NAME="getWinregEntry" ID="getWinregEntry"></a> | 94 <a NAME="getWinregEntry" ID="getWinregEntry"></a> |
| 77 <h2>getWinregEntry</h2> | 95 <h2>getWinregEntry</h2> |
| 78 <b>getWinregEntry</b>(<i>name, path</i>) | 96 <b>getWinregEntry</b>(<i>name, path</i>) |
| 97 | |
| 79 <p> | 98 <p> |
| 80 Function to get an entry from the Windows Registry. | 99 Function to get an entry from the Windows Registry. |
| 81 </p><dl> | 100 </p> |
| 101 <dl> | |
| 102 | |
| 82 <dt><i>name</i> (str)</dt> | 103 <dt><i>name</i> (str)</dt> |
| 83 <dd> | 104 <dd> |
| 84 variable name | 105 variable name |
| 85 </dd><dt><i>path</i> (str)</dt> | 106 </dd> |
| 107 <dt><i>path</i> (str)</dt> | |
| 86 <dd> | 108 <dd> |
| 87 registry path of the variable | 109 registry path of the variable |
| 88 </dd> | 110 </dd> |
| 89 </dl><dl> | 111 </dl> |
| 112 <dl> | |
| 90 <dt>Returns:</dt> | 113 <dt>Returns:</dt> |
| 91 <dd> | 114 <dd> |
| 92 value of requested registry variable | 115 value of requested registry variable |
| 93 </dd> | 116 </dd> |
| 94 </dl><dl> | 117 </dl> |
| 118 <dl> | |
| 95 <dt>Return Type:</dt> | 119 <dt>Return Type:</dt> |
| 96 <dd> | 120 <dd> |
| 97 any | 121 any |
| 98 </dd> | 122 </dd> |
| 99 </dl> | 123 </dl> |
| 100 <div align="right"><a href="#top">Up</a></div> | 124 <div align="right"><a href="#top">Up</a></div> |
| 101 <hr /><hr /> | 125 <hr /> |
| 126 <hr /> | |
| 102 <a NAME="main" ID="main"></a> | 127 <a NAME="main" ID="main"></a> |
| 103 <h2>main</h2> | 128 <h2>main</h2> |
| 104 <b>main</b>(<i>argv</i>) | 129 <b>main</b>(<i>argv</i>) |
| 130 | |
| 105 <p> | 131 <p> |
| 106 Create Desktop and Start Menu links. | 132 Create Desktop and Start Menu links. |
| 107 </p><dl> | 133 </p> |
| 134 <dl> | |
| 135 | |
| 108 <dt><i>argv</i> (list of str)</dt> | 136 <dt><i>argv</i> (list of str)</dt> |
| 109 <dd> | 137 <dd> |
| 110 list of command line arguments | 138 list of command line arguments |
| 111 </dd> | 139 </dd> |
| 112 </dl> | 140 </dl> |
| 113 <div align="right"><a href="#top">Up</a></div> | 141 <div align="right"><a href="#top">Up</a></div> |
| 114 <hr /><hr /> | 142 <hr /> |
| 143 <hr /> | |
| 115 <a NAME="windowsDesktopEntries" ID="windowsDesktopEntries"></a> | 144 <a NAME="windowsDesktopEntries" ID="windowsDesktopEntries"></a> |
| 116 <h2>windowsDesktopEntries</h2> | 145 <h2>windowsDesktopEntries</h2> |
| 117 <b>windowsDesktopEntries</b>(<i></i>) | 146 <b>windowsDesktopEntries</b>(<i></i>) |
| 147 | |
| 118 <p> | 148 <p> |
| 119 Function to generate data for the Windows Desktop links. | 149 Function to generate data for the Windows Desktop links. |
| 120 </p><dl> | 150 </p> |
| 151 <dl> | |
| 121 <dt>Returns:</dt> | 152 <dt>Returns:</dt> |
| 122 <dd> | 153 <dd> |
| 123 list of tuples containing the desktop link name, | 154 list of tuples containing the desktop link name, |
| 124 the link target and the icon target | 155 the link target and the icon target |
| 125 </dd> | 156 </dd> |
| 126 </dl><dl> | 157 </dl> |
| 158 <dl> | |
| 127 <dt>Return Type:</dt> | 159 <dt>Return Type:</dt> |
| 128 <dd> | 160 <dd> |
| 129 list of tuples of (str, str, str) | 161 list of tuples of (str, str, str) |
| 130 </dd> | 162 </dd> |
| 131 </dl> | 163 </dl> |
| 132 <div align="right"><a href="#top">Up</a></div> | 164 <div align="right"><a href="#top">Up</a></div> |
| 133 <hr /><hr /> | 165 <hr /> |
| 166 <hr /> | |
| 134 <a NAME="windowsDesktopNames" ID="windowsDesktopNames"></a> | 167 <a NAME="windowsDesktopNames" ID="windowsDesktopNames"></a> |
| 135 <h2>windowsDesktopNames</h2> | 168 <h2>windowsDesktopNames</h2> |
| 136 <b>windowsDesktopNames</b>(<i></i>) | 169 <b>windowsDesktopNames</b>(<i></i>) |
| 170 | |
| 137 <p> | 171 <p> |
| 138 Function to generate the link names for the Windows Desktop. | 172 Function to generate the link names for the Windows Desktop. |
| 139 </p><dl> | 173 </p> |
| 174 <dl> | |
| 140 <dt>Returns:</dt> | 175 <dt>Returns:</dt> |
| 141 <dd> | 176 <dd> |
| 142 list of desktop link names | 177 list of desktop link names |
| 143 </dd> | 178 </dd> |
| 144 </dl><dl> | 179 </dl> |
| 180 <dl> | |
| 145 <dt>Return Type:</dt> | 181 <dt>Return Type:</dt> |
| 146 <dd> | 182 <dd> |
| 147 list of str | 183 list of str |
| 148 </dd> | 184 </dd> |
| 149 </dl> | 185 </dl> |
| 150 <div align="right"><a href="#top">Up</a></div> | 186 <div align="right"><a href="#top">Up</a></div> |
| 151 <hr /><hr /> | 187 <hr /> |
| 188 <hr /> | |
| 152 <a NAME="windowsProgramsEntry" ID="windowsProgramsEntry"></a> | 189 <a NAME="windowsProgramsEntry" ID="windowsProgramsEntry"></a> |
| 153 <h2>windowsProgramsEntry</h2> | 190 <h2>windowsProgramsEntry</h2> |
| 154 <b>windowsProgramsEntry</b>(<i></i>) | 191 <b>windowsProgramsEntry</b>(<i></i>) |
| 192 | |
| 155 <p> | 193 <p> |
| 156 Function to generate the name of the Start Menu top entry. | 194 Function to generate the name of the Start Menu top entry. |
| 157 </p><dl> | 195 </p> |
| 196 <dl> | |
| 158 <dt>Returns:</dt> | 197 <dt>Returns:</dt> |
| 159 <dd> | 198 <dd> |
| 160 name of the Start Menu top entry | 199 name of the Start Menu top entry |
| 161 </dd> | 200 </dd> |
| 162 </dl><dl> | 201 </dl> |
| 202 <dl> | |
| 163 <dt>Return Type:</dt> | 203 <dt>Return Type:</dt> |
| 164 <dd> | 204 <dd> |
| 165 str | 205 str |
| 166 </dd> | 206 </dd> |
| 167 </dl> | 207 </dl> |
