RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.IntroduceParameterDialog.html

Sat, 27 Jun 2015 11:15:48 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 27 Jun 2015 11:15:48 +0200
changeset 129
23ee57a96ea3
parent 44
8aa985c8dee5
child 204
b4bf79b956bc
permissions
-rw-r--r--

Added capability to go to the definition of a class or function by clicking on it (while holding the Ctrl key or another configurable modifier sequence) (needs eric 6.1.0).

44
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
1 <!DOCTYPE html>
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>Plugin_Refactoring_Rope.RefactoringRope.IntroduceParameterDialog</title>
44
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
4 <meta charset="UTF-8">
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 h1 { color: white; background: #85774A; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h2 { color: white; background: #85774A; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h3 { color: white; background: #9D936E; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h4 { color: white; background: #9D936E; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body><a NAME="top" ID="top"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <h1>Plugin_Refactoring_Rope.RefactoringRope.IntroduceParameterDialog</h1>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 Module implementing the Introduce Parameter dialog.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 </p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 <h3>Global Attributes</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <tr><td>None</td></tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 </table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <h3>Classes</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <td><a href="#IntroduceParameterDialog">IntroduceParameterDialog</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <td>Class implementing the Introduce Parameter dialog.</td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 </tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <h3>Functions</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <tr><td>None</td></tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 <hr /><hr />
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <a NAME="IntroduceParameterDialog" ID="IntroduceParameterDialog"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <h2>IntroduceParameterDialog</h2>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 Class implementing the Introduce Parameter dialog.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 </p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <h3>Derived from</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 RefactoringDialogBase, Ui_IntroduceParameterDialog
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <h3>Class Attributes</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <tr><td>None</td></tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 </table>
44
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
53 <h3>Class Methods</h3>
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
54 <table>
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
55 <tr><td>None</td></tr>
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
56 </table>
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <h3>Methods</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <td><a href="#IntroduceParameterDialog.__init__">IntroduceParameterDialog</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 <td>Constructor</td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62 </tr><tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <td><a href="#IntroduceParameterDialog._calculateChanges">_calculateChanges</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <td>Protected method to calculate the changes.</td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 </tr><tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 <td><a href="#IntroduceParameterDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <td>Private slot to act on the button pressed.</td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 </tr><tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <td><a href="#IntroduceParameterDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <td>Private slot to react to changes of the name.</td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 </tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 </table>
44
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
73 <h3>Static Methods</h3>
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
74 <table>
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
75 <tr><td>None</td></tr>
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
76 </table>
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <a NAME="IntroduceParameterDialog.__init__" ID="IntroduceParameterDialog.__init__"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <h4>IntroduceParameterDialog (Constructor)</h4>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 <b>IntroduceParameterDialog</b>(<i>refactoring, title, introducer, parent=None</i>)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 Constructor
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 </p><dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 <dt><i>refactoring</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 reference to the main refactoring object
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 (Refactoring)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 </dd><dt><i>title</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 title of the dialog (string)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 </dd><dt><i>introducer</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 reference to the factory introducer object
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 (rope.refactor.introduce_parameter.IntroduceParameter)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 </dd><dt><i>parent</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 reference to the parent widget (QWidget)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 </dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 </dl><a NAME="IntroduceParameterDialog._calculateChanges" ID="IntroduceParameterDialog._calculateChanges"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 <h4>IntroduceParameterDialog._calculateChanges</h4>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 <b>_calculateChanges</b>(<i>handle</i>)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 Protected method to calculate the changes.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 </p><dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 <dt><i>handle</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 reference to the task handle
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 (rope.base.taskhandle.TaskHandle)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 </dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 </dl><dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 <dt>Returns:</dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 reference to the Changes object (rope.base.change.ChangeSet)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 </dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 </dl><a NAME="IntroduceParameterDialog.on_buttonBox_clicked" ID="IntroduceParameterDialog.on_buttonBox_clicked"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 <h4>IntroduceParameterDialog.on_buttonBox_clicked</h4>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 <b>on_buttonBox_clicked</b>(<i>button</i>)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118 Private slot to act on the button pressed.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 </p><dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
120 <dt><i>button</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
121 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122 reference to the button pressed (QAbstractButton)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 </dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 </dl><a NAME="IntroduceParameterDialog.on_nameEdit_textChanged" ID="IntroduceParameterDialog.on_nameEdit_textChanged"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
125 <h4>IntroduceParameterDialog.on_nameEdit_textChanged</h4>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
126 <b>on_nameEdit_textChanged</b>(<i>text</i>)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
127 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
128 Private slot to react to changes of the name.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
129 </p><dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
130 <dt><i>text</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
132 text entered into the edit (string)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
133 </dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
134 </dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
135 <div align="right"><a href="#top">Up</a></div>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
136 <hr />
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
137 </body></html>

eric ide

mercurial