Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Plugins.PluginWizardEricPlugin.html
Documentation/Source/eric6.Plugins.PluginWizardEricPlugin.html
- changeset 6016
- 3d594f66a7f7
equal
deleted
inserted
replaced
| 6015:26fc8e08f4ac | 6016:3d594f66a7f7 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Plugins.PluginWizardEricPlugin</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.PluginWizardEricPlugin</h1> | |
| 23 <p> | |
| 24 Module implementing the eric plug-in wizard plug-in. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <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>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#WizardEricPluginWizard">WizardEricPluginWizard</a></td> | |
| 34 <td>Class implementing the eric plug-in wizard plug-in.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="WizardEricPluginWizard" ID="WizardEricPluginWizard"></a> | |
| 43 <h2>WizardEricPluginWizard</h2> | |
| 44 <p> | |
| 45 Class implementing the eric plug-in wizard plug-in. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QObject | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#WizardEricPluginWizard.__init__">WizardEricPluginWizard</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#WizardEricPluginWizard.__callForm">__callForm</a></td> | |
| 64 <td>Private method to display a dialog and get the code.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#WizardEricPluginWizard.__handle">__handle</a></td> | |
| 67 <td>Private method to handle the wizards action.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#WizardEricPluginWizard.__initAction">__initAction</a></td> | |
| 70 <td>Private method to initialize the action.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#WizardEricPluginWizard.__initMenu">__initMenu</a></td> | |
| 73 <td>Private method to add the actions to the right menu.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#WizardEricPluginWizard.__initialize">__initialize</a></td> | |
| 76 <td>Private slot to (re)initialize the plug-in.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#WizardEricPluginWizard.activate">activate</a></td> | |
| 79 <td>Public method to activate this plug-in.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#WizardEricPluginWizard.deactivate">deactivate</a></td> | |
| 82 <td>Public method to deactivate this plug-in.</td> | |
| 83 </tr> | |
| 84 </table> | |
| 85 <h3>Static Methods</h3> | |
| 86 <table> | |
| 87 <tr><td>None</td></tr> | |
| 88 </table> | |
| 89 <a NAME="WizardEricPluginWizard.__init__" ID="WizardEricPluginWizard.__init__"></a> | |
| 90 <h4>WizardEricPluginWizard (Constructor)</h4> | |
| 91 <b>WizardEricPluginWizard</b>(<i>ui</i>) | |
| 92 <p> | |
| 93 Constructor | |
| 94 </p><dl> | |
| 95 <dt><i>ui</i></dt> | |
| 96 <dd> | |
| 97 reference to the user interface object (UI.UserInterface) | |
| 98 </dd> | |
| 99 </dl><a NAME="WizardEricPluginWizard.__callForm" ID="WizardEricPluginWizard.__callForm"></a> | |
| 100 <h4>WizardEricPluginWizard.__callForm</h4> | |
| 101 <b>__callForm</b>(<i>editor</i>) | |
| 102 <p> | |
| 103 Private method to display a dialog and get the code. | |
| 104 </p><dl> | |
| 105 <dt><i>editor</i></dt> | |
| 106 <dd> | |
| 107 reference to the current editor | |
| 108 </dd> | |
| 109 </dl><dl> | |
| 110 <dt>Returns:</dt> | |
| 111 <dd> | |
| 112 generated code (string), the plug-in package name (string) | |
| 113 and a flag indicating success (boolean) | |
| 114 </dd> | |
| 115 </dl><a NAME="WizardEricPluginWizard.__handle" ID="WizardEricPluginWizard.__handle"></a> | |
| 116 <h4>WizardEricPluginWizard.__handle</h4> | |
| 117 <b>__handle</b>(<i></i>) | |
| 118 <p> | |
| 119 Private method to handle the wizards action. | |
| 120 </p><a NAME="WizardEricPluginWizard.__initAction" ID="WizardEricPluginWizard.__initAction"></a> | |
| 121 <h4>WizardEricPluginWizard.__initAction</h4> | |
| 122 <b>__initAction</b>(<i></i>) | |
| 123 <p> | |
| 124 Private method to initialize the action. | |
| 125 </p><a NAME="WizardEricPluginWizard.__initMenu" ID="WizardEricPluginWizard.__initMenu"></a> | |
| 126 <h4>WizardEricPluginWizard.__initMenu</h4> | |
| 127 <b>__initMenu</b>(<i></i>) | |
| 128 <p> | |
| 129 Private method to add the actions to the right menu. | |
| 130 </p><a NAME="WizardEricPluginWizard.__initialize" ID="WizardEricPluginWizard.__initialize"></a> | |
| 131 <h4>WizardEricPluginWizard.__initialize</h4> | |
| 132 <b>__initialize</b>(<i></i>) | |
| 133 <p> | |
| 134 Private slot to (re)initialize the plug-in. | |
| 135 </p><a NAME="WizardEricPluginWizard.activate" ID="WizardEricPluginWizard.activate"></a> | |
| 136 <h4>WizardEricPluginWizard.activate</h4> | |
| 137 <b>activate</b>(<i></i>) | |
| 138 <p> | |
| 139 Public method to activate this plug-in. | |
| 140 </p><dl> | |
| 141 <dt>Returns:</dt> | |
| 142 <dd> | |
| 143 tuple of None and activation status (boolean) | |
| 144 </dd> | |
| 145 </dl><a NAME="WizardEricPluginWizard.deactivate" ID="WizardEricPluginWizard.deactivate"></a> | |
| 146 <h4>WizardEricPluginWizard.deactivate</h4> | |
| 147 <b>deactivate</b>(<i></i>) | |
| 148 <p> | |
| 149 Public method to deactivate this plug-in. | |
| 150 </p> | |
| 151 <div align="right"><a href="#top">Up</a></div> | |
| 152 <hr /> | |
| 153 </body></html> |
