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