RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.RenameDialog.html

changeset 17
a0fac63ef73f
child 44
8aa985c8dee5
equal deleted inserted replaced
16:65b340b40844 17:a0fac63ef73f
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>Plugin_Refactoring_Rope.RefactoringRope.RenameDialog</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>Plugin_Refactoring_Rope.RefactoringRope.RenameDialog</h1>
24 <p>
25 Module implementing the Rename dialog.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#RenameDialog">RenameDialog</a></td>
35 <td>Class implementing the Rename dialog.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="RenameDialog" ID="RenameDialog"></a>
44 <h2>RenameDialog</h2>
45 <p>
46 Class implementing the Rename dialog.
47 </p>
48 <h3>Derived from</h3>
49 RefactoringDialogBase, Ui_RenameDialog
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#RenameDialog.__init__">RenameDialog</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#RenameDialog.__confirmUnsure">__confirmUnsure</a></td>
61 <td>Private method to confirm unsure occurrences.</td>
62 </tr><tr>
63 <td><a href="#RenameDialog._calculateChanges">_calculateChanges</a></td>
64 <td>Protected method to calculate the changes.</td>
65 </tr><tr>
66 <td><a href="#RenameDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
67 <td>Private slot to act on the button pressed.</td>
68 </tr><tr>
69 <td><a href="#RenameDialog.on_newNameEdit_textChanged">on_newNameEdit_textChanged</a></td>
70 <td>Private slot to react to changes of the new name.</td>
71 </tr>
72 </table>
73 <a NAME="RenameDialog.__init__" ID="RenameDialog.__init__"></a>
74 <h4>RenameDialog (Constructor)</h4>
75 <b>RenameDialog</b>(<i>refactoring, title, renamer, resource=None, parent=None</i>)
76 <p>
77 Constructor
78 </p><dl>
79 <dt><i>refactoring</i></dt>
80 <dd>
81 reference to the main refactoring object
82 (Refactoring)
83 </dd><dt><i>title</i></dt>
84 <dd>
85 title of the dialog (string)
86 </dd><dt><i>renamer</i></dt>
87 <dd>
88 reference to the renamer object
89 (rope.refactor.rename.Rename)
90 </dd><dt><i>resource</i></dt>
91 <dd>
92 reference to a resource object, if the action is to
93 be applied to the local file only (rope.base.resources.File)
94 </dd><dt><i>parent</i></dt>
95 <dd>
96 reference to the parent widget (QWidget)
97 </dd>
98 </dl><a NAME="RenameDialog.__confirmUnsure" ID="RenameDialog.__confirmUnsure"></a>
99 <h4>RenameDialog.__confirmUnsure</h4>
100 <b>__confirmUnsure</b>(<i>occurrence</i>)
101 <p>
102 Private method to confirm unsure occurrences.
103 </p><dl>
104 <dt><i>occurrence</i></dt>
105 <dd>
106 reference to the occurrence object
107 (rope.refactor.occurrences.Occurrence)
108 </dd>
109 </dl><dl>
110 <dt>Returns:</dt>
111 <dd>
112 flag indicating an occurrence (boolean)
113 </dd>
114 </dl><a NAME="RenameDialog._calculateChanges" ID="RenameDialog._calculateChanges"></a>
115 <h4>RenameDialog._calculateChanges</h4>
116 <b>_calculateChanges</b>(<i>handle</i>)
117 <p>
118 Protected method to calculate the changes.
119 </p><dl>
120 <dt><i>handle</i></dt>
121 <dd>
122 reference to the task handle
123 (rope.base.taskhandle.TaskHandle)
124 </dd>
125 </dl><dl>
126 <dt>Returns:</dt>
127 <dd>
128 reference to the Changes object (rope.base.change.ChangeSet)
129 </dd>
130 </dl><a NAME="RenameDialog.on_buttonBox_clicked" ID="RenameDialog.on_buttonBox_clicked"></a>
131 <h4>RenameDialog.on_buttonBox_clicked</h4>
132 <b>on_buttonBox_clicked</b>(<i>button</i>)
133 <p>
134 Private slot to act on the button pressed.
135 </p><dl>
136 <dt><i>button</i></dt>
137 <dd>
138 reference to the button pressed (QAbstractButton)
139 </dd>
140 </dl><a NAME="RenameDialog.on_newNameEdit_textChanged" ID="RenameDialog.on_newNameEdit_textChanged"></a>
141 <h4>RenameDialog.on_newNameEdit_textChanged</h4>
142 <b>on_newNameEdit_textChanged</b>(<i>text</i>)
143 <p>
144 Private slot to react to changes of the new name.
145 </p><dl>
146 <dt><i>text</i></dt>
147 <dd>
148 text entered into the edit (string)
149 </dd>
150 </dl>
151 <div align="right"><a href="#top">Up</a></div>
152 <hr />
153 </body></html>

eric ide

mercurial