Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html
src/eric7/Documentation/Source/eric7.Plugins.WizardPlugins.EricPluginWizard.Templates.html
- branch
- eric7
- changeset 10259
- b51dfacef37f
- parent 9209
- b99e7fd55fd3
- child 10417
- c6011e501282
equal
deleted
inserted
replaced
| 10258:e7764f992a01 | 10259:b51dfacef37f |
|---|---|
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.Plugins.WizardPlugins.EricPluginWizard.Templates</h1> | 9 <h1>eric7.Plugins.WizardPlugins.EricPluginWizard.Templates</h1> |
| 10 | 10 |
| 11 <p> | 11 <p> |
| 12 Module implementing the various plug-in templates. | 12 Class documentation goes here. |
| 13 </p> | 13 </p> |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | 15 |
| 16 <table> | 16 <table> |
| 17 <tr><td>apiFilesTemplate</td></tr><tr><td>configTemplate0</td></tr><tr><td>configTemplate1</td></tr><tr><td>configTemplate2</td></tr><tr><td>configTemplate3</td></tr><tr><td>exeDisplayDataInfoTemplate</td></tr><tr><td>exeDisplayDataListTemplate</td></tr><tr><td>exeDisplayDataTemplate</td></tr><tr><td>mainTemplate</td></tr><tr><td>moduleSetupTemplate</td></tr><tr><td>onDemandTemplate</td></tr><tr><td>previewPixmapTemplate</td></tr> | 17 <tr><td>__header__</td></tr><tr><td>error</td></tr><tr><td>mainTemplate</td></tr> |
| 18 </table> | 18 </table> |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 |
| 21 <table> | 21 <table> |
| 22 <tr><td>None</td></tr> | 22 <tr><td>None</td></tr> |
| 23 </table> | 23 </table> |
| 24 <h3>Functions</h3> | 24 <h3>Functions</h3> |
| 25 | 25 |
| 26 <table> | 26 <table> |
| 27 <tr><td>None</td></tr> | 27 |
| 28 <tr> | |
| 29 <td><a href="#__init__">__init__</a></td> | |
| 30 <td>Constructor</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#activate">activate</a></td> | |
| 34 <td>Public method to activate this plug-in.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#deactivate">deactivate</a></td> | |
| 38 <td>Module function returning data as required by the configuration dialog.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#getPreferences">getPreferences</a></td> | |
| 42 <td>Public method to retrieve the various settings values.</td> | |
| 43 </tr> | |
| 44 <tr> | |
| 45 <td><a href="#prepareUninstall">prepareUninstall</a></td> | |
| 46 <td>Module function to prepare for an un-installation.</td> | |
| 47 </tr> | |
| 48 <tr> | |
| 49 <td><a href="#setPreferences">setPreferences</a></td> | |
| 50 <td>Module function to return the API files made available by this plug-in.</td> | |
| 51 </tr> | |
| 28 </table> | 52 </table> |
| 29 <hr /> | 53 <hr /> |
| 54 <hr /> | |
| 55 <a NAME="__init__" ID="__init__"></a> | |
| 56 <h2>__init__</h2> | |
| 57 <b>__init__</b>(<i>self, ui</i>) | |
| 58 | |
| 59 <p> | |
| 60 Constructor | |
| 61 </p> | |
| 62 <dl> | |
| 63 | |
| 64 <dt><i>ui</i> (UI.UserInterface)</dt> | |
| 65 <dd> | |
| 66 reference to the user interface object | |
| 67 </dd> | |
| 68 </dl> | |
| 69 <div align="right"><a href="#top">Up</a></div> | |
| 70 <hr /> | |
| 71 <hr /> | |
| 72 <a NAME="activate" ID="activate"></a> | |
| 73 <h2>activate</h2> | |
| 74 <b>activate</b>(<i>self</i>) | |
| 75 | |
| 76 <p> | |
| 77 Public method to activate this plug-in. | |
| 78 </p> | |
| 79 <dl> | |
| 80 <dt>Return:</dt> | |
| 81 <dd> | |
| 82 tuple of None and activation status | |
| 83 </dd> | |
| 84 </dl> | |
| 85 <dl> | |
| 86 <dt>Return Type:</dt> | |
| 87 <dd> | |
| 88 bool | |
| 89 </dd> | |
| 90 </dl> | |
| 91 <div align="right"><a href="#top">Up</a></div> | |
| 92 <hr /> | |
| 93 <hr /> | |
| 94 <a NAME="deactivate" ID="deactivate"></a> | |
| 95 <h2>deactivate</h2> | |
| 96 <b>deactivate</b>(<i>self</i>) | |
| 97 | |
| 98 <p> | |
| 99 Module function returning data as required by the configuration dialog. | |
| 100 </p> | |
| 101 <dl> | |
| 102 <dt>Return:</dt> | |
| 103 <dd> | |
| 104 dictionary containing the relevant data | |
| 105 </dd> | |
| 106 </dl> | |
| 107 <dl> | |
| 108 <dt>Return Type:</dt> | |
| 109 <dd> | |
| 110 dict | |
| 111 </dd> | |
| 112 </dl> | |
| 113 <div align="right"><a href="#top">Up</a></div> | |
| 114 <hr /> | |
| 115 <hr /> | |
| 116 <a NAME="getPreferences" ID="getPreferences"></a> | |
| 117 <h2>getPreferences</h2> | |
| 118 <b>getPreferences</b>(<i>self, key</i>) | |
| 119 | |
| 120 <p> | |
| 121 Public method to retrieve the various settings values. | |
| 122 </p> | |
| 123 <dl> | |
| 124 | |
| 125 <dt><i>key</i> (str)</dt> | |
| 126 <dd> | |
| 127 the key of the value to get | |
| 128 </dd> | |
| 129 </dl> | |
| 130 <dl> | |
| 131 <dt>Return:</dt> | |
| 132 <dd> | |
| 133 the requested setting value | |
| 134 </dd> | |
| 135 </dl> | |
| 136 <dl> | |
| 137 <dt>Return Type:</dt> | |
| 138 <dd> | |
| 139 any | |
| 140 </dd> | |
| 141 </dl> | |
| 142 <div align="right"><a href="#top">Up</a></div> | |
| 143 <hr /> | |
| 144 <hr /> | |
| 145 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | |
| 146 <h2>prepareUninstall</h2> | |
| 147 <b>prepareUninstall</b>(<i></i>) | |
| 148 | |
| 149 <p> | |
| 150 Module function to prepare for an un-installation. | |
| 151 </p> | |
| 152 <div align="right"><a href="#top">Up</a></div> | |
| 153 <hr /> | |
| 154 <hr /> | |
| 155 <a NAME="setPreferences" ID="setPreferences"></a> | |
| 156 <h2>setPreferences</h2> | |
| 157 <b>setPreferences</b>(<i>self, key, value</i>) | |
| 158 | |
| 159 <p> | |
| 160 Module function to return the API files made available by this plug-in. | |
| 161 </p> | |
| 162 <dl> | |
| 163 | |
| 164 <dt><i>language</i> (str)</dt> | |
| 165 <dd> | |
| 166 language to get APIs for | |
| 167 </dd> | |
| 168 </dl> | |
| 169 <dl> | |
| 170 <dt>Return:</dt> | |
| 171 <dd> | |
| 172 list of API filenames | |
| 173 </dd> | |
| 174 </dl> | |
| 175 <dl> | |
| 176 <dt>Return Type:</dt> | |
| 177 <dd> | |
| 178 list of str | |
| 179 </dd> | |
| 180 </dl> | |
| 181 <div align="right"><a href="#top">Up</a></div> | |
| 182 <hr /> | |
| 30 </body></html> | 183 </body></html> |
