src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog.html

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to show the output of the hg diff command process. 11 Module implementing a dialog to show the output of the hg diff command process.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#HgDiffDialog">HgDiffDialog</a></td> 22 <td><a href="#HgDiffDialog">HgDiffDialog</a></td>
25 <td>Class implementing a dialog to show the output of the hg diff command process.</td> 23 <td>Class implementing a dialog to show the output of the hg diff command process.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="HgDiffDialog" ID="HgDiffDialog"></a> 34 <a NAME="HgDiffDialog" ID="HgDiffDialog"></a>
36 <h2>HgDiffDialog</h2> 35 <h2>HgDiffDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to show the output of the hg diff command 37 Class implementing a dialog to show the output of the hg diff command
40 process. 38 process.
41 </p> 39 </p>
40
42 <h3>Derived from</h3> 41 <h3>Derived from</h3>
43 QWidget, Ui_HgDiffDialog 42 QWidget, Ui_HgDiffDialog
44 <h3>Class Attributes</h3> 43 <h3>Class Attributes</h3>
45 44 <table>
46 <table> 45 <tr><td>None</td></tr>
47 <tr><td>None</td></tr> 46 </table>
48 </table> 47
49 <h3>Class Methods</h3> 48 <h3>Class Methods</h3>
50 49 <table>
51 <table> 50 <tr><td>None</td></tr>
52 <tr><td>None</td></tr> 51 </table>
53 </table> 52
54 <h3>Methods</h3> 53 <h3>Methods</h3>
55 54 <table>
56 <table>
57
58 <tr> 55 <tr>
59 <td><a href="#HgDiffDialog.__init__">HgDiffDialog</a></td> 56 <td><a href="#HgDiffDialog.__init__">HgDiffDialog</a></td>
60 <td>Constructor</td> 57 <td>Constructor</td>
61 </tr> 58 </tr>
62 <tr> 59 <tr>
86 <tr> 83 <tr>
87 <td><a href="#HgDiffDialog.start">start</a></td> 84 <td><a href="#HgDiffDialog.start">start</a></td>
88 <td>Public slot to start the hg diff command.</td> 85 <td>Public slot to start the hg diff command.</td>
89 </tr> 86 </tr>
90 </table> 87 </table>
88
91 <h3>Static Methods</h3> 89 <h3>Static Methods</h3>
92 90 <table>
93 <table> 91 <tr><td>None</td></tr>
94 <tr><td>None</td></tr> 92 </table>
95 </table> 93
96 94
97 <a NAME="HgDiffDialog.__init__" ID="HgDiffDialog.__init__"></a> 95 <a NAME="HgDiffDialog.__init__" ID="HgDiffDialog.__init__"></a>
98 <h4>HgDiffDialog (Constructor)</h4> 96 <h4>HgDiffDialog (Constructor)</h4>
99 <b>HgDiffDialog</b>(<i>vcs, parent=None</i>) 97 <b>HgDiffDialog</b>(<i>vcs, parent=None</i>)
100
101 <p> 98 <p>
102 Constructor 99 Constructor
103 </p> 100 </p>
101
104 <dl> 102 <dl>
105 103
106 <dt><i>vcs</i> (Hg)</dt> 104 <dt><i>vcs</i> (Hg)</dt>
107 <dd> 105 <dd>
108 reference to the vcs object 106 reference to the vcs object
113 </dd> 111 </dd>
114 </dl> 112 </dl>
115 <a NAME="HgDiffDialog.__generatorFinished" ID="HgDiffDialog.__generatorFinished"></a> 113 <a NAME="HgDiffDialog.__generatorFinished" ID="HgDiffDialog.__generatorFinished"></a>
116 <h4>HgDiffDialog.__generatorFinished</h4> 114 <h4>HgDiffDialog.__generatorFinished</h4>
117 <b>__generatorFinished</b>(<i></i>) 115 <b>__generatorFinished</b>(<i></i>)
118
119 <p> 116 <p>
120 Private slot connected to the finished signal. 117 Private slot connected to the finished signal.
121 </p> 118 </p>
119
122 <a NAME="HgDiffDialog.closeEvent" ID="HgDiffDialog.closeEvent"></a> 120 <a NAME="HgDiffDialog.closeEvent" ID="HgDiffDialog.closeEvent"></a>
123 <h4>HgDiffDialog.closeEvent</h4> 121 <h4>HgDiffDialog.closeEvent</h4>
124 <b>closeEvent</b>(<i>e</i>) 122 <b>closeEvent</b>(<i>e</i>)
125
126 <p> 123 <p>
127 Protected slot implementing a close event handler. 124 Protected slot implementing a close event handler.
128 </p> 125 </p>
126
129 <dl> 127 <dl>
130 128
131 <dt><i>e</i> (QCloseEvent)</dt> 129 <dt><i>e</i> (QCloseEvent)</dt>
132 <dd> 130 <dd>
133 close event 131 close event
134 </dd> 132 </dd>
135 </dl> 133 </dl>
136 <a NAME="HgDiffDialog.on_buttonBox_clicked" ID="HgDiffDialog.on_buttonBox_clicked"></a> 134 <a NAME="HgDiffDialog.on_buttonBox_clicked" ID="HgDiffDialog.on_buttonBox_clicked"></a>
137 <h4>HgDiffDialog.on_buttonBox_clicked</h4> 135 <h4>HgDiffDialog.on_buttonBox_clicked</h4>
138 <b>on_buttonBox_clicked</b>(<i>button</i>) 136 <b>on_buttonBox_clicked</b>(<i>button</i>)
139
140 <p> 137 <p>
141 Private slot called by a button of the button box clicked. 138 Private slot called by a button of the button box clicked.
142 </p> 139 </p>
140
143 <dl> 141 <dl>
144 142
145 <dt><i>button</i> (QAbstractButton)</dt> 143 <dt><i>button</i> (QAbstractButton)</dt>
146 <dd> 144 <dd>
147 button that was clicked 145 button that was clicked
148 </dd> 146 </dd>
149 </dl> 147 </dl>
150 <a NAME="HgDiffDialog.on_filesCombo_activated" ID="HgDiffDialog.on_filesCombo_activated"></a> 148 <a NAME="HgDiffDialog.on_filesCombo_activated" ID="HgDiffDialog.on_filesCombo_activated"></a>
151 <h4>HgDiffDialog.on_filesCombo_activated</h4> 149 <h4>HgDiffDialog.on_filesCombo_activated</h4>
152 <b>on_filesCombo_activated</b>(<i>index</i>) 150 <b>on_filesCombo_activated</b>(<i>index</i>)
153
154 <p> 151 <p>
155 Private slot to handle the selection of a file. 152 Private slot to handle the selection of a file.
156 </p> 153 </p>
154
157 <dl> 155 <dl>
158 156
159 <dt><i>index</i> (int)</dt> 157 <dt><i>index</i> (int)</dt>
160 <dd> 158 <dd>
161 activated row 159 activated row
162 </dd> 160 </dd>
163 </dl> 161 </dl>
164 <a NAME="HgDiffDialog.on_refreshButton_clicked" ID="HgDiffDialog.on_refreshButton_clicked"></a> 162 <a NAME="HgDiffDialog.on_refreshButton_clicked" ID="HgDiffDialog.on_refreshButton_clicked"></a>
165 <h4>HgDiffDialog.on_refreshButton_clicked</h4> 163 <h4>HgDiffDialog.on_refreshButton_clicked</h4>
166 <b>on_refreshButton_clicked</b>(<i></i>) 164 <b>on_refreshButton_clicked</b>(<i></i>)
167
168 <p> 165 <p>
169 Private slot to refresh the display. 166 Private slot to refresh the display.
170 </p> 167 </p>
168
171 <a NAME="HgDiffDialog.on_saveButton_clicked" ID="HgDiffDialog.on_saveButton_clicked"></a> 169 <a NAME="HgDiffDialog.on_saveButton_clicked" ID="HgDiffDialog.on_saveButton_clicked"></a>
172 <h4>HgDiffDialog.on_saveButton_clicked</h4> 170 <h4>HgDiffDialog.on_saveButton_clicked</h4>
173 <b>on_saveButton_clicked</b>(<i></i>) 171 <b>on_saveButton_clicked</b>(<i></i>)
174
175 <p> 172 <p>
176 Private slot to handle the Save button press. 173 Private slot to handle the Save button press.
177 </p> 174 </p>
178 <p> 175 <p>
179 It saves the diff shown in the dialog to a file in the local 176 It saves the diff shown in the dialog to a file in the local
180 filesystem. 177 filesystem.
181 </p> 178 </p>
179
182 <a NAME="HgDiffDialog.start" ID="HgDiffDialog.start"></a> 180 <a NAME="HgDiffDialog.start" ID="HgDiffDialog.start"></a>
183 <h4>HgDiffDialog.start</h4> 181 <h4>HgDiffDialog.start</h4>
184 <b>start</b>(<i>fn, versions=None, bundle=None, qdiff=False, refreshable=False</i>) 182 <b>start</b>(<i>fn, versions=None, bundle=None, qdiff=False, refreshable=False</i>)
185
186 <p> 183 <p>
187 Public slot to start the hg diff command. 184 Public slot to start the hg diff command.
188 </p> 185 </p>
186
189 <dl> 187 <dl>
190 188
191 <dt><i>fn</i> (str)</dt> 189 <dt><i>fn</i> (str)</dt>
192 <dd> 190 <dd>
193 filename to be diffed 191 filename to be diffed

eric ide

mercurial