src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog.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.HgAnnotateDialog</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to show the output of the hg annotate command. 11 Module implementing a dialog to show the output of the hg annotate command.
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="#HgAnnotateDialog">HgAnnotateDialog</a></td> 22 <td><a href="#HgAnnotateDialog">HgAnnotateDialog</a></td>
25 <td>Class implementing a dialog to show the output of the hg annotate command.</td> 23 <td>Class implementing a dialog to show the output of the hg annotate command.</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="HgAnnotateDialog" ID="HgAnnotateDialog"></a> 34 <a NAME="HgAnnotateDialog" ID="HgAnnotateDialog"></a>
36 <h2>HgAnnotateDialog</h2> 35 <h2>HgAnnotateDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to show the output of the hg annotate command. 37 Class implementing a dialog to show the output of the hg annotate command.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_HgAnnotateDialog 41 QDialog, Ui_HgAnnotateDialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#HgAnnotateDialog.__init__">HgAnnotateDialog</a></td> 55 <td><a href="#HgAnnotateDialog.__init__">HgAnnotateDialog</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
93 <tr> 90 <tr>
94 <td><a href="#HgAnnotateDialog.start">start</a></td> 91 <td><a href="#HgAnnotateDialog.start">start</a></td>
95 <td>Public slot to start the annotate command.</td> 92 <td>Public slot to start the annotate command.</td>
96 </tr> 93 </tr>
97 </table> 94 </table>
95
98 <h3>Static Methods</h3> 96 <h3>Static Methods</h3>
99 97 <table>
100 <table> 98 <tr><td>None</td></tr>
101 <tr><td>None</td></tr> 99 </table>
102 </table> 100
103 101
104 <a NAME="HgAnnotateDialog.__init__" ID="HgAnnotateDialog.__init__"></a> 102 <a NAME="HgAnnotateDialog.__init__" ID="HgAnnotateDialog.__init__"></a>
105 <h4>HgAnnotateDialog (Constructor)</h4> 103 <h4>HgAnnotateDialog (Constructor)</h4>
106 <b>HgAnnotateDialog</b>(<i>vcs, parent=None</i>) 104 <b>HgAnnotateDialog</b>(<i>vcs, parent=None</i>)
107
108 <p> 105 <p>
109 Constructor 106 Constructor
110 </p> 107 </p>
108
111 <dl> 109 <dl>
112 110
113 <dt><i>vcs</i> (Hg)</dt> 111 <dt><i>vcs</i> (Hg)</dt>
114 <dd> 112 <dd>
115 reference to the vcs object 113 reference to the vcs object
120 </dd> 118 </dd>
121 </dl> 119 </dl>
122 <a NAME="HgAnnotateDialog.__buildSkipList" ID="HgAnnotateDialog.__buildSkipList"></a> 120 <a NAME="HgAnnotateDialog.__buildSkipList" ID="HgAnnotateDialog.__buildSkipList"></a>
123 <h4>HgAnnotateDialog.__buildSkipList</h4> 121 <h4>HgAnnotateDialog.__buildSkipList</h4>
124 <b>__buildSkipList</b>(<i>skiplist</i>) 122 <b>__buildSkipList</b>(<i>skiplist</i>)
125
126 <p> 123 <p>
127 Private method to build a program arguments list of changesets to be skipped. 124 Private method to build a program arguments list of changesets to be skipped.
128 </p> 125 </p>
126
129 <dl> 127 <dl>
130 128
131 <dt><i>skiplist</i> (str)</dt> 129 <dt><i>skiplist</i> (str)</dt>
132 <dd> 130 <dd>
133 name of a skip list file 131 name of a skip list file
146 </dd> 144 </dd>
147 </dl> 145 </dl>
148 <a NAME="HgAnnotateDialog.__finish" ID="HgAnnotateDialog.__finish"></a> 146 <a NAME="HgAnnotateDialog.__finish" ID="HgAnnotateDialog.__finish"></a>
149 <h4>HgAnnotateDialog.__finish</h4> 147 <h4>HgAnnotateDialog.__finish</h4>
150 <b>__finish</b>(<i></i>) 148 <b>__finish</b>(<i></i>)
151
152 <p> 149 <p>
153 Private slot called when the process finished or the user pressed 150 Private slot called when the process finished or the user pressed
154 the button. 151 the button.
155 </p> 152 </p>
153
156 <a NAME="HgAnnotateDialog.__generateItem" ID="HgAnnotateDialog.__generateItem"></a> 154 <a NAME="HgAnnotateDialog.__generateItem" ID="HgAnnotateDialog.__generateItem"></a>
157 <h4>HgAnnotateDialog.__generateItem</h4> 155 <h4>HgAnnotateDialog.__generateItem</h4>
158 <b>__generateItem</b>(<i>marker, revision, changeset, author, date, text</i>) 156 <b>__generateItem</b>(<i>marker, revision, changeset, author, date, text</i>)
159
160 <p> 157 <p>
161 Private method to generate an annotate item in the annotation list. 158 Private method to generate an annotate item in the annotation list.
162 </p> 159 </p>
160
163 <dl> 161 <dl>
164 162
165 <dt><i>marker</i> (str)</dt> 163 <dt><i>marker</i> (str)</dt>
166 <dd> 164 <dd>
167 marker character for skipped revisions 165 marker character for skipped revisions
188 </dd> 186 </dd>
189 </dl> 187 </dl>
190 <a NAME="HgAnnotateDialog.__processOutputLine" ID="HgAnnotateDialog.__processOutputLine"></a> 188 <a NAME="HgAnnotateDialog.__processOutputLine" ID="HgAnnotateDialog.__processOutputLine"></a>
191 <h4>HgAnnotateDialog.__processOutputLine</h4> 189 <h4>HgAnnotateDialog.__processOutputLine</h4>
192 <b>__processOutputLine</b>(<i>line</i>) 190 <b>__processOutputLine</b>(<i>line</i>)
193
194 <p> 191 <p>
195 Private method to process the lines of output. 192 Private method to process the lines of output.
196 </p> 193 </p>
194
197 <dl> 195 <dl>
198 196
199 <dt><i>line</i> (str)</dt> 197 <dt><i>line</i> (str)</dt>
200 <dd> 198 <dd>
201 output line to be processed 199 output line to be processed
202 </dd> 200 </dd>
203 </dl> 201 </dl>
204 <a NAME="HgAnnotateDialog.__resizeColumns" ID="HgAnnotateDialog.__resizeColumns"></a> 202 <a NAME="HgAnnotateDialog.__resizeColumns" ID="HgAnnotateDialog.__resizeColumns"></a>
205 <h4>HgAnnotateDialog.__resizeColumns</h4> 203 <h4>HgAnnotateDialog.__resizeColumns</h4>
206 <b>__resizeColumns</b>(<i></i>) 204 <b>__resizeColumns</b>(<i></i>)
207
208 <p> 205 <p>
209 Private method to resize the list columns. 206 Private method to resize the list columns.
210 </p> 207 </p>
208
211 <a NAME="HgAnnotateDialog.__showError" ID="HgAnnotateDialog.__showError"></a> 209 <a NAME="HgAnnotateDialog.__showError" ID="HgAnnotateDialog.__showError"></a>
212 <h4>HgAnnotateDialog.__showError</h4> 210 <h4>HgAnnotateDialog.__showError</h4>
213 <b>__showError</b>(<i>out</i>) 211 <b>__showError</b>(<i>out</i>)
214
215 <p> 212 <p>
216 Private slot to show some error. 213 Private slot to show some error.
217 </p> 214 </p>
215
218 <dl> 216 <dl>
219 217
220 <dt><i>out</i> (str)</dt> 218 <dt><i>out</i> (str)</dt>
221 <dd> 219 <dd>
222 error to be shown 220 error to be shown
223 </dd> 221 </dd>
224 </dl> 222 </dl>
225 <a NAME="HgAnnotateDialog.closeEvent" ID="HgAnnotateDialog.closeEvent"></a> 223 <a NAME="HgAnnotateDialog.closeEvent" ID="HgAnnotateDialog.closeEvent"></a>
226 <h4>HgAnnotateDialog.closeEvent</h4> 224 <h4>HgAnnotateDialog.closeEvent</h4>
227 <b>closeEvent</b>(<i>e</i>) 225 <b>closeEvent</b>(<i>e</i>)
228
229 <p> 226 <p>
230 Protected slot implementing a close event handler. 227 Protected slot implementing a close event handler.
231 </p> 228 </p>
229
232 <dl> 230 <dl>
233 231
234 <dt><i>e</i> (QCloseEvent)</dt> 232 <dt><i>e</i> (QCloseEvent)</dt>
235 <dd> 233 <dd>
236 close event 234 close event
237 </dd> 235 </dd>
238 </dl> 236 </dl>
239 <a NAME="HgAnnotateDialog.on_buttonBox_clicked" ID="HgAnnotateDialog.on_buttonBox_clicked"></a> 237 <a NAME="HgAnnotateDialog.on_buttonBox_clicked" ID="HgAnnotateDialog.on_buttonBox_clicked"></a>
240 <h4>HgAnnotateDialog.on_buttonBox_clicked</h4> 238 <h4>HgAnnotateDialog.on_buttonBox_clicked</h4>
241 <b>on_buttonBox_clicked</b>(<i>button</i>) 239 <b>on_buttonBox_clicked</b>(<i>button</i>)
242
243 <p> 240 <p>
244 Private slot called by a button of the button box clicked. 241 Private slot called by a button of the button box clicked.
245 </p> 242 </p>
243
246 <dl> 244 <dl>
247 245
248 <dt><i>button</i> (QAbstractButton)</dt> 246 <dt><i>button</i> (QAbstractButton)</dt>
249 <dd> 247 <dd>
250 button that was clicked 248 button that was clicked
251 </dd> 249 </dd>
252 </dl> 250 </dl>
253 <a NAME="HgAnnotateDialog.start" ID="HgAnnotateDialog.start"></a> 251 <a NAME="HgAnnotateDialog.start" ID="HgAnnotateDialog.start"></a>
254 <h4>HgAnnotateDialog.start</h4> 252 <h4>HgAnnotateDialog.start</h4>
255 <b>start</b>(<i>fn, skiplist=""</i>) 253 <b>start</b>(<i>fn, skiplist=""</i>)
256
257 <p> 254 <p>
258 Public slot to start the annotate command. 255 Public slot to start the annotate command.
259 </p> 256 </p>
257
260 <dl> 258 <dl>
261 259
262 <dt><i>fn</i> (str)</dt> 260 <dt><i>fn</i> (str)</dt>
263 <dd> 261 <dd>
264 filename to show the annotation for 262 filename to show the annotation for

eric ide

mercurial