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

Sun, 08 Mar 2015 13:51:53 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 08 Mar 2015 13:51:53 +0100
changeset 107
3ee7bd0bba9a
parent 44
8aa985c8dee5
child 204
b4bf79b956bc
permissions
-rw-r--r--

Prepared new release.

44
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 24
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.HistoryDialog</title>
44
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 24
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.HistoryDialog</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 History 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="#HistoryDialog">HistoryDialog</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <td>Class implementing the History 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="HistoryDialog" ID="HistoryDialog"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <h2>HistoryDialog</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 History 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 PreviewDialogBase
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>ChangeIDRole</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: 24
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: 24
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: 24
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: 24
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="#HistoryDialog.__init__">HistoryDialog</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="#HistoryDialog.accept">accept</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <td>Public slot to undo the selected set of 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="#HistoryDialog.on_changesList_currentItemChanged">on_changesList_currentItemChanged</a></td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 <td>Private slot called when a change is selected.</td>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
68 </tr>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
69 </table>
44
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 24
diff changeset
70 <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: 24
diff changeset
71 <table>
8aa985c8dee5 Fixed an issue causing failures for files with Windows end-of-line indicators.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 24
diff changeset
72 <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: 24
diff changeset
73 </table>
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 <a NAME="HistoryDialog.__init__" ID="HistoryDialog.__init__"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <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
76 <b>HistoryDialog</b>(<i>refactoring, changes, isUndo, parent=None</i>)
17
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 Constructor
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 </p><dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 <dt><i>refactoring</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 main refactoring object
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 (Refactoring)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 </dd><dt><i>changes</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 list of ChangeSet objects
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 (list of rope.base.change.ChangeSet)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 </dd><dt><i>isUndo</i></dt>
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 flag indicating an undo history dialog (boolean)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 </dd><dt><i>parent</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 reference to the parent widget (QWidget)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 </dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 </dl><a NAME="HistoryDialog.accept" ID="HistoryDialog.accept"></a>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
96 <h4>HistoryDialog.accept</h4>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 <b>accept</b>(<i></i>)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 Public slot to undo the selected set of changes.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 </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
101 <h4>HistoryDialog.on_changesList_currentItemChanged</h4>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102 <b>on_changesList_currentItemChanged</b>(<i>current, previous</i>)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 <p>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104 Private slot called when a change is selected.
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 </p><dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 <dt><i>current</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108 reference to the new current item (QListWidgetItem)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 </dd><dt><i>previous</i></dt>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110 <dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
111 reference to the old current item (QListWidgetItem)
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
112 </dd>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 </dl>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 <div align="right"><a href="#top">Up</a></div>
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 <hr />
a0fac63ef73f Added source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 </body></html>

eric ide

mercurial