Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.PluginWizardE5MessageBox.html
eric6/Documentation/Source/eric6.Plugins.PluginWizardE5MessageBox.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.PluginWizardE5MessageBox</h1> | 23 <h1>eric6.Plugins.PluginWizardE5MessageBox</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the E5MessageBox wizard plugin. | 26 Module implementing the E5MessageBox wizard plugin. |
| 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>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>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="#E5MessageBoxWizard">E5MessageBoxWizard</a></td> | 38 <td><a href="#E5MessageBoxWizard">E5MessageBoxWizard</a></td> |
| 34 <td>Class implementing the E5MessageBox wizard plugin.</td> | 39 <td>Class implementing the E5MessageBox wizard plugin.</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="E5MessageBoxWizard" ID="E5MessageBoxWizard"></a> | 49 <a NAME="E5MessageBoxWizard" ID="E5MessageBoxWizard"></a> |
| 43 <h2>E5MessageBoxWizard</h2> | 50 <h2>E5MessageBoxWizard</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the E5MessageBox wizard plugin. | 53 Class implementing the E5MessageBox wizard plugin. |
| 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="#E5MessageBoxWizard.__init__">E5MessageBoxWizard</a></td> | 72 <td><a href="#E5MessageBoxWizard.__init__">E5MessageBoxWizard</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#E5MessageBoxWizard.__callForm">__callForm</a></td> | 76 <td><a href="#E5MessageBoxWizard.__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="#E5MessageBoxWizard.__handle">__handle</a></td> | 80 <td><a href="#E5MessageBoxWizard.__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="#E5MessageBoxWizard.__initAction">__initAction</a></td> | 84 <td><a href="#E5MessageBoxWizard.__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="#E5MessageBoxWizard.__initMenu">__initMenu</a></td> | 88 <td><a href="#E5MessageBoxWizard.__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="#E5MessageBoxWizard.activate">activate</a></td> | 92 <td><a href="#E5MessageBoxWizard.activate">activate</a></td> |
| 76 <td>Public method to activate this plugin.</td> | 93 <td>Public method to activate this plugin.</td> |
| 77 </tr><tr> | 94 </tr> |
| 95 <tr> | |
| 78 <td><a href="#E5MessageBoxWizard.deactivate">deactivate</a></td> | 96 <td><a href="#E5MessageBoxWizard.deactivate">deactivate</a></td> |
| 79 <td>Public method to deactivate this plugin.</td> | 97 <td>Public method to deactivate this plugin.</td> |
| 80 </tr> | 98 </tr> |
| 81 </table> | 99 </table> |
| 82 <h3>Static Methods</h3> | 100 <h3>Static Methods</h3> |
| 101 | |
| 83 <table> | 102 <table> |
| 84 <tr><td>None</td></tr> | 103 <tr><td>None</td></tr> |
| 85 </table> | 104 </table> |
| 105 | |
| 86 <a NAME="E5MessageBoxWizard.__init__" ID="E5MessageBoxWizard.__init__"></a> | 106 <a NAME="E5MessageBoxWizard.__init__" ID="E5MessageBoxWizard.__init__"></a> |
| 87 <h4>E5MessageBoxWizard (Constructor)</h4> | 107 <h4>E5MessageBoxWizard (Constructor)</h4> |
| 88 <b>E5MessageBoxWizard</b>(<i>ui</i>) | 108 <b>E5MessageBoxWizard</b>(<i>ui</i>) |
| 109 | |
| 89 <p> | 110 <p> |
| 90 Constructor | 111 Constructor |
| 91 </p><dl> | 112 </p> |
| 113 <dl> | |
| 114 | |
| 92 <dt><i>ui</i></dt> | 115 <dt><i>ui</i></dt> |
| 93 <dd> | 116 <dd> |
| 94 reference to the user interface object (UI.UserInterface) | 117 reference to the user interface object (UI.UserInterface) |
| 95 </dd> | 118 </dd> |
| 96 </dl><a NAME="E5MessageBoxWizard.__callForm" ID="E5MessageBoxWizard.__callForm"></a> | 119 </dl> |
| 120 <a NAME="E5MessageBoxWizard.__callForm" ID="E5MessageBoxWizard.__callForm"></a> | |
| 97 <h4>E5MessageBoxWizard.__callForm</h4> | 121 <h4>E5MessageBoxWizard.__callForm</h4> |
| 98 <b>__callForm</b>(<i>editor</i>) | 122 <b>__callForm</b>(<i>editor</i>) |
| 123 | |
| 99 <p> | 124 <p> |
| 100 Private method to display a dialog and get the code. | 125 Private method to display a dialog and get the code. |
| 101 </p><dl> | 126 </p> |
| 127 <dl> | |
| 128 | |
| 102 <dt><i>editor</i></dt> | 129 <dt><i>editor</i></dt> |
| 103 <dd> | 130 <dd> |
| 104 reference to the current editor | 131 reference to the current editor |
| 105 </dd> | 132 </dd> |
| 106 </dl><dl> | 133 </dl> |
| 134 <dl> | |
| 107 <dt>Returns:</dt> | 135 <dt>Returns:</dt> |
| 108 <dd> | 136 <dd> |
| 109 the generated code (string) | 137 the generated code (string) |
| 110 </dd> | 138 </dd> |
| 111 </dl><a NAME="E5MessageBoxWizard.__handle" ID="E5MessageBoxWizard.__handle"></a> | 139 </dl> |
| 140 <a NAME="E5MessageBoxWizard.__handle" ID="E5MessageBoxWizard.__handle"></a> | |
| 112 <h4>E5MessageBoxWizard.__handle</h4> | 141 <h4>E5MessageBoxWizard.__handle</h4> |
| 113 <b>__handle</b>(<i></i>) | 142 <b>__handle</b>(<i></i>) |
| 143 | |
| 114 <p> | 144 <p> |
| 115 Private method to handle the wizards action. | 145 Private method to handle the wizards action. |
| 116 </p><a NAME="E5MessageBoxWizard.__initAction" ID="E5MessageBoxWizard.__initAction"></a> | 146 </p> |
| 147 <a NAME="E5MessageBoxWizard.__initAction" ID="E5MessageBoxWizard.__initAction"></a> | |
| 117 <h4>E5MessageBoxWizard.__initAction</h4> | 148 <h4>E5MessageBoxWizard.__initAction</h4> |
| 118 <b>__initAction</b>(<i></i>) | 149 <b>__initAction</b>(<i></i>) |
| 150 | |
| 119 <p> | 151 <p> |
| 120 Private method to initialize the action. | 152 Private method to initialize the action. |
| 121 </p><a NAME="E5MessageBoxWizard.__initMenu" ID="E5MessageBoxWizard.__initMenu"></a> | 153 </p> |
| 154 <a NAME="E5MessageBoxWizard.__initMenu" ID="E5MessageBoxWizard.__initMenu"></a> | |
| 122 <h4>E5MessageBoxWizard.__initMenu</h4> | 155 <h4>E5MessageBoxWizard.__initMenu</h4> |
| 123 <b>__initMenu</b>(<i></i>) | 156 <b>__initMenu</b>(<i></i>) |
| 157 | |
| 124 <p> | 158 <p> |
| 125 Private method to add the actions to the right menu. | 159 Private method to add the actions to the right menu. |
| 126 </p><a NAME="E5MessageBoxWizard.activate" ID="E5MessageBoxWizard.activate"></a> | 160 </p> |
| 161 <a NAME="E5MessageBoxWizard.activate" ID="E5MessageBoxWizard.activate"></a> | |
| 127 <h4>E5MessageBoxWizard.activate</h4> | 162 <h4>E5MessageBoxWizard.activate</h4> |
| 128 <b>activate</b>(<i></i>) | 163 <b>activate</b>(<i></i>) |
| 164 | |
| 129 <p> | 165 <p> |
| 130 Public method to activate this plugin. | 166 Public method to activate this plugin. |
| 131 </p><dl> | 167 </p> |
| 168 <dl> | |
| 132 <dt>Returns:</dt> | 169 <dt>Returns:</dt> |
| 133 <dd> | 170 <dd> |
| 134 tuple of None and activation status (boolean) | 171 tuple of None and activation status (boolean) |
| 135 </dd> | 172 </dd> |
| 136 </dl><a NAME="E5MessageBoxWizard.deactivate" ID="E5MessageBoxWizard.deactivate"></a> | 173 </dl> |
| 174 <a NAME="E5MessageBoxWizard.deactivate" ID="E5MessageBoxWizard.deactivate"></a> | |
| 137 <h4>E5MessageBoxWizard.deactivate</h4> | 175 <h4>E5MessageBoxWizard.deactivate</h4> |
| 138 <b>deactivate</b>(<i></i>) | 176 <b>deactivate</b>(<i></i>) |
| 177 | |
| 139 <p> | 178 <p> |
| 140 Public method to deactivate this plugin. | 179 Public method to deactivate this plugin. |
| 141 </p> | 180 </p> |
| 142 <div align="right"><a href="#top">Up</a></div> | 181 <div align="right"><a href="#top">Up</a></div> |
| 143 <hr /> | 182 <hr /> |
