Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.PluginWizardEricPlugin.html
src/eric7/Documentation/Source/eric7.Plugins.PluginWizardEricPlugin.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10064
- 8c3207703dac
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.PluginWizardEricPlugin</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.Plugins.PluginWizardEricPlugin</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the eric plug-in wizard plug-in. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#WizardEricPluginWizard">WizardEricPluginWizard</a></td> | |
| 25 <td>Class implementing the eric plug-in wizard plug-in.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="WizardEricPluginWizard" ID="WizardEricPluginWizard"></a> | |
| 36 <h2>WizardEricPluginWizard</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the eric plug-in wizard plug-in. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QObject | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#WizardEricPluginWizard.__init__">WizardEricPluginWizard</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#WizardEricPluginWizard.__callForm">__callForm</a></td> | |
| 63 <td>Private method to display a dialog and get the code.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#WizardEricPluginWizard.__handle">__handle</a></td> | |
| 67 <td>Private method to handle the wizards action.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#WizardEricPluginWizard.__initAction">__initAction</a></td> | |
| 71 <td>Private method to initialize the action.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#WizardEricPluginWizard.__initMenu">__initMenu</a></td> | |
| 75 <td>Private method to add the actions to the right menu.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#WizardEricPluginWizard.__initialize">__initialize</a></td> | |
| 79 <td>Private slot to (re)initialize the plug-in.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#WizardEricPluginWizard.activate">activate</a></td> | |
| 83 <td>Public method to activate this plug-in.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#WizardEricPluginWizard.deactivate">deactivate</a></td> | |
| 87 <td>Public method to deactivate this plug-in.</td> | |
| 88 </tr> | |
| 89 </table> | |
| 90 <h3>Static Methods</h3> | |
| 91 | |
| 92 <table> | |
| 93 <tr><td>None</td></tr> | |
| 94 </table> | |
| 95 | |
| 96 <a NAME="WizardEricPluginWizard.__init__" ID="WizardEricPluginWizard.__init__"></a> | |
| 97 <h4>WizardEricPluginWizard (Constructor)</h4> | |
| 98 <b>WizardEricPluginWizard</b>(<i>ui</i>) | |
| 99 | |
| 100 <p> | |
| 101 Constructor | |
| 102 </p> | |
| 103 <dl> | |
| 104 | |
| 105 <dt><i>ui</i></dt> | |
| 106 <dd> | |
| 107 reference to the user interface object (UI.UserInterface) | |
| 108 </dd> | |
| 109 </dl> | |
| 110 <a NAME="WizardEricPluginWizard.__callForm" ID="WizardEricPluginWizard.__callForm"></a> | |
| 111 <h4>WizardEricPluginWizard.__callForm</h4> | |
| 112 <b>__callForm</b>(<i>editor</i>) | |
| 113 | |
| 114 <p> | |
| 115 Private method to display a dialog and get the code. | |
| 116 </p> | |
| 117 <dl> | |
| 118 | |
| 119 <dt><i>editor</i></dt> | |
| 120 <dd> | |
| 121 reference to the current editor | |
| 122 </dd> | |
| 123 </dl> | |
| 124 <dl> | |
| 125 <dt>Return:</dt> | |
| 126 <dd> | |
| 127 generated code (string), the plug-in package name (string) | |
| 128 and a flag indicating success (boolean) | |
| 129 </dd> | |
| 130 </dl> | |
| 131 <a NAME="WizardEricPluginWizard.__handle" ID="WizardEricPluginWizard.__handle"></a> | |
| 132 <h4>WizardEricPluginWizard.__handle</h4> | |
| 133 <b>__handle</b>(<i></i>) | |
| 134 | |
| 135 <p> | |
| 136 Private method to handle the wizards action. | |
| 137 </p> | |
| 138 <a NAME="WizardEricPluginWizard.__initAction" ID="WizardEricPluginWizard.__initAction"></a> | |
| 139 <h4>WizardEricPluginWizard.__initAction</h4> | |
| 140 <b>__initAction</b>(<i></i>) | |
| 141 | |
| 142 <p> | |
| 143 Private method to initialize the action. | |
| 144 </p> | |
| 145 <a NAME="WizardEricPluginWizard.__initMenu" ID="WizardEricPluginWizard.__initMenu"></a> | |
| 146 <h4>WizardEricPluginWizard.__initMenu</h4> | |
| 147 <b>__initMenu</b>(<i></i>) | |
| 148 | |
| 149 <p> | |
| 150 Private method to add the actions to the right menu. | |
| 151 </p> | |
| 152 <a NAME="WizardEricPluginWizard.__initialize" ID="WizardEricPluginWizard.__initialize"></a> | |
| 153 <h4>WizardEricPluginWizard.__initialize</h4> | |
| 154 <b>__initialize</b>(<i></i>) | |
| 155 | |
| 156 <p> | |
| 157 Private slot to (re)initialize the plug-in. | |
| 158 </p> | |
| 159 <a NAME="WizardEricPluginWizard.activate" ID="WizardEricPluginWizard.activate"></a> | |
| 160 <h4>WizardEricPluginWizard.activate</h4> | |
| 161 <b>activate</b>(<i></i>) | |
| 162 | |
| 163 <p> | |
| 164 Public method to activate this plug-in. | |
| 165 </p> | |
| 166 <dl> | |
| 167 <dt>Return:</dt> | |
| 168 <dd> | |
| 169 tuple of None and activation status (boolean) | |
| 170 </dd> | |
| 171 </dl> | |
| 172 <a NAME="WizardEricPluginWizard.deactivate" ID="WizardEricPluginWizard.deactivate"></a> | |
| 173 <h4>WizardEricPluginWizard.deactivate</h4> | |
| 174 <b>deactivate</b>(<i></i>) | |
| 175 | |
| 176 <p> | |
| 177 Public method to deactivate this plug-in. | |
| 178 </p> | |
| 179 <div align="right"><a href="#top">Up</a></div> | |
| 180 <hr /> | |
| 181 </body></html> |
