|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing a dialog to show the output of the hg diff command process. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 |
|
23 <tr> |
|
24 <td><a href="#HgDiffDialog">HgDiffDialog</a></td> |
|
25 <td>Class implementing a dialog to show the output of the hg diff command process.</td> |
|
26 </tr> |
|
27 </table> |
|
28 <h3>Functions</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /> |
|
34 <hr /> |
|
35 <a NAME="HgDiffDialog" ID="HgDiffDialog"></a> |
|
36 <h2>HgDiffDialog</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing a dialog to show the output of the hg diff command |
|
40 process. |
|
41 </p> |
|
42 <h3>Derived from</h3> |
|
43 QWidget, Ui_HgDiffDialog |
|
44 <h3>Class Attributes</h3> |
|
45 |
|
46 <table> |
|
47 <tr><td>None</td></tr> |
|
48 </table> |
|
49 <h3>Class Methods</h3> |
|
50 |
|
51 <table> |
|
52 <tr><td>None</td></tr> |
|
53 </table> |
|
54 <h3>Methods</h3> |
|
55 |
|
56 <table> |
|
57 |
|
58 <tr> |
|
59 <td><a href="#HgDiffDialog.__init__">HgDiffDialog</a></td> |
|
60 <td>Constructor</td> |
|
61 </tr> |
|
62 <tr> |
|
63 <td><a href="#HgDiffDialog.__generatorFinished">__generatorFinished</a></td> |
|
64 <td>Private slot connected to the finished signal.</td> |
|
65 </tr> |
|
66 <tr> |
|
67 <td><a href="#HgDiffDialog.closeEvent">closeEvent</a></td> |
|
68 <td>Protected slot implementing a close event handler.</td> |
|
69 </tr> |
|
70 <tr> |
|
71 <td><a href="#HgDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
72 <td>Private slot called by a button of the button box clicked.</td> |
|
73 </tr> |
|
74 <tr> |
|
75 <td><a href="#HgDiffDialog.on_filesCombo_activated">on_filesCombo_activated</a></td> |
|
76 <td>Private slot to handle the selection of a file.</td> |
|
77 </tr> |
|
78 <tr> |
|
79 <td><a href="#HgDiffDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> |
|
80 <td>Private slot to refresh the display.</td> |
|
81 </tr> |
|
82 <tr> |
|
83 <td><a href="#HgDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> |
|
84 <td>Private slot to handle the Save button press.</td> |
|
85 </tr> |
|
86 <tr> |
|
87 <td><a href="#HgDiffDialog.start">start</a></td> |
|
88 <td>Public slot to start the hg diff command.</td> |
|
89 </tr> |
|
90 </table> |
|
91 <h3>Static Methods</h3> |
|
92 |
|
93 <table> |
|
94 <tr><td>None</td></tr> |
|
95 </table> |
|
96 |
|
97 <a NAME="HgDiffDialog.__init__" ID="HgDiffDialog.__init__"></a> |
|
98 <h4>HgDiffDialog (Constructor)</h4> |
|
99 <b>HgDiffDialog</b>(<i>vcs, parent=None</i>) |
|
100 |
|
101 <p> |
|
102 Constructor |
|
103 </p> |
|
104 <dl> |
|
105 |
|
106 <dt><i>vcs</i></dt> |
|
107 <dd> |
|
108 reference to the vcs object |
|
109 </dd> |
|
110 <dt><i>parent</i></dt> |
|
111 <dd> |
|
112 parent widget (QWidget) |
|
113 </dd> |
|
114 </dl> |
|
115 <a NAME="HgDiffDialog.__generatorFinished" ID="HgDiffDialog.__generatorFinished"></a> |
|
116 <h4>HgDiffDialog.__generatorFinished</h4> |
|
117 <b>__generatorFinished</b>(<i></i>) |
|
118 |
|
119 <p> |
|
120 Private slot connected to the finished signal. |
|
121 </p> |
|
122 <a NAME="HgDiffDialog.closeEvent" ID="HgDiffDialog.closeEvent"></a> |
|
123 <h4>HgDiffDialog.closeEvent</h4> |
|
124 <b>closeEvent</b>(<i>e</i>) |
|
125 |
|
126 <p> |
|
127 Protected slot implementing a close event handler. |
|
128 </p> |
|
129 <dl> |
|
130 |
|
131 <dt><i>e</i></dt> |
|
132 <dd> |
|
133 close event (QCloseEvent) |
|
134 </dd> |
|
135 </dl> |
|
136 <a NAME="HgDiffDialog.on_buttonBox_clicked" ID="HgDiffDialog.on_buttonBox_clicked"></a> |
|
137 <h4>HgDiffDialog.on_buttonBox_clicked</h4> |
|
138 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
139 |
|
140 <p> |
|
141 Private slot called by a button of the button box clicked. |
|
142 </p> |
|
143 <dl> |
|
144 |
|
145 <dt><i>button</i></dt> |
|
146 <dd> |
|
147 button that was clicked (QAbstractButton) |
|
148 </dd> |
|
149 </dl> |
|
150 <a NAME="HgDiffDialog.on_filesCombo_activated" ID="HgDiffDialog.on_filesCombo_activated"></a> |
|
151 <h4>HgDiffDialog.on_filesCombo_activated</h4> |
|
152 <b>on_filesCombo_activated</b>(<i>index</i>) |
|
153 |
|
154 <p> |
|
155 Private slot to handle the selection of a file. |
|
156 </p> |
|
157 <dl> |
|
158 |
|
159 <dt><i>index</i></dt> |
|
160 <dd> |
|
161 activated row (integer) |
|
162 </dd> |
|
163 </dl> |
|
164 <a NAME="HgDiffDialog.on_refreshButton_clicked" ID="HgDiffDialog.on_refreshButton_clicked"></a> |
|
165 <h4>HgDiffDialog.on_refreshButton_clicked</h4> |
|
166 <b>on_refreshButton_clicked</b>(<i></i>) |
|
167 |
|
168 <p> |
|
169 Private slot to refresh the display. |
|
170 </p> |
|
171 <a NAME="HgDiffDialog.on_saveButton_clicked" ID="HgDiffDialog.on_saveButton_clicked"></a> |
|
172 <h4>HgDiffDialog.on_saveButton_clicked</h4> |
|
173 <b>on_saveButton_clicked</b>(<i></i>) |
|
174 |
|
175 <p> |
|
176 Private slot to handle the Save button press. |
|
177 </p> |
|
178 <p> |
|
179 It saves the diff shown in the dialog to a file in the local |
|
180 filesystem. |
|
181 </p> |
|
182 <a NAME="HgDiffDialog.start" ID="HgDiffDialog.start"></a> |
|
183 <h4>HgDiffDialog.start</h4> |
|
184 <b>start</b>(<i>fn, versions=None, bundle=None, qdiff=False, refreshable=False</i>) |
|
185 |
|
186 <p> |
|
187 Public slot to start the hg diff command. |
|
188 </p> |
|
189 <dl> |
|
190 |
|
191 <dt><i>fn</i></dt> |
|
192 <dd> |
|
193 filename to be diffed (string) |
|
194 </dd> |
|
195 <dt><i>versions</i></dt> |
|
196 <dd> |
|
197 list of versions to be diffed (list of up to |
|
198 2 strings or None) |
|
199 </dd> |
|
200 <dt><i>bundle</i></dt> |
|
201 <dd> |
|
202 name of a bundle file (string) |
|
203 </dd> |
|
204 <dt><i>qdiff</i></dt> |
|
205 <dd> |
|
206 flag indicating qdiff command shall be used (boolean) |
|
207 </dd> |
|
208 <dt><i>refreshable</i></dt> |
|
209 <dd> |
|
210 flag indicating a refreshable diff (boolean) |
|
211 </dd> |
|
212 </dl> |
|
213 <div align="right"><a href="#top">Up</a></div> |
|
214 <hr /> |
|
215 </body></html> |