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