Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.eric7config.html
src/eric7/Documentation/Source/eric7.eric7config.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10428
- a071d4065202
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.eric7config</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.eric7config</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module containing the default configuration of the eric installation. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>__ericDir</td></tr><tr><td>_pkg_config</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="#getConfig">getConfig</a></td> | |
| 30 <td>Module function to get a configuration value.</td> | |
| 31 </tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="getConfig" ID="getConfig"></a> | |
| 36 <h2>getConfig</h2> | |
| 37 <b>getConfig</b>(<i>name</i>) | |
| 38 | |
| 39 <p> | |
| 40 Module function to get a configuration value. | |
| 41 </p> | |
| 42 <dl> | |
| 43 | |
| 44 <dt><i>name</i> (str)</dt> | |
| 45 <dd> | |
| 46 name of the configuration value | |
| 47 </dd> | |
| 48 </dl> | |
| 49 <dl> | |
| 50 <dt>Return:</dt> | |
| 51 <dd> | |
| 52 requested config value | |
| 53 </dd> | |
| 54 </dl> | |
| 55 <dl> | |
| 56 | |
| 57 <dt>Raises <b>AttributeError</b>:</dt> | |
| 58 <dd> | |
| 59 raised to indicate an invalid config entry | |
| 60 </dd> | |
| 61 </dl> | |
| 62 <div align="right"><a href="#top">Up</a></div> | |
| 63 <hr /> | |
| 64 </body></html> |
