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