Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.eric7_post_install.html
src/eric7/Documentation/Source/eric7.eric7_post_install.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8660
- 1848e8e4b380
- child 9211
- 99eb1cb030a5
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.eric7_post_install</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>eric7.eric7_post_install</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the post install logic for 'pip install'. | |
| 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="#copyDesktopFile">copyDesktopFile</a></td> | |
| 30 <td>Modify a desktop file and write it to its destination.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#copyLinuxMetaData">copyLinuxMetaData</a></td> | |
| 34 <td>Function to copy the meta data files.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#copyMetaFile">copyMetaFile</a></td> | |
| 38 <td>Function to copy a file to its destination.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#copyMetaFilesTree">copyMetaFilesTree</a></td> | |
| 42 <td>Function to copy the files of a directory tree.</td> | |
| 43 </tr> | |
| 44 <tr> | |
| 45 <td><a href="#createWindowsLinks">createWindowsLinks</a></td> | |
| 46 <td>Create Desktop and Start Menu links.</td> | |
| 47 </tr> | |
| 48 <tr> | |
| 49 <td><a href="#createWindowsShortcut">createWindowsShortcut</a></td> | |
| 50 <td>Create Windows shortcut.</td> | |
| 51 </tr> | |
| 52 <tr> | |
| 53 <td><a href="#getWinregEntry">getWinregEntry</a></td> | |
| 54 <td>Function to get an entry from the Windows Registry.</td> | |
| 55 </tr> | |
| 56 <tr> | |
| 57 <td><a href="#main">main</a></td> | |
| 58 <td>Main script orchestrating the platform dependent post installation tasks.</td> | |
| 59 </tr> | |
| 60 <tr> | |
| 61 <td><a href="#windowsDesktopEntries">windowsDesktopEntries</a></td> | |
| 62 <td>Function to generate data for the Windows Desktop links.</td> | |
| 63 </tr> | |
| 64 <tr> | |
| 65 <td><a href="#windowsProgramsEntry">windowsProgramsEntry</a></td> | |
| 66 <td>Function to generate the name of the Start Menu top entry.</td> | |
| 67 </tr> | |
| 68 </table> | |
| 69 <hr /> | |
| 70 <hr /> | |
| 71 <a NAME="copyDesktopFile" ID="copyDesktopFile"></a> | |
| 72 <h2>copyDesktopFile</h2> | |
| 73 <b>copyDesktopFile</b>(<i>src, dst, scriptsdir</i>) | |
| 74 | |
| 75 <p> | |
| 76 Modify a desktop file and write it to its destination. | |
| 77 </p> | |
| 78 <dl> | |
| 79 | |
| 80 <dt><i>src</i></dt> | |
| 81 <dd> | |
| 82 source file name (string) | |
| 83 </dd> | |
| 84 <dt><i>dst</i></dt> | |
| 85 <dd> | |
| 86 destination file name (string) | |
| 87 </dd> | |
| 88 <dt><i>scriptsdir</i></dt> | |
| 89 <dd> | |
| 90 directory containing the scripts (string) | |
| 91 </dd> | |
| 92 </dl> | |
| 93 <div align="right"><a href="#top">Up</a></div> | |
| 94 <hr /> | |
| 95 <hr /> | |
| 96 <a NAME="copyLinuxMetaData" ID="copyLinuxMetaData"></a> | |
| 97 <h2>copyLinuxMetaData</h2> | |
| 98 <b>copyLinuxMetaData</b>(<i></i>) | |
| 99 | |
| 100 <p> | |
| 101 Function to copy the meta data files. | |
| 102 </p> | |
| 103 <div align="right"><a href="#top">Up</a></div> | |
| 104 <hr /> | |
| 105 <hr /> | |
| 106 <a NAME="copyMetaFile" ID="copyMetaFile"></a> | |
| 107 <h2>copyMetaFile</h2> | |
| 108 <b>copyMetaFile</b>(<i>srcname, dstpath, dstname</i>) | |
| 109 | |
| 110 <p> | |
| 111 Function to copy a file to its destination. | |
| 112 </p> | |
| 113 <dl> | |
| 114 | |
| 115 <dt><i>srcname</i> (str)</dt> | |
| 116 <dd> | |
| 117 name of the source file | |
| 118 </dd> | |
| 119 <dt><i>dstpath</i> (str)</dt> | |
| 120 <dd> | |
| 121 name of the destination path | |
| 122 </dd> | |
| 123 <dt><i>dstname</i> (str)</dt> | |
| 124 <dd> | |
| 125 name of the destination file (without path) | |
| 126 </dd> | |
| 127 </dl> | |
| 128 <div align="right"><a href="#top">Up</a></div> | |
| 129 <hr /> | |
| 130 <hr /> | |
| 131 <a NAME="copyMetaFilesTree" ID="copyMetaFilesTree"></a> | |
| 132 <h2>copyMetaFilesTree</h2> | |
| 133 <b>copyMetaFilesTree</b>(<i>src, dst</i>) | |
| 134 | |
| 135 <p> | |
| 136 Function to copy the files of a directory tree. | |
| 137 </p> | |
| 138 <dl> | |
| 139 | |
| 140 <dt><i>src</i></dt> | |
| 141 <dd> | |
| 142 name of the source directory | |
| 143 </dd> | |
| 144 <dt><i>dst</i></dt> | |
| 145 <dd> | |
| 146 name of the destination directory | |
| 147 </dd> | |
| 148 </dl> | |
| 149 <div align="right"><a href="#top">Up</a></div> | |
| 150 <hr /> | |
| 151 <hr /> | |
| 152 <a NAME="createWindowsLinks" ID="createWindowsLinks"></a> | |
| 153 <h2>createWindowsLinks</h2> | |
| 154 <b>createWindowsLinks</b>(<i></i>) | |
| 155 | |
| 156 <p> | |
| 157 Create Desktop and Start Menu links. | |
| 158 </p> | |
| 159 <div align="right"><a href="#top">Up</a></div> | |
| 160 <hr /> | |
| 161 <hr /> | |
| 162 <a NAME="createWindowsShortcut" ID="createWindowsShortcut"></a> | |
| 163 <h2>createWindowsShortcut</h2> | |
| 164 <b>createWindowsShortcut</b>(<i>linkPath, targetPath, iconPath</i>) | |
| 165 | |
| 166 <p> | |
| 167 Create Windows shortcut. | |
| 168 </p> | |
| 169 <dl> | |
| 170 | |
| 171 <dt><i>linkPath</i> (str)</dt> | |
| 172 <dd> | |
| 173 path of the shortcut file | |
| 174 </dd> | |
| 175 <dt><i>targetPath</i> (str)</dt> | |
| 176 <dd> | |
| 177 path the shortcut shall point to | |
| 178 </dd> | |
| 179 <dt><i>iconPath</i> (str)</dt> | |
| 180 <dd> | |
| 181 path of the icon file | |
| 182 </dd> | |
| 183 </dl> | |
| 184 <div align="right"><a href="#top">Up</a></div> | |
| 185 <hr /> | |
| 186 <hr /> | |
| 187 <a NAME="getWinregEntry" ID="getWinregEntry"></a> | |
| 188 <h2>getWinregEntry</h2> | |
| 189 <b>getWinregEntry</b>(<i>name, path</i>) | |
| 190 | |
| 191 <p> | |
| 192 Function to get an entry from the Windows Registry. | |
| 193 </p> | |
| 194 <dl> | |
| 195 | |
| 196 <dt><i>name</i> (str)</dt> | |
| 197 <dd> | |
| 198 variable name | |
| 199 </dd> | |
| 200 <dt><i>path</i> (str)</dt> | |
| 201 <dd> | |
| 202 registry path of the variable | |
| 203 </dd> | |
| 204 </dl> | |
| 205 <dl> | |
| 206 <dt>Return:</dt> | |
| 207 <dd> | |
| 208 value of requested registry variable | |
| 209 </dd> | |
| 210 </dl> | |
| 211 <dl> | |
| 212 <dt>Return Type:</dt> | |
| 213 <dd> | |
| 214 any | |
| 215 </dd> | |
| 216 </dl> | |
| 217 <div align="right"><a href="#top">Up</a></div> | |
| 218 <hr /> | |
| 219 <hr /> | |
| 220 <a NAME="main" ID="main"></a> | |
| 221 <h2>main</h2> | |
| 222 <b>main</b>(<i></i>) | |
| 223 | |
| 224 <p> | |
| 225 Main script orchestrating the platform dependent post installation tasks. | |
| 226 </p> | |
| 227 <div align="right"><a href="#top">Up</a></div> | |
| 228 <hr /> | |
| 229 <hr /> | |
| 230 <a NAME="windowsDesktopEntries" ID="windowsDesktopEntries"></a> | |
| 231 <h2>windowsDesktopEntries</h2> | |
| 232 <b>windowsDesktopEntries</b>(<i></i>) | |
| 233 | |
| 234 <p> | |
| 235 Function to generate data for the Windows Desktop links. | |
| 236 </p> | |
| 237 <dl> | |
| 238 <dt>Return:</dt> | |
| 239 <dd> | |
| 240 list of tuples containing the desktop link name, | |
| 241 the link target and the icon target | |
| 242 </dd> | |
| 243 </dl> | |
| 244 <dl> | |
| 245 <dt>Return Type:</dt> | |
| 246 <dd> | |
| 247 list of tuples of (str, str, str) | |
| 248 </dd> | |
| 249 </dl> | |
| 250 <div align="right"><a href="#top">Up</a></div> | |
| 251 <hr /> | |
| 252 <hr /> | |
| 253 <a NAME="windowsProgramsEntry" ID="windowsProgramsEntry"></a> | |
| 254 <h2>windowsProgramsEntry</h2> | |
| 255 <b>windowsProgramsEntry</b>(<i></i>) | |
| 256 | |
| 257 <p> | |
| 258 Function to generate the name of the Start Menu top entry. | |
| 259 </p> | |
| 260 <dl> | |
| 261 <dt>Return:</dt> | |
| 262 <dd> | |
| 263 name of the Start Menu top entry | |
| 264 </dd> | |
| 265 </dl> | |
| 266 <dl> | |
| 267 <dt>Return Type:</dt> | |
| 268 <dd> | |
| 269 str | |
| 270 </dd> | |
| 271 </dl> | |
| 272 <div align="right"><a href="#top">Up</a></div> | |
| 273 <hr /> | |
| 274 </body></html> |
