RefactoringRope/Documentation/source/Plugin_Refactoring_Rope.RefactoringRope.HistoryDialog.html

Sat, 12 Feb 2011 11:53:07 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 12 Feb 2011 11:53:07 +0100
changeset 24
e18b36080a37
parent 17
a0fac63ef73f
child 44
8aa985c8dee5
permissions
-rw-r--r--

Updated source docu after making the code PEP-8 compliant.

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.HistoryDialog</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.HistoryDialog</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 History 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="#HistoryDialog">HistoryDialog</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <td>Class implementing the History 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="HistoryDialog" ID="HistoryDialog"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <h2>HistoryDialog</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 History 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 PreviewDialogBase
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>ChangeIDRole</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="#HistoryDialog.__init__">HistoryDialog</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="#HistoryDialog.accept">accept</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 <td>Public slot to undo the selected set of 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="#HistoryDialog.on_changesList_currentItemChanged">on_changesList_currentItemChanged</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <td>Private slot called when a change is selected.</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="HistoryDialog.__init__" ID="HistoryDialog.__init__"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 <h4>HistoryDialog (Constructor)</h4>
24
e18b36080a37 Updated source docu after making the code PEP-8 compliant.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 17
diff changeset
69 <b>HistoryDialog</b>(<i>refactoring, changes, isUndo, parent=None</i>)
17
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>changes</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 list of ChangeSet objects
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 (list of rope.base.change.ChangeSet)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 </dd><dt><i>isUndo</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 flag indicating an undo history dialog (boolean)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 </dd><dt><i>parent</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 reference to the parent widget (QWidget)
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 </dl><a NAME="HistoryDialog.accept" ID="HistoryDialog.accept"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 <h4>HistoryDialog.accept</h4>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <b>accept</b>(<i></i>)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 Public slot to undo the selected set of changes.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 </p><a NAME="HistoryDialog.on_changesList_currentItemChanged" ID="HistoryDialog.on_changesList_currentItemChanged"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 <h4>HistoryDialog.on_changesList_currentItemChanged</h4>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 <b>on_changesList_currentItemChanged</b>(<i>current, previous</i>)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 Private slot called when a change is selected.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 </p><dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 <dt><i>current</i></dt>
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 reference to the new current item (QListWidgetItem)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 </dd><dt><i>previous</i></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 old current item (QListWidgetItem)
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>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 <div align="right"><a href="#top">Up</a></div>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 <hr />
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 </body></html>

eric ide

mercurial