Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.PluginManager.PluginUtilities.html
src/eric7/Documentation/Source/eric7.PluginManager.PluginUtilities.html
- branch
- eric7
- changeset 10064
- 8c3207703dac
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10063:9a6a92fd1eae | 10064:8c3207703dac |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.PluginManager.PluginUtilities</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.PluginManager.PluginUtilities</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing common utility functions needed for plugin management. | |
| 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="#getPluginHeaderEntry">getPluginHeaderEntry</a></td> | |
| 30 <td>Function to get an entry of the plugin header.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#hasPluginHeaderEntry">hasPluginHeaderEntry</a></td> | |
| 34 <td>Function to check, if the plugin header contains the given entry.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="getPluginHeaderEntry" ID="getPluginHeaderEntry"></a> | |
| 40 <h2>getPluginHeaderEntry</h2> | |
| 41 <b>getPluginHeaderEntry</b>(<i>plugin, entry, default</i>) | |
| 42 | |
| 43 <p> | |
| 44 Function to get an entry of the plugin header. | |
| 45 </p> | |
| 46 <dl> | |
| 47 | |
| 48 <dt><i>plugin</i> (module)</dt> | |
| 49 <dd> | |
| 50 reference to the plugin module | |
| 51 </dd> | |
| 52 <dt><i>entry</i> (str)</dt> | |
| 53 <dd> | |
| 54 name of the entry | |
| 55 </dd> | |
| 56 <dt><i>default</i> (Any)</dt> | |
| 57 <dd> | |
| 58 value to be returned if the entry does not exist | |
| 59 </dd> | |
| 60 </dl> | |
| 61 <dl> | |
| 62 <dt>Return:</dt> | |
| 63 <dd> | |
| 64 requested value | |
| 65 </dd> | |
| 66 </dl> | |
| 67 <dl> | |
| 68 <dt>Return Type:</dt> | |
| 69 <dd> | |
| 70 Any | |
| 71 </dd> | |
| 72 </dl> | |
| 73 <div align="right"><a href="#top">Up</a></div> | |
| 74 <hr /> | |
| 75 <hr /> | |
| 76 <a NAME="hasPluginHeaderEntry" ID="hasPluginHeaderEntry"></a> | |
| 77 <h2>hasPluginHeaderEntry</h2> | |
| 78 <b>hasPluginHeaderEntry</b>(<i>plugin, entry</i>) | |
| 79 | |
| 80 <p> | |
| 81 Function to check, if the plugin header contains the given entry. | |
| 82 </p> | |
| 83 <dl> | |
| 84 | |
| 85 <dt><i>plugin</i> (module)</dt> | |
| 86 <dd> | |
| 87 reference to the plugin module | |
| 88 </dd> | |
| 89 <dt><i>entry</i> (str)</dt> | |
| 90 <dd> | |
| 91 name of the entry | |
| 92 </dd> | |
| 93 </dl> | |
| 94 <dl> | |
| 95 <dt>Return:</dt> | |
| 96 <dd> | |
| 97 flag indicating the existence | |
| 98 </dd> | |
| 99 </dl> | |
| 100 <dl> | |
| 101 <dt>Return Type:</dt> | |
| 102 <dd> | |
| 103 bool | |
| 104 </dd> | |
| 105 </dl> | |
| 106 <div align="right"><a href="#top">Up</a></div> | |
| 107 <hr /> | |
| 108 </body></html> |
