Mercurial Repositories > Selection Encloser Tool / file comparison
comparison: SelectionEncloser/Documentation/source/Plugin_Tools_Selection_Encloser.PluginSelectionEncloser.html
SelectionEncloser/Documentation/source/Plugin_Tools_Selection_Encloser.PluginSelectionEncloser.html
- branch
- eric7
- changeset 51
- 318d7ebbdce2
- parent 46
- c12f1feea96a
- child 53
- ceb9ed8084db
equal
deleted
inserted
replaced
| 50:face142f8fa5 | 51:318d7ebbdce2 |
|---|---|
| 146 <p> | 146 <p> |
| 147 Constructor | 147 Constructor |
| 148 </p> | 148 </p> |
| 149 <dl> | 149 <dl> |
| 150 | 150 |
| 151 <dt><i>ui</i></dt> | 151 <dt><i>ui</i> (UserInterface)</dt> |
| 152 <dd> | 152 <dd> |
| 153 reference to the user interface object (UI.UserInterface) | 153 reference to the user interface object |
| 154 </dd> | 154 </dd> |
| 155 </dl> | 155 </dl> |
| 156 <a NAME="SelectionEncloserPlugin.__editorClosed" ID="SelectionEncloserPlugin.__editorClosed"></a> | 156 <a NAME="SelectionEncloserPlugin.__editorClosed" ID="SelectionEncloserPlugin.__editorClosed"></a> |
| 157 <h4>SelectionEncloserPlugin.__editorClosed</h4> | 157 <h4>SelectionEncloserPlugin.__editorClosed</h4> |
| 158 <b>__editorClosed</b>(<i>editor</i>) | 158 <b>__editorClosed</b>(<i>editor</i>) |
| 160 <p> | 160 <p> |
| 161 Private slot called, when an editor was closed. | 161 Private slot called, when an editor was closed. |
| 162 </p> | 162 </p> |
| 163 <dl> | 163 <dl> |
| 164 | 164 |
| 165 <dt><i>editor</i></dt> | 165 <dt><i>editor</i> (Editor)</dt> |
| 166 <dd> | 166 <dd> |
| 167 reference to the editor (QScintilla.Editor) | 167 reference to the editor |
| 168 </dd> | 168 </dd> |
| 169 </dl> | 169 </dl> |
| 170 <a NAME="SelectionEncloserPlugin.__editorOpened" ID="SelectionEncloserPlugin.__editorOpened"></a> | 170 <a NAME="SelectionEncloserPlugin.__editorOpened" ID="SelectionEncloserPlugin.__editorOpened"></a> |
| 171 <h4>SelectionEncloserPlugin.__editorOpened</h4> | 171 <h4>SelectionEncloserPlugin.__editorOpened</h4> |
| 172 <b>__editorOpened</b>(<i>editor</i>) | 172 <b>__editorOpened</b>(<i>editor</i>) |
| 174 <p> | 174 <p> |
| 175 Private slot called, when a new editor was opened. | 175 Private slot called, when a new editor was opened. |
| 176 </p> | 176 </p> |
| 177 <dl> | 177 <dl> |
| 178 | 178 |
| 179 <dt><i>editor</i></dt> | 179 <dt><i>editor</i> (Editor)</dt> |
| 180 <dd> | 180 <dd> |
| 181 reference to the new editor (QScintilla.Editor) | 181 reference to the new editor |
| 182 </dd> | 182 </dd> |
| 183 </dl> | 183 </dl> |
| 184 <a NAME="SelectionEncloserPlugin.__editorShowMenu" ID="SelectionEncloserPlugin.__editorShowMenu"></a> | 184 <a NAME="SelectionEncloserPlugin.__editorShowMenu" ID="SelectionEncloserPlugin.__editorShowMenu"></a> |
| 185 <h4>SelectionEncloserPlugin.__editorShowMenu</h4> | 185 <h4>SelectionEncloserPlugin.__editorShowMenu</h4> |
| 186 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) | 186 <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) |
| 189 Private slot called, when the the editor context menu or a submenu is | 189 Private slot called, when the the editor context menu or a submenu is |
| 190 about to be shown. | 190 about to be shown. |
| 191 </p> | 191 </p> |
| 192 <dl> | 192 <dl> |
| 193 | 193 |
| 194 <dt><i>menuName</i></dt> | 194 <dt><i>menuName</i> (str)</dt> |
| 195 <dd> | 195 <dd> |
| 196 name of the menu to be shown (string) | 196 name of the menu to be shown |
| 197 </dd> | 197 </dd> |
| 198 <dt><i>menu</i></dt> | 198 <dt><i>menu</i> (QMenu)</dt> |
| 199 <dd> | 199 <dd> |
| 200 reference to the menu (QMenu) | 200 reference to the menu |
| 201 </dd> | 201 </dd> |
| 202 <dt><i>editor</i></dt> | 202 <dt><i>editor</i> (Editor)</dt> |
| 203 <dd> | 203 <dd> |
| 204 reference to the editor | 204 reference to the editor |
| 205 </dd> | 205 </dd> |
| 206 </dl> | 206 </dl> |
| 207 <a NAME="SelectionEncloserPlugin.__encloseSelection" ID="SelectionEncloserPlugin.__encloseSelection"></a> | 207 <a NAME="SelectionEncloserPlugin.__encloseSelection" ID="SelectionEncloserPlugin.__encloseSelection"></a> |
| 208 <h4>SelectionEncloserPlugin.__encloseSelection</h4> | 208 <h4>SelectionEncloserPlugin.__encloseSelection</h4> |
| 209 <b>__encloseSelection</b>(<i></i>) | 209 <b>__encloseSelection</b>(<i>act</i>) |
| 210 | 210 |
| 211 <p> | 211 <p> |
| 212 Private slot to enclose the selection with the selected string. | 212 Private slot to enclose the selection with the selected string. |
| 213 </p> | 213 </p> |
| 214 <dl> | |
| 215 | |
| 216 <dt><i>act</i> (QAction)</dt> | |
| 217 <dd> | |
| 218 action that triggered | |
| 219 </dd> | |
| 220 </dl> | |
| 214 <a NAME="SelectionEncloserPlugin.__initMenu" ID="SelectionEncloserPlugin.__initMenu"></a> | 221 <a NAME="SelectionEncloserPlugin.__initMenu" ID="SelectionEncloserPlugin.__initMenu"></a> |
| 215 <h4>SelectionEncloserPlugin.__initMenu</h4> | 222 <h4>SelectionEncloserPlugin.__initMenu</h4> |
| 216 <b>__initMenu</b>(<i></i>) | 223 <b>__initMenu</b>(<i></i>) |
| 217 | 224 |
| 218 <p> | 225 <p> |
| 232 <p> | 239 <p> |
| 233 Private slot to populate the tools menu with our entry. | 240 Private slot to populate the tools menu with our entry. |
| 234 </p> | 241 </p> |
| 235 <dl> | 242 <dl> |
| 236 | 243 |
| 237 <dt><i>name</i></dt> | 244 <dt><i>name</i> (str)</dt> |
| 238 <dd> | 245 <dd> |
| 239 name of the menu (string) | 246 name of the menu |
| 240 </dd> | 247 </dd> |
| 241 <dt><i>menu</i></dt> | 248 <dt><i>menu</i> (QMenu)</dt> |
| 242 <dd> | 249 <dd> |
| 243 reference to the menu to be populated (QMenu) | 250 reference to the menu to be populated |
| 244 </dd> | 251 </dd> |
| 245 </dl> | 252 </dl> |
| 246 <a NAME="SelectionEncloserPlugin.__showMenu" ID="SelectionEncloserPlugin.__showMenu"></a> | 253 <a NAME="SelectionEncloserPlugin.__showMenu" ID="SelectionEncloserPlugin.__showMenu"></a> |
| 247 <h4>SelectionEncloserPlugin.__showMenu</h4> | 254 <h4>SelectionEncloserPlugin.__showMenu</h4> |
| 248 <b>__showMenu</b>(<i></i>) | 255 <b>__showMenu</b>(<i></i>) |
| 258 Public method to activate this plugin. | 265 Public method to activate this plugin. |
| 259 </p> | 266 </p> |
| 260 <dl> | 267 <dl> |
| 261 <dt>Return:</dt> | 268 <dt>Return:</dt> |
| 262 <dd> | 269 <dd> |
| 263 tuple of None and activation status (boolean) | 270 tuple of None and activation status |
| 271 </dd> | |
| 272 </dl> | |
| 273 <dl> | |
| 274 <dt>Return Type:</dt> | |
| 275 <dd> | |
| 276 (None, bool) | |
| 264 </dd> | 277 </dd> |
| 265 </dl> | 278 </dl> |
| 266 <a NAME="SelectionEncloserPlugin.deactivate" ID="SelectionEncloserPlugin.deactivate"></a> | 279 <a NAME="SelectionEncloserPlugin.deactivate" ID="SelectionEncloserPlugin.deactivate"></a> |
| 267 <h4>SelectionEncloserPlugin.deactivate</h4> | 280 <h4>SelectionEncloserPlugin.deactivate</h4> |
| 268 <b>deactivate</b>(<i></i>) | 281 <b>deactivate</b>(<i></i>) |
| 277 <p> | 290 <p> |
| 278 Public method to retrieve the various settings. | 291 Public method to retrieve the various settings. |
| 279 </p> | 292 </p> |
| 280 <dl> | 293 <dl> |
| 281 | 294 |
| 282 <dt><i>key</i></dt> | 295 <dt><i>key</i> (str)</dt> |
| 283 <dd> | 296 <dd> |
| 284 the key of the value to get (string) | 297 key of the value to get |
| 285 </dd> | 298 </dd> |
| 286 </dl> | 299 </dl> |
| 287 <dl> | 300 <dl> |
| 288 <dt>Return:</dt> | 301 <dt>Return:</dt> |
| 289 <dd> | 302 <dd> |
| 290 the requested setting | 303 value of the requested setting |
| 304 </dd> | |
| 305 </dl> | |
| 306 <dl> | |
| 307 <dt>Return Type:</dt> | |
| 308 <dd> | |
| 309 Any | |
| 291 </dd> | 310 </dd> |
| 292 </dl> | 311 </dl> |
| 293 <a NAME="SelectionEncloserPlugin.setPreferences" ID="SelectionEncloserPlugin.setPreferences"></a> | 312 <a NAME="SelectionEncloserPlugin.setPreferences" ID="SelectionEncloserPlugin.setPreferences"></a> |
| 294 <h4>SelectionEncloserPlugin.setPreferences</h4> | 313 <h4>SelectionEncloserPlugin.setPreferences</h4> |
| 295 <b>setPreferences</b>(<i>key, value</i>) | 314 <b>setPreferences</b>(<i>key, value</i>) |
| 297 <p> | 316 <p> |
| 298 Public method to store the various settings. | 317 Public method to store the various settings. |
| 299 </p> | 318 </p> |
| 300 <dl> | 319 <dl> |
| 301 | 320 |
| 302 <dt><i>key</i></dt> | 321 <dt><i>key</i> (str)</dt> |
| 303 <dd> | 322 <dd> |
| 304 the key of the setting to be set (string) | 323 key of the setting to be set |
| 305 </dd> | 324 </dd> |
| 306 <dt><i>value</i></dt> | 325 <dt><i>value</i> (Any)</dt> |
| 307 <dd> | 326 <dd> |
| 308 the value to be set | 327 value to be set |
| 309 </dd> | 328 </dd> |
| 310 </dl> | 329 </dl> |
| 311 <div align="right"><a href="#top">Up</a></div> | 330 <div align="right"><a href="#top">Up</a></div> |
| 312 <hr /> | 331 <hr /> |
| 313 <hr /> | 332 <hr /> |
| 318 <p> | 337 <p> |
| 319 Module function to create the Selection Encloser configuration page. | 338 Module function to create the Selection Encloser configuration page. |
| 320 </p> | 339 </p> |
| 321 <dl> | 340 <dl> |
| 322 | 341 |
| 323 <dt><i>configDlg</i></dt> | 342 <dt><i>configDlg</i> (ConfigurationWidget)</dt> |
| 324 <dd> | 343 <dd> |
| 325 reference to the configuration dialog | 344 reference to the configuration dialog |
| 326 </dd> | 345 </dd> |
| 327 </dl> | 346 </dl> |
| 328 <dl> | 347 <dl> |
| 329 <dt>Return:</dt> | 348 <dt>Return:</dt> |
| 330 <dd> | 349 <dd> |
| 331 reference to the configuration page | 350 reference to the configuration page |
| 351 </dd> | |
| 352 </dl> | |
| 353 <dl> | |
| 354 <dt>Return Type:</dt> | |
| 355 <dd> | |
| 356 SelectionEncloserPage | |
| 332 </dd> | 357 </dd> |
| 333 </dl> | 358 </dl> |
| 334 <div align="right"><a href="#top">Up</a></div> | 359 <div align="right"><a href="#top">Up</a></div> |
| 335 <hr /> | 360 <hr /> |
| 336 <hr /> | 361 <hr /> |
| 345 <dt>Return:</dt> | 370 <dt>Return:</dt> |
| 346 <dd> | 371 <dd> |
| 347 dictionary containing the relevant data | 372 dictionary containing the relevant data |
| 348 </dd> | 373 </dd> |
| 349 </dl> | 374 </dl> |
| 375 <dl> | |
| 376 <dt>Return Type:</dt> | |
| 377 <dd> | |
| 378 dict | |
| 379 </dd> | |
| 380 </dl> | |
| 350 <div align="right"><a href="#top">Up</a></div> | 381 <div align="right"><a href="#top">Up</a></div> |
| 351 <hr /> | 382 <hr /> |
| 352 <hr /> | 383 <hr /> |
| 353 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | 384 <a NAME="prepareUninstall" ID="prepareUninstall"></a> |
| 354 <h2>prepareUninstall</h2> | 385 <h2>prepareUninstall</h2> |
