RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.PluginRefactoringRope.html

branch
eric7
changeset 365
f740b50380df
parent 360
2b35968f3d02
child 375
c61a2f18ed78
equal deleted inserted replaced
364:a92b3272f4c1 365:f740b50380df
198 <p> 198 <p>
199 Constructor 199 Constructor
200 </p> 200 </p>
201 <dl> 201 <dl>
202 202
203 <dt><i>ui</i> (UI.UserInterface)</dt> 203 <dt><i>ui</i> (UserInterface)</dt>
204 <dd> 204 <dd>
205 reference to the user interface object 205 reference to the user interface object
206 </dd> 206 </dd>
207 </dl> 207 </dl>
208 <a NAME="RefactoringRopePlugin.__connectEditor" ID="RefactoringRopePlugin.__connectEditor"></a> 208 <a NAME="RefactoringRopePlugin.__connectEditor" ID="RefactoringRopePlugin.__connectEditor"></a>
212 <p> 212 <p>
213 Private method to connect an editor. 213 Private method to connect an editor.
214 </p> 214 </p>
215 <dl> 215 <dl>
216 216
217 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 217 <dt><i>editor</i> (Editor)</dt>
218 <dd> 218 <dd>
219 reference to the editor 219 reference to the editor
220 </dd> 220 </dd>
221 </dl> 221 </dl>
222 <a NAME="RefactoringRopePlugin.__connectMouseClickHandler" ID="RefactoringRopePlugin.__connectMouseClickHandler"></a> 222 <a NAME="RefactoringRopePlugin.__connectMouseClickHandler" ID="RefactoringRopePlugin.__connectMouseClickHandler"></a>
226 <p> 226 <p>
227 Private method to connect the mouse click handler to an editor. 227 Private method to connect the mouse click handler to an editor.
228 </p> 228 </p>
229 <dl> 229 <dl>
230 230
231 <dt><i>editor</i> (QScintilla.Editor)</dt> 231 <dt><i>editor</i> (Editor)</dt>
232 <dd> 232 <dd>
233 reference to the editor 233 reference to the editor
234 </dd> 234 </dd>
235 </dl> 235 </dl>
236 <a NAME="RefactoringRopePlugin.__determineLanguage" ID="RefactoringRopePlugin.__determineLanguage"></a> 236 <a NAME="RefactoringRopePlugin.__determineLanguage" ID="RefactoringRopePlugin.__determineLanguage"></a>
259 <p> 259 <p>
260 Private method to disconnect an editor. 260 Private method to disconnect an editor.
261 </p> 261 </p>
262 <dl> 262 <dl>
263 263
264 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 264 <dt><i>editor</i> (Editor)</dt>
265 <dd> 265 <dd>
266 reference to the editor 266 reference to the editor
267 </dd> 267 </dd>
268 </dl> 268 </dl>
269 <a NAME="RefactoringRopePlugin.__disconnectMouseClickHandler" ID="RefactoringRopePlugin.__disconnectMouseClickHandler"></a> 269 <a NAME="RefactoringRopePlugin.__disconnectMouseClickHandler" ID="RefactoringRopePlugin.__disconnectMouseClickHandler"></a>
273 <p> 273 <p>
274 Private method to disconnect the mouse click handler from an editor. 274 Private method to disconnect the mouse click handler from an editor.
275 </p> 275 </p>
276 <dl> 276 <dl>
277 277
278 <dt><i>editor</i> (QScintilla.Editor)</dt> 278 <dt><i>editor</i> (Editor)</dt>
279 <dd> 279 <dd>
280 reference to the editor 280 reference to the editor
281 </dd> 281 </dd>
282 </dl> 282 </dl>
283 <a NAME="RefactoringRopePlugin.__editorAboutToBeSaved" ID="RefactoringRopePlugin.__editorAboutToBeSaved"></a> 283 <a NAME="RefactoringRopePlugin.__editorAboutToBeSaved" ID="RefactoringRopePlugin.__editorAboutToBeSaved"></a>
301 <p> 301 <p>
302 Private slot called, when an editor was closed. 302 Private slot called, when an editor was closed.
303 </p> 303 </p>
304 <dl> 304 <dl>
305 305
306 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 306 <dt><i>editor</i> (Editor)</dt>
307 <dd> 307 <dd>
308 reference to the editor 308 reference to the editor
309 </dd> 309 </dd>
310 </dl> 310 </dl>
311 <a NAME="RefactoringRopePlugin.__editorLanguageChanged" ID="RefactoringRopePlugin.__editorLanguageChanged"></a> 311 <a NAME="RefactoringRopePlugin.__editorLanguageChanged" ID="RefactoringRopePlugin.__editorLanguageChanged"></a>
329 <p> 329 <p>
330 Private slot called, when a new editor was opened. 330 Private slot called, when a new editor was opened.
331 </p> 331 </p>
332 <dl> 332 <dl>
333 333
334 <dt><i>editor</i> (QScintilla.Editor.Editor)</dt> 334 <dt><i>editor</i> (Editor)</dt>
335 <dd> 335 <dd>
336 reference to the new editor 336 reference to the new editor
337 </dd> 337 </dd>
338 </dl> 338 </dl>
339 <a NAME="RefactoringRopePlugin.__editorSaved" ID="RefactoringRopePlugin.__editorSaved"></a> 339 <a NAME="RefactoringRopePlugin.__editorSaved" ID="RefactoringRopePlugin.__editorSaved"></a>
371 <p> 371 <p>
372 Private method to set the autocompletion hook. 372 Private method to set the autocompletion hook.
373 </p> 373 </p>
374 <dl> 374 <dl>
375 375
376 <dt><i>editor</i> (QScintilla.Editor)</dt> 376 <dt><i>editor</i> (Editor)</dt>
377 <dd> 377 <dd>
378 reference to the editor 378 reference to the editor
379 </dd> 379 </dd>
380 </dl> 380 </dl>
381 <a NAME="RefactoringRopePlugin.__setCalltipsHook" ID="RefactoringRopePlugin.__setCalltipsHook"></a> 381 <a NAME="RefactoringRopePlugin.__setCalltipsHook" ID="RefactoringRopePlugin.__setCalltipsHook"></a>
385 <p> 385 <p>
386 Private method to set the calltip hook. 386 Private method to set the calltip hook.
387 </p> 387 </p>
388 <dl> 388 <dl>
389 389
390 <dt><i>editor</i> (QScintilla.Editor)</dt> 390 <dt><i>editor</i> (Editor)</dt>
391 <dd> 391 <dd>
392 reference to the editor 392 reference to the editor
393 </dd> 393 </dd>
394 </dl> 394 </dl>
395 <a NAME="RefactoringRopePlugin.__shutdown" ID="RefactoringRopePlugin.__shutdown"></a> 395 <a NAME="RefactoringRopePlugin.__shutdown" ID="RefactoringRopePlugin.__shutdown"></a>
406 <p> 406 <p>
407 Private method to unset the autocompletion hook. 407 Private method to unset the autocompletion hook.
408 </p> 408 </p>
409 <dl> 409 <dl>
410 410
411 <dt><i>editor</i> (QScintilla.Editor)</dt> 411 <dt><i>editor</i> (Editor)</dt>
412 <dd> 412 <dd>
413 reference to the editor 413 reference to the editor
414 </dd> 414 </dd>
415 </dl> 415 </dl>
416 <a NAME="RefactoringRopePlugin.__unsetCalltipsHook" ID="RefactoringRopePlugin.__unsetCalltipsHook"></a> 416 <a NAME="RefactoringRopePlugin.__unsetCalltipsHook" ID="RefactoringRopePlugin.__unsetCalltipsHook"></a>
420 <p> 420 <p>
421 Private method to unset the calltip hook. 421 Private method to unset the calltip hook.
422 </p> 422 </p>
423 <dl> 423 <dl>
424 424
425 <dt><i>editor</i> (QScintilla.Editor)</dt> 425 <dt><i>editor</i> (Editor)</dt>
426 <dd> 426 <dd>
427 reference to the editor 427 reference to the editor
428 </dd> 428 </dd>
429 </dl> 429 </dl>
430 <a NAME="RefactoringRopePlugin.activate" ID="RefactoringRopePlugin.activate"></a> 430 <a NAME="RefactoringRopePlugin.activate" ID="RefactoringRopePlugin.activate"></a>
490 <dt>Return:</dt> 490 <dt>Return:</dt>
491 <dd> 491 <dd>
492 the requested refactoring setting 492 the requested refactoring setting
493 </dd> 493 </dd>
494 </dl> 494 </dl>
495 <dl>
496 <dt>Return Type:</dt>
497 <dd>
498 Any
499 </dd>
500 </dl>
495 <a NAME="RefactoringRopePlugin.setPreferences" ID="RefactoringRopePlugin.setPreferences"></a> 501 <a NAME="RefactoringRopePlugin.setPreferences" ID="RefactoringRopePlugin.setPreferences"></a>
496 <h4>RefactoringRopePlugin.setPreferences</h4> 502 <h4>RefactoringRopePlugin.setPreferences</h4>
497 <b>setPreferences</b>(<i>key, value</i>) 503 <b>setPreferences</b>(<i>key, value</i>)
498 504
499 <p> 505 <p>
503 509
504 <dt><i>key</i> (str)</dt> 510 <dt><i>key</i> (str)</dt>
505 <dd> 511 <dd>
506 the key of the setting to be set 512 the key of the setting to be set
507 </dd> 513 </dd>
508 <dt><i>value</i></dt> 514 <dt><i>value</i> (Any)</dt>
509 <dd> 515 <dd>
510 the value to be set 516 the value to be set
511 </dd> 517 </dd>
512 </dl> 518 </dl>
513 <div align="right"><a href="#top">Up</a></div> 519 <div align="right"><a href="#top">Up</a></div>
520 <p> 526 <p>
521 Module function to create the autocompletion configuration page. 527 Module function to create the autocompletion configuration page.
522 </p> 528 </p>
523 <dl> 529 <dl>
524 530
525 <dt><i>configDlg</i></dt> 531 <dt><i>configDlg</i> (ConfigurationWidget)</dt>
526 <dd> 532 <dd>
527 reference to the configuration dialog 533 reference to the configuration dialog
528 </dd> 534 </dd>
529 </dl> 535 </dl>
530 <dl> 536 <dl>
531 <dt>Return:</dt> 537 <dt>Return:</dt>
532 <dd> 538 <dd>
533 reference to the configuration page 539 reference to the configuration page
540 </dd>
541 </dl>
542 <dl>
543 <dt>Return Type:</dt>
544 <dd>
545 AutoCompletionRopePage
534 </dd> 546 </dd>
535 </dl> 547 </dl>
536 <div align="right"><a href="#top">Up</a></div> 548 <div align="right"><a href="#top">Up</a></div>
537 <hr /> 549 <hr />
538 <hr /> 550 <hr />
543 <p> 555 <p>
544 Module function to create the calltips configuration page. 556 Module function to create the calltips configuration page.
545 </p> 557 </p>
546 <dl> 558 <dl>
547 559
548 <dt><i>configDlg</i></dt> 560 <dt><i>configDlg</i> (ConfigurationWidget)</dt>
549 <dd> 561 <dd>
550 reference to the configuration dialog 562 reference to the configuration dialog
551 </dd> 563 </dd>
552 </dl> 564 </dl>
553 <dl> 565 <dl>
554 <dt>Return:</dt> 566 <dt>Return:</dt>
555 <dd> 567 <dd>
556 reference to the configuration page 568 reference to the configuration page
569 </dd>
570 </dl>
571 <dl>
572 <dt>Return Type:</dt>
573 <dd>
574 CallTipsRopePage
557 </dd> 575 </dd>
558 </dl> 576 </dl>
559 <div align="right"><a href="#top">Up</a></div> 577 <div align="right"><a href="#top">Up</a></div>
560 <hr /> 578 <hr />
561 <hr /> 579 <hr />
566 <p> 584 <p>
567 Module function to create the mouse click handler configuration page. 585 Module function to create the mouse click handler configuration page.
568 </p> 586 </p>
569 <dl> 587 <dl>
570 588
571 <dt><i>configDlg</i></dt> 589 <dt><i>configDlg</i> (ConfigurationWidget)</dt>
572 <dd> 590 <dd>
573 reference to the configuration dialog 591 reference to the configuration dialog
574 </dd> 592 </dd>
575 </dl> 593 </dl>
576 <dl> 594 <dl>
577 <dt>Return:</dt> 595 <dt>Return:</dt>
578 <dd> 596 <dd>
579 reference to the configuration page 597 reference to the configuration page
598 </dd>
599 </dl>
600 <dl>
601 <dt>Return Type:</dt>
602 <dd>
603 MouseClickHandlerRopePage
580 </dd> 604 </dd>
581 </dl> 605 </dl>
582 <div align="right"><a href="#top">Up</a></div> 606 <div align="right"><a href="#top">Up</a></div>
583 <hr /> 607 <hr />
584 <hr /> 608 <hr />

eric ide

mercurial