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 10479
- 856476537696
- parent 10417
- c6011e501282
- child 10800
- c6ce5522be30
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 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 | |
| 11 <p> | 10 <p> |
| 12 Class documentation goes here. | 11 Class documentation goes here. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 <table> | |
| 16 <tr><td>__header__</td></tr> | |
| 17 <tr><td>error</td></tr> | |
| 18 <tr><td>mainTemplate</td></tr> | |
| 19 </table> | |
| 15 | 20 |
| 16 <table> | |
| 17 <tr><td>__header__</td></tr><tr><td>error</td></tr><tr><td>mainTemplate</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | 21 <h3>Classes</h3> |
| 20 | |
| 21 <table> | 22 <table> |
| 22 <tr><td>None</td></tr> | 23 <tr><td>None</td></tr> |
| 23 </table> | 24 </table> |
| 25 | |
| 24 <h3>Functions</h3> | 26 <h3>Functions</h3> |
| 25 | |
| 26 <table> | 27 <table> |
| 27 | |
| 28 <tr> | 28 <tr> |
| 29 <td><a href="#__init__">__init__</a></td> | 29 <td><a href="#__init__">__init__</a></td> |
| 30 <td>Constructor</td> | 30 <td>Constructor</td> |
| 31 </tr> | 31 </tr> |
| 32 <tr> | 32 <tr> |
| 48 <tr> | 48 <tr> |
| 49 <td><a href="#setPreferences">setPreferences</a></td> | 49 <td><a href="#setPreferences">setPreferences</a></td> |
| 50 <td>Module function to return the API files made available by this plug-in.</td> | 50 <td>Module function to return the API files made available by this plug-in.</td> |
| 51 </tr> | 51 </tr> |
| 52 </table> | 52 </table> |
| 53 | |
| 53 <hr /> | 54 <hr /> |
| 54 <hr /> | 55 <hr /> |
| 55 <a NAME="__init__" ID="__init__"></a> | 56 <a NAME="__init__" ID="__init__"></a> |
| 56 <h2>__init__</h2> | 57 <h2>__init__</h2> |
| 57 <b>__init__</b>(<i>self, ui</i>) | 58 <b>__init__</b>(<i>self, ui</i>) |
| 58 | |
| 59 <p> | 59 <p> |
| 60 Constructor | 60 Constructor |
| 61 </p> | 61 </p> |
| 62 | |
| 62 <dl> | 63 <dl> |
| 63 | 64 |
| 64 <dt><i>ui</i> (UI.UserInterface)</dt> | 65 <dt><i>ui</i> (UI.UserInterface)</dt> |
| 65 <dd> | 66 <dd> |
| 66 reference to the user interface object | 67 reference to the user interface object |
| 70 <hr /> | 71 <hr /> |
| 71 <hr /> | 72 <hr /> |
| 72 <a NAME="activate" ID="activate"></a> | 73 <a NAME="activate" ID="activate"></a> |
| 73 <h2>activate</h2> | 74 <h2>activate</h2> |
| 74 <b>activate</b>(<i>self</i>) | 75 <b>activate</b>(<i>self</i>) |
| 75 | |
| 76 <p> | 76 <p> |
| 77 Public method to activate this plug-in. | 77 Public method to activate this plug-in. |
| 78 </p> | 78 </p> |
| 79 | |
| 79 <dl> | 80 <dl> |
| 80 <dt>Return:</dt> | 81 <dt>Return:</dt> |
| 81 <dd> | 82 <dd> |
| 82 tuple of None and activation status | 83 tuple of None and activation status |
| 83 </dd> | 84 </dd> |
| 92 <hr /> | 93 <hr /> |
| 93 <hr /> | 94 <hr /> |
| 94 <a NAME="deactivate" ID="deactivate"></a> | 95 <a NAME="deactivate" ID="deactivate"></a> |
| 95 <h2>deactivate</h2> | 96 <h2>deactivate</h2> |
| 96 <b>deactivate</b>(<i>self</i>) | 97 <b>deactivate</b>(<i>self</i>) |
| 97 | |
| 98 <p> | 98 <p> |
| 99 Module function returning data as required by the configuration dialog. | 99 Module function returning data as required by the configuration dialog. |
| 100 </p> | 100 </p> |
| 101 | |
| 101 <dl> | 102 <dl> |
| 102 <dt>Return:</dt> | 103 <dt>Return:</dt> |
| 103 <dd> | 104 <dd> |
| 104 dictionary containing the relevant data | 105 dictionary containing the relevant data |
| 105 </dd> | 106 </dd> |
| 114 <hr /> | 115 <hr /> |
| 115 <hr /> | 116 <hr /> |
| 116 <a NAME="getPreferences" ID="getPreferences"></a> | 117 <a NAME="getPreferences" ID="getPreferences"></a> |
| 117 <h2>getPreferences</h2> | 118 <h2>getPreferences</h2> |
| 118 <b>getPreferences</b>(<i>self, key</i>) | 119 <b>getPreferences</b>(<i>self, key</i>) |
| 119 | |
| 120 <p> | 120 <p> |
| 121 Public method to retrieve the various settings values. | 121 Public method to retrieve the various settings values. |
| 122 </p> | 122 </p> |
| 123 | |
| 123 <dl> | 124 <dl> |
| 124 | 125 |
| 125 <dt><i>key</i> (str)</dt> | 126 <dt><i>key</i> (str)</dt> |
| 126 <dd> | 127 <dd> |
| 127 the key of the value to get | 128 the key of the value to get |
| 143 <hr /> | 144 <hr /> |
| 144 <hr /> | 145 <hr /> |
| 145 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | 146 <a NAME="prepareUninstall" ID="prepareUninstall"></a> |
| 146 <h2>prepareUninstall</h2> | 147 <h2>prepareUninstall</h2> |
| 147 <b>prepareUninstall</b>(<i></i>) | 148 <b>prepareUninstall</b>(<i></i>) |
| 148 | |
| 149 <p> | 149 <p> |
| 150 Module function to prepare for an un-installation. | 150 Module function to prepare for an un-installation. |
| 151 </p> | 151 </p> |
| 152 | |
| 152 <div align="right"><a href="#top">Up</a></div> | 153 <div align="right"><a href="#top">Up</a></div> |
| 153 <hr /> | 154 <hr /> |
| 154 <hr /> | 155 <hr /> |
| 155 <a NAME="setPreferences" ID="setPreferences"></a> | 156 <a NAME="setPreferences" ID="setPreferences"></a> |
| 156 <h2>setPreferences</h2> | 157 <h2>setPreferences</h2> |
| 157 <b>setPreferences</b>(<i>self, key, value</i>) | 158 <b>setPreferences</b>(<i>self, key, value</i>) |
| 158 | |
| 159 <p> | 159 <p> |
| 160 Module function to return the API files made available by this plug-in. | 160 Module function to return the API files made available by this plug-in. |
| 161 </p> | 161 </p> |
| 162 | |
| 162 <dl> | 163 <dl> |
| 163 | 164 |
| 164 <dt><i>language</i> (str)</dt> | 165 <dt><i>language</i> (str)</dt> |
| 165 <dd> | 166 <dd> |
| 166 language to get APIs for | 167 language to get APIs for |
