Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.PluginWizardSetup.html
eric6/Documentation/Source/eric6.Plugins.PluginWizardSetup.html
- changeset 7273
- 391d6b7b1eff
- parent 7204
- cbf6d88004ce
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.PluginWizardSetup</h1> | 23 <h1>eric6.Plugins.PluginWizardSetup</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the setup.py wizard plug-in. | 26 Module implementing the setup.py wizard plug-in. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <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>shortDescription</td></tr><tr><td>version</td></tr> | 31 <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> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#SetupWizard">SetupWizard</a></td> | 38 <td><a href="#SetupWizard">SetupWizard</a></td> |
| 34 <td>Class implementing the setup.py wizard plug-in.</td> | 39 <td>Class implementing the setup.py wizard plug-in.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 43 | |
| 38 <table> | 44 <table> |
| 39 <tr><td>None</td></tr> | 45 <tr><td>None</td></tr> |
| 40 </table> | 46 </table> |
| 41 <hr /><hr /> | 47 <hr /> |
| 48 <hr /> | |
| 42 <a NAME="SetupWizard" ID="SetupWizard"></a> | 49 <a NAME="SetupWizard" ID="SetupWizard"></a> |
| 43 <h2>SetupWizard</h2> | 50 <h2>SetupWizard</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the setup.py wizard plug-in. | 53 Class implementing the setup.py wizard plug-in. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 QObject | 56 QObject |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>None</td></tr> | 60 <tr><td>None</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 68 | |
| 58 <table> | 69 <table> |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#SetupWizard.__init__">SetupWizard</a></td> | 72 <td><a href="#SetupWizard.__init__">SetupWizard</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#SetupWizard.__callForm">__callForm</a></td> | 76 <td><a href="#SetupWizard.__callForm">__callForm</a></td> |
| 64 <td>Private method to display a dialog and get the code.</td> | 77 <td>Private method to display a dialog and get the code.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#SetupWizard.__handle">__handle</a></td> | 80 <td><a href="#SetupWizard.__handle">__handle</a></td> |
| 67 <td>Private method to handle the wizards action.</td> | 81 <td>Private method to handle the wizards action.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#SetupWizard.__initAction">__initAction</a></td> | 84 <td><a href="#SetupWizard.__initAction">__initAction</a></td> |
| 70 <td>Private method to initialize the action.</td> | 85 <td>Private method to initialize the action.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#SetupWizard.__initMenu">__initMenu</a></td> | 88 <td><a href="#SetupWizard.__initMenu">__initMenu</a></td> |
| 73 <td>Private method to add the actions to the right menu.</td> | 89 <td>Private method to add the actions to the right menu.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#SetupWizard.__initialize">__initialize</a></td> | 92 <td><a href="#SetupWizard.__initialize">__initialize</a></td> |
| 76 <td>Private slot to (re)initialize the plug-in.</td> | 93 <td>Private slot to (re)initialize the plug-in.</td> |
| 77 </tr><tr> | 94 </tr> |
| 95 <tr> | |
| 78 <td><a href="#SetupWizard.activate">activate</a></td> | 96 <td><a href="#SetupWizard.activate">activate</a></td> |
| 79 <td>Public method to activate this plug-in.</td> | 97 <td>Public method to activate this plug-in.</td> |
| 80 </tr><tr> | 98 </tr> |
| 99 <tr> | |
| 81 <td><a href="#SetupWizard.deactivate">deactivate</a></td> | 100 <td><a href="#SetupWizard.deactivate">deactivate</a></td> |
| 82 <td>Public method to deactivate this plug-in.</td> | 101 <td>Public method to deactivate this plug-in.</td> |
| 83 </tr> | 102 </tr> |
| 84 </table> | 103 </table> |
| 85 <h3>Static Methods</h3> | 104 <h3>Static Methods</h3> |
| 105 | |
| 86 <table> | 106 <table> |
| 87 <tr><td>None</td></tr> | 107 <tr><td>None</td></tr> |
| 88 </table> | 108 </table> |
| 109 | |
| 89 <a NAME="SetupWizard.__init__" ID="SetupWizard.__init__"></a> | 110 <a NAME="SetupWizard.__init__" ID="SetupWizard.__init__"></a> |
| 90 <h4>SetupWizard (Constructor)</h4> | 111 <h4>SetupWizard (Constructor)</h4> |
| 91 <b>SetupWizard</b>(<i>ui</i>) | 112 <b>SetupWizard</b>(<i>ui</i>) |
| 113 | |
| 92 <p> | 114 <p> |
| 93 Constructor | 115 Constructor |
| 94 </p><dl> | 116 </p> |
| 117 <dl> | |
| 118 | |
| 95 <dt><i>ui</i></dt> | 119 <dt><i>ui</i></dt> |
| 96 <dd> | 120 <dd> |
| 97 reference to the user interface object (UI.UserInterface) | 121 reference to the user interface object (UI.UserInterface) |
| 98 </dd> | 122 </dd> |
| 99 </dl><a NAME="SetupWizard.__callForm" ID="SetupWizard.__callForm"></a> | 123 </dl> |
| 124 <a NAME="SetupWizard.__callForm" ID="SetupWizard.__callForm"></a> | |
| 100 <h4>SetupWizard.__callForm</h4> | 125 <h4>SetupWizard.__callForm</h4> |
| 101 <b>__callForm</b>(<i>editor</i>) | 126 <b>__callForm</b>(<i>editor</i>) |
| 127 | |
| 102 <p> | 128 <p> |
| 103 Private method to display a dialog and get the code. | 129 Private method to display a dialog and get the code. |
| 104 </p><dl> | 130 </p> |
| 131 <dl> | |
| 132 | |
| 105 <dt><i>editor</i></dt> | 133 <dt><i>editor</i></dt> |
| 106 <dd> | 134 <dd> |
| 107 reference to the current editor | 135 reference to the current editor |
| 108 </dd> | 136 </dd> |
| 109 </dl><dl> | 137 </dl> |
| 138 <dl> | |
| 110 <dt>Returns:</dt> | 139 <dt>Returns:</dt> |
| 111 <dd> | 140 <dd> |
| 112 the generated code (string) | 141 the generated code (string) |
| 113 </dd> | 142 </dd> |
| 114 </dl><a NAME="SetupWizard.__handle" ID="SetupWizard.__handle"></a> | 143 </dl> |
| 144 <a NAME="SetupWizard.__handle" ID="SetupWizard.__handle"></a> | |
| 115 <h4>SetupWizard.__handle</h4> | 145 <h4>SetupWizard.__handle</h4> |
| 116 <b>__handle</b>(<i></i>) | 146 <b>__handle</b>(<i></i>) |
| 147 | |
| 117 <p> | 148 <p> |
| 118 Private method to handle the wizards action. | 149 Private method to handle the wizards action. |
| 119 </p><a NAME="SetupWizard.__initAction" ID="SetupWizard.__initAction"></a> | 150 </p> |
| 151 <a NAME="SetupWizard.__initAction" ID="SetupWizard.__initAction"></a> | |
| 120 <h4>SetupWizard.__initAction</h4> | 152 <h4>SetupWizard.__initAction</h4> |
| 121 <b>__initAction</b>(<i></i>) | 153 <b>__initAction</b>(<i></i>) |
| 154 | |
| 122 <p> | 155 <p> |
| 123 Private method to initialize the action. | 156 Private method to initialize the action. |
| 124 </p><a NAME="SetupWizard.__initMenu" ID="SetupWizard.__initMenu"></a> | 157 </p> |
| 158 <a NAME="SetupWizard.__initMenu" ID="SetupWizard.__initMenu"></a> | |
| 125 <h4>SetupWizard.__initMenu</h4> | 159 <h4>SetupWizard.__initMenu</h4> |
| 126 <b>__initMenu</b>(<i></i>) | 160 <b>__initMenu</b>(<i></i>) |
| 161 | |
| 127 <p> | 162 <p> |
| 128 Private method to add the actions to the right menu. | 163 Private method to add the actions to the right menu. |
| 129 </p><a NAME="SetupWizard.__initialize" ID="SetupWizard.__initialize"></a> | 164 </p> |
| 165 <a NAME="SetupWizard.__initialize" ID="SetupWizard.__initialize"></a> | |
| 130 <h4>SetupWizard.__initialize</h4> | 166 <h4>SetupWizard.__initialize</h4> |
| 131 <b>__initialize</b>(<i></i>) | 167 <b>__initialize</b>(<i></i>) |
| 168 | |
| 132 <p> | 169 <p> |
| 133 Private slot to (re)initialize the plug-in. | 170 Private slot to (re)initialize the plug-in. |
| 134 </p><a NAME="SetupWizard.activate" ID="SetupWizard.activate"></a> | 171 </p> |
| 172 <a NAME="SetupWizard.activate" ID="SetupWizard.activate"></a> | |
| 135 <h4>SetupWizard.activate</h4> | 173 <h4>SetupWizard.activate</h4> |
| 136 <b>activate</b>(<i></i>) | 174 <b>activate</b>(<i></i>) |
| 175 | |
| 137 <p> | 176 <p> |
| 138 Public method to activate this plug-in. | 177 Public method to activate this plug-in. |
| 139 </p><dl> | 178 </p> |
| 179 <dl> | |
| 140 <dt>Returns:</dt> | 180 <dt>Returns:</dt> |
| 141 <dd> | 181 <dd> |
| 142 tuple of None and activation status (boolean) | 182 tuple of None and activation status (boolean) |
| 143 </dd> | 183 </dd> |
| 144 </dl><a NAME="SetupWizard.deactivate" ID="SetupWizard.deactivate"></a> | 184 </dl> |
| 185 <a NAME="SetupWizard.deactivate" ID="SetupWizard.deactivate"></a> | |
| 145 <h4>SetupWizard.deactivate</h4> | 186 <h4>SetupWizard.deactivate</h4> |
| 146 <b>deactivate</b>(<i></i>) | 187 <b>deactivate</b>(<i></i>) |
| 188 | |
| 147 <p> | 189 <p> |
| 148 Public method to deactivate this plug-in. | 190 Public method to deactivate this plug-in. |
| 149 </p> | 191 </p> |
| 150 <div align="right"><a href="#top">Up</a></div> | 192 <div align="right"><a href="#top">Up</a></div> |
| 151 <hr /> | 193 <hr /> |
