RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.InlineDialog.html

Sun, 30 Jan 2011 18:26:37 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 30 Jan 2011 18:26:37 +0100
changeset 17
a0fac63ef73f
child 24
e18b36080a37
permissions
-rw-r--r--

Added source docu.

17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <html><head>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <title>Plugin_Refactoring_Rope.RefactoringRope.InlineDialog</title>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 <style>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 body {
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 background: #EDECE6;
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 margin: 0em 1em 10em 1em;
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 color: black;
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
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h1 { color: white; background: #85774A; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h2 { color: white; background: #85774A; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h3 { color: white; background: #9D936E; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 h4 { color: white; background: #9D936E; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18 a { color: #BA6D36; }
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </style>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 </head>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <body><a NAME="top" ID="top"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>Plugin_Refactoring_Rope.RefactoringRope.InlineDialog</h1>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 Module implementing the Inline dialog.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 </p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <h3>Global Attributes</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 <tr><td>None</td></tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 </table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <h3>Classes</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <td><a href="#InlineDialog">InlineDialog</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <td>Class implementing the Inline dialog.</td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 </table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <h3>Functions</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <tr><td>None</td></tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <hr /><hr />
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <a NAME="InlineDialog" ID="InlineDialog"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <h2>InlineDialog</h2>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 Class implementing the Inline dialog.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 </p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <h3>Derived from</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 RefactoringDialogBase, Ui_InlineDialog
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <h3>Class Attributes</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <tr><td>None</td></tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 </table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
54 <h3>Methods</h3>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
55 <table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
56 <tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <td><a href="#InlineDialog.__init__">InlineDialog</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <td>Constructor</td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 </tr><tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <td><a href="#InlineDialog._calculateChanges">_calculateChanges</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 <td>Protected method to calculate the changes.</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="#InlineDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <td>Private slot to act on the button pressed.</td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 </tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 </table>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <a NAME="InlineDialog.__init__" ID="InlineDialog.__init__"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 <h4>InlineDialog (Constructor)</h4>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 <b>InlineDialog</b>(<i>refactoring, title, inliner, parent = None</i>)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 Constructor
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 </p><dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 <dt><i>refactoring</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 reference to the main refactoring object
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 (Refactoring)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 </dd><dt><i>title</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 title of the dialog (string)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 </dd><dt><i>inliner</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 reference to the inliner object
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 (rope.refactor.inline.InlineMethod,
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 rope.refactor.inline.InlineVariable
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 or rope.refactor.inline.InlineParameter)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 </dd><dt><i>parent</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 reference to the parent widget (QWidget)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 </dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 </dl><a NAME="InlineDialog._calculateChanges" ID="InlineDialog._calculateChanges"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <h4>InlineDialog._calculateChanges</h4>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 <b>_calculateChanges</b>(<i>handle</i>)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 Protected method to calculate the changes.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 </p><dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <dt><i>handle</i></dt>
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 reference to the task handle
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 (rope.base.taskhandle.TaskHandle)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 </dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 </dl><dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 <dt>Returns:</dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 reference to the Changes object (rope.base.change.ChangeSet)
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 </dl><a NAME="InlineDialog.on_buttonBox_clicked" ID="InlineDialog.on_buttonBox_clicked"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 <h4>InlineDialog.on_buttonBox_clicked</h4>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 <b>on_buttonBox_clicked</b>(<i>button</i>)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 Private slot to act on the button pressed.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 </p><dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 <dt><i>button</i></dt>
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 reference to the button pressed (QAbstractButton)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 </dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 </dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117 <div align="right"><a href="#top">Up</a></div>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118 <hr />
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119 </body></html>

eric ide

mercurial