Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog.html

eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7370
5fb53279f2df
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog</h1> 23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog to show the output of the hg annotate command. 26 Module implementing a dialog to show the output of the hg annotate command.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#HgAnnotateDialog">HgAnnotateDialog</a></td> 38 <td><a href="#HgAnnotateDialog">HgAnnotateDialog</a></td>
34 <td>Class implementing a dialog to show the output of the hg annotate command.</td> 39 <td>Class implementing a dialog to show the output of the hg annotate command.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="HgAnnotateDialog" ID="HgAnnotateDialog"></a> 49 <a NAME="HgAnnotateDialog" ID="HgAnnotateDialog"></a>
43 <h2>HgAnnotateDialog</h2> 50 <h2>HgAnnotateDialog</h2>
51
44 <p> 52 <p>
45 Class implementing a dialog to show the output of the hg annotate command. 53 Class implementing a dialog to show the output of the hg annotate command.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 QDialog, Ui_HgAnnotateDialog 56 QDialog, Ui_HgAnnotateDialog
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#HgAnnotateDialog.__init__">HgAnnotateDialog</a></td> 72 <td><a href="#HgAnnotateDialog.__init__">HgAnnotateDialog</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#HgAnnotateDialog.__finish">__finish</a></td> 76 <td><a href="#HgAnnotateDialog.__finish">__finish</a></td>
64 <td>Private slot called when the process finished or the user pressed the button.</td> 77 <td>Private slot called when the process finished or the user pressed the button.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#HgAnnotateDialog.__generateItem">__generateItem</a></td> 80 <td><a href="#HgAnnotateDialog.__generateItem">__generateItem</a></td>
67 <td>Private method to generate an annotate item in the annotation list.</td> 81 <td>Private method to generate an annotate item in the annotation list.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#HgAnnotateDialog.__procFinished">__procFinished</a></td> 84 <td><a href="#HgAnnotateDialog.__procFinished">__procFinished</a></td>
70 <td>Private slot connected to the finished signal.</td> 85 <td>Private slot connected to the finished signal.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#HgAnnotateDialog.__processOutputLine">__processOutputLine</a></td> 88 <td><a href="#HgAnnotateDialog.__processOutputLine">__processOutputLine</a></td>
73 <td>Private method to process the lines of output.</td> 89 <td>Private method to process the lines of output.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#HgAnnotateDialog.__readStderr">__readStderr</a></td> 92 <td><a href="#HgAnnotateDialog.__readStderr">__readStderr</a></td>
76 <td>Private slot to handle the readyReadStderr signal.</td> 93 <td>Private slot to handle the readyReadStderr signal.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#HgAnnotateDialog.__readStdout">__readStdout</a></td> 96 <td><a href="#HgAnnotateDialog.__readStdout">__readStdout</a></td>
79 <td>Private slot to handle the readyReadStdout signal.</td> 97 <td>Private slot to handle the readyReadStdout signal.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#HgAnnotateDialog.__resizeColumns">__resizeColumns</a></td> 100 <td><a href="#HgAnnotateDialog.__resizeColumns">__resizeColumns</a></td>
82 <td>Private method to resize the list columns.</td> 101 <td>Private method to resize the list columns.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#HgAnnotateDialog.__showError">__showError</a></td> 104 <td><a href="#HgAnnotateDialog.__showError">__showError</a></td>
85 <td>Private slot to show some error.</td> 105 <td>Private slot to show some error.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#HgAnnotateDialog.closeEvent">closeEvent</a></td> 108 <td><a href="#HgAnnotateDialog.closeEvent">closeEvent</a></td>
88 <td>Protected slot implementing a close event handler.</td> 109 <td>Protected slot implementing a close event handler.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#HgAnnotateDialog.keyPressEvent">keyPressEvent</a></td> 112 <td><a href="#HgAnnotateDialog.keyPressEvent">keyPressEvent</a></td>
91 <td>Protected slot to handle a key press event.</td> 113 <td>Protected slot to handle a key press event.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#HgAnnotateDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 116 <td><a href="#HgAnnotateDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
94 <td>Private slot called by a button of the button box clicked.</td> 117 <td>Private slot called by a button of the button box clicked.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#HgAnnotateDialog.on_input_returnPressed">on_input_returnPressed</a></td> 120 <td><a href="#HgAnnotateDialog.on_input_returnPressed">on_input_returnPressed</a></td>
97 <td>Private slot to handle the press of the return key in the input field.</td> 121 <td>Private slot to handle the press of the return key in the input field.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#HgAnnotateDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> 124 <td><a href="#HgAnnotateDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
100 <td>Private slot to handle the password checkbox toggled.</td> 125 <td>Private slot to handle the password checkbox toggled.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#HgAnnotateDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> 128 <td><a href="#HgAnnotateDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
103 <td>Private slot to send the input to the hg process.</td> 129 <td>Private slot to send the input to the hg process.</td>
104 </tr><tr> 130 </tr>
131 <tr>
105 <td><a href="#HgAnnotateDialog.start">start</a></td> 132 <td><a href="#HgAnnotateDialog.start">start</a></td>
106 <td>Public slot to start the annotate command.</td> 133 <td>Public slot to start the annotate command.</td>
107 </tr> 134 </tr>
108 </table> 135 </table>
109 <h3>Static Methods</h3> 136 <h3>Static Methods</h3>
110 <table> 137
111 <tr><td>None</td></tr> 138 <table>
112 </table> 139 <tr><td>None</td></tr>
140 </table>
141
113 <a NAME="HgAnnotateDialog.__init__" ID="HgAnnotateDialog.__init__"></a> 142 <a NAME="HgAnnotateDialog.__init__" ID="HgAnnotateDialog.__init__"></a>
114 <h4>HgAnnotateDialog (Constructor)</h4> 143 <h4>HgAnnotateDialog (Constructor)</h4>
115 <b>HgAnnotateDialog</b>(<i>vcs, parent=None</i>) 144 <b>HgAnnotateDialog</b>(<i>vcs, parent=None</i>)
145
116 <p> 146 <p>
117 Constructor 147 Constructor
118 </p><dl> 148 </p>
149 <dl>
150
119 <dt><i>vcs</i></dt> 151 <dt><i>vcs</i></dt>
120 <dd> 152 <dd>
121 reference to the vcs object 153 reference to the vcs object
122 </dd><dt><i>parent</i></dt> 154 </dd>
155 <dt><i>parent</i></dt>
123 <dd> 156 <dd>
124 parent widget (QWidget) 157 parent widget (QWidget)
125 </dd> 158 </dd>
126 </dl><a NAME="HgAnnotateDialog.__finish" ID="HgAnnotateDialog.__finish"></a> 159 </dl>
160 <a NAME="HgAnnotateDialog.__finish" ID="HgAnnotateDialog.__finish"></a>
127 <h4>HgAnnotateDialog.__finish</h4> 161 <h4>HgAnnotateDialog.__finish</h4>
128 <b>__finish</b>(<i></i>) 162 <b>__finish</b>(<i></i>)
163
129 <p> 164 <p>
130 Private slot called when the process finished or the user pressed 165 Private slot called when the process finished or the user pressed
131 the button. 166 the button.
132 </p><a NAME="HgAnnotateDialog.__generateItem" ID="HgAnnotateDialog.__generateItem"></a> 167 </p>
168 <a NAME="HgAnnotateDialog.__generateItem" ID="HgAnnotateDialog.__generateItem"></a>
133 <h4>HgAnnotateDialog.__generateItem</h4> 169 <h4>HgAnnotateDialog.__generateItem</h4>
134 <b>__generateItem</b>(<i>revision, changeset, author, date, text</i>) 170 <b>__generateItem</b>(<i>revision, changeset, author, date, text</i>)
171
135 <p> 172 <p>
136 Private method to generate an annotate item in the annotation list. 173 Private method to generate an annotate item in the annotation list.
137 </p><dl> 174 </p>
175 <dl>
176
138 <dt><i>revision</i></dt> 177 <dt><i>revision</i></dt>
139 <dd> 178 <dd>
140 revision string (string) 179 revision string (string)
141 </dd><dt><i>changeset</i></dt> 180 </dd>
181 <dt><i>changeset</i></dt>
142 <dd> 182 <dd>
143 changeset string (string) 183 changeset string (string)
144 </dd><dt><i>author</i></dt> 184 </dd>
185 <dt><i>author</i></dt>
145 <dd> 186 <dd>
146 author of the change (string) 187 author of the change (string)
147 </dd><dt><i>date</i></dt> 188 </dd>
189 <dt><i>date</i></dt>
148 <dd> 190 <dd>
149 date of the change (string) 191 date of the change (string)
150 </dd><dt><i>text</i></dt> 192 </dd>
193 <dt><i>text</i></dt>
151 <dd> 194 <dd>
152 text of the change (string) 195 text of the change (string)
153 </dd> 196 </dd>
154 </dl><a NAME="HgAnnotateDialog.__procFinished" ID="HgAnnotateDialog.__procFinished"></a> 197 </dl>
198 <a NAME="HgAnnotateDialog.__procFinished" ID="HgAnnotateDialog.__procFinished"></a>
155 <h4>HgAnnotateDialog.__procFinished</h4> 199 <h4>HgAnnotateDialog.__procFinished</h4>
156 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 200 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
201
157 <p> 202 <p>
158 Private slot connected to the finished signal. 203 Private slot connected to the finished signal.
159 </p><dl> 204 </p>
205 <dl>
206
160 <dt><i>exitCode</i></dt> 207 <dt><i>exitCode</i></dt>
161 <dd> 208 <dd>
162 exit code of the process (integer) 209 exit code of the process (integer)
163 </dd><dt><i>exitStatus</i></dt> 210 </dd>
211 <dt><i>exitStatus</i></dt>
164 <dd> 212 <dd>
165 exit status of the process (QProcess.ExitStatus) 213 exit status of the process (QProcess.ExitStatus)
166 </dd> 214 </dd>
167 </dl><a NAME="HgAnnotateDialog.__processOutputLine" ID="HgAnnotateDialog.__processOutputLine"></a> 215 </dl>
216 <a NAME="HgAnnotateDialog.__processOutputLine" ID="HgAnnotateDialog.__processOutputLine"></a>
168 <h4>HgAnnotateDialog.__processOutputLine</h4> 217 <h4>HgAnnotateDialog.__processOutputLine</h4>
169 <b>__processOutputLine</b>(<i>line</i>) 218 <b>__processOutputLine</b>(<i>line</i>)
219
170 <p> 220 <p>
171 Private method to process the lines of output. 221 Private method to process the lines of output.
172 </p><dl> 222 </p>
223 <dl>
224
173 <dt><i>line</i></dt> 225 <dt><i>line</i></dt>
174 <dd> 226 <dd>
175 output line to be processed (string) 227 output line to be processed (string)
176 </dd> 228 </dd>
177 </dl><a NAME="HgAnnotateDialog.__readStderr" ID="HgAnnotateDialog.__readStderr"></a> 229 </dl>
230 <a NAME="HgAnnotateDialog.__readStderr" ID="HgAnnotateDialog.__readStderr"></a>
178 <h4>HgAnnotateDialog.__readStderr</h4> 231 <h4>HgAnnotateDialog.__readStderr</h4>
179 <b>__readStderr</b>(<i></i>) 232 <b>__readStderr</b>(<i></i>)
233
180 <p> 234 <p>
181 Private slot to handle the readyReadStderr signal. 235 Private slot to handle the readyReadStderr signal.
182 </p><p> 236 </p>
237 <p>
183 It reads the error output of the process and inserts it into the 238 It reads the error output of the process and inserts it into the
184 error pane. 239 error pane.
185 </p><a NAME="HgAnnotateDialog.__readStdout" ID="HgAnnotateDialog.__readStdout"></a> 240 </p>
241 <a NAME="HgAnnotateDialog.__readStdout" ID="HgAnnotateDialog.__readStdout"></a>
186 <h4>HgAnnotateDialog.__readStdout</h4> 242 <h4>HgAnnotateDialog.__readStdout</h4>
187 <b>__readStdout</b>(<i></i>) 243 <b>__readStdout</b>(<i></i>)
244
188 <p> 245 <p>
189 Private slot to handle the readyReadStdout signal. 246 Private slot to handle the readyReadStdout signal.
190 </p><p> 247 </p>
248 <p>
191 It reads the output of the process, formats it and inserts it into 249 It reads the output of the process, formats it and inserts it into
192 the annotation list. 250 the annotation list.
193 </p><a NAME="HgAnnotateDialog.__resizeColumns" ID="HgAnnotateDialog.__resizeColumns"></a> 251 </p>
252 <a NAME="HgAnnotateDialog.__resizeColumns" ID="HgAnnotateDialog.__resizeColumns"></a>
194 <h4>HgAnnotateDialog.__resizeColumns</h4> 253 <h4>HgAnnotateDialog.__resizeColumns</h4>
195 <b>__resizeColumns</b>(<i></i>) 254 <b>__resizeColumns</b>(<i></i>)
255
196 <p> 256 <p>
197 Private method to resize the list columns. 257 Private method to resize the list columns.
198 </p><a NAME="HgAnnotateDialog.__showError" ID="HgAnnotateDialog.__showError"></a> 258 </p>
259 <a NAME="HgAnnotateDialog.__showError" ID="HgAnnotateDialog.__showError"></a>
199 <h4>HgAnnotateDialog.__showError</h4> 260 <h4>HgAnnotateDialog.__showError</h4>
200 <b>__showError</b>(<i>out</i>) 261 <b>__showError</b>(<i>out</i>)
262
201 <p> 263 <p>
202 Private slot to show some error. 264 Private slot to show some error.
203 </p><dl> 265 </p>
266 <dl>
267
204 <dt><i>out</i></dt> 268 <dt><i>out</i></dt>
205 <dd> 269 <dd>
206 error to be shown (string) 270 error to be shown (string)
207 </dd> 271 </dd>
208 </dl><a NAME="HgAnnotateDialog.closeEvent" ID="HgAnnotateDialog.closeEvent"></a> 272 </dl>
273 <a NAME="HgAnnotateDialog.closeEvent" ID="HgAnnotateDialog.closeEvent"></a>
209 <h4>HgAnnotateDialog.closeEvent</h4> 274 <h4>HgAnnotateDialog.closeEvent</h4>
210 <b>closeEvent</b>(<i>e</i>) 275 <b>closeEvent</b>(<i>e</i>)
276
211 <p> 277 <p>
212 Protected slot implementing a close event handler. 278 Protected slot implementing a close event handler.
213 </p><dl> 279 </p>
280 <dl>
281
214 <dt><i>e</i></dt> 282 <dt><i>e</i></dt>
215 <dd> 283 <dd>
216 close event (QCloseEvent) 284 close event (QCloseEvent)
217 </dd> 285 </dd>
218 </dl><a NAME="HgAnnotateDialog.keyPressEvent" ID="HgAnnotateDialog.keyPressEvent"></a> 286 </dl>
287 <a NAME="HgAnnotateDialog.keyPressEvent" ID="HgAnnotateDialog.keyPressEvent"></a>
219 <h4>HgAnnotateDialog.keyPressEvent</h4> 288 <h4>HgAnnotateDialog.keyPressEvent</h4>
220 <b>keyPressEvent</b>(<i>evt</i>) 289 <b>keyPressEvent</b>(<i>evt</i>)
290
221 <p> 291 <p>
222 Protected slot to handle a key press event. 292 Protected slot to handle a key press event.
223 </p><dl> 293 </p>
294 <dl>
295
224 <dt><i>evt</i></dt> 296 <dt><i>evt</i></dt>
225 <dd> 297 <dd>
226 the key press event (QKeyEvent) 298 the key press event (QKeyEvent)
227 </dd> 299 </dd>
228 </dl><a NAME="HgAnnotateDialog.on_buttonBox_clicked" ID="HgAnnotateDialog.on_buttonBox_clicked"></a> 300 </dl>
301 <a NAME="HgAnnotateDialog.on_buttonBox_clicked" ID="HgAnnotateDialog.on_buttonBox_clicked"></a>
229 <h4>HgAnnotateDialog.on_buttonBox_clicked</h4> 302 <h4>HgAnnotateDialog.on_buttonBox_clicked</h4>
230 <b>on_buttonBox_clicked</b>(<i>button</i>) 303 <b>on_buttonBox_clicked</b>(<i>button</i>)
304
231 <p> 305 <p>
232 Private slot called by a button of the button box clicked. 306 Private slot called by a button of the button box clicked.
233 </p><dl> 307 </p>
308 <dl>
309
234 <dt><i>button</i></dt> 310 <dt><i>button</i></dt>
235 <dd> 311 <dd>
236 button that was clicked (QAbstractButton) 312 button that was clicked (QAbstractButton)
237 </dd> 313 </dd>
238 </dl><a NAME="HgAnnotateDialog.on_input_returnPressed" ID="HgAnnotateDialog.on_input_returnPressed"></a> 314 </dl>
315 <a NAME="HgAnnotateDialog.on_input_returnPressed" ID="HgAnnotateDialog.on_input_returnPressed"></a>
239 <h4>HgAnnotateDialog.on_input_returnPressed</h4> 316 <h4>HgAnnotateDialog.on_input_returnPressed</h4>
240 <b>on_input_returnPressed</b>(<i></i>) 317 <b>on_input_returnPressed</b>(<i></i>)
318
241 <p> 319 <p>
242 Private slot to handle the press of the return key in the input field. 320 Private slot to handle the press of the return key in the input field.
243 </p><a NAME="HgAnnotateDialog.on_passwordCheckBox_toggled" ID="HgAnnotateDialog.on_passwordCheckBox_toggled"></a> 321 </p>
322 <a NAME="HgAnnotateDialog.on_passwordCheckBox_toggled" ID="HgAnnotateDialog.on_passwordCheckBox_toggled"></a>
244 <h4>HgAnnotateDialog.on_passwordCheckBox_toggled</h4> 323 <h4>HgAnnotateDialog.on_passwordCheckBox_toggled</h4>
245 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) 324 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
325
246 <p> 326 <p>
247 Private slot to handle the password checkbox toggled. 327 Private slot to handle the password checkbox toggled.
248 </p><dl> 328 </p>
329 <dl>
330
249 <dt><i>isOn</i></dt> 331 <dt><i>isOn</i></dt>
250 <dd> 332 <dd>
251 flag indicating the status of the check box (boolean) 333 flag indicating the status of the check box (boolean)
252 </dd> 334 </dd>
253 </dl><a NAME="HgAnnotateDialog.on_sendButton_clicked" ID="HgAnnotateDialog.on_sendButton_clicked"></a> 335 </dl>
336 <a NAME="HgAnnotateDialog.on_sendButton_clicked" ID="HgAnnotateDialog.on_sendButton_clicked"></a>
254 <h4>HgAnnotateDialog.on_sendButton_clicked</h4> 337 <h4>HgAnnotateDialog.on_sendButton_clicked</h4>
255 <b>on_sendButton_clicked</b>(<i></i>) 338 <b>on_sendButton_clicked</b>(<i></i>)
339
256 <p> 340 <p>
257 Private slot to send the input to the hg process. 341 Private slot to send the input to the hg process.
258 </p><a NAME="HgAnnotateDialog.start" ID="HgAnnotateDialog.start"></a> 342 </p>
343 <a NAME="HgAnnotateDialog.start" ID="HgAnnotateDialog.start"></a>
259 <h4>HgAnnotateDialog.start</h4> 344 <h4>HgAnnotateDialog.start</h4>
260 <b>start</b>(<i>fn</i>) 345 <b>start</b>(<i>fn</i>)
346
261 <p> 347 <p>
262 Public slot to start the annotate command. 348 Public slot to start the annotate command.
263 </p><dl> 349 </p>
350 <dl>
351
264 <dt><i>fn</i></dt> 352 <dt><i>fn</i></dt>
265 <dd> 353 <dd>
266 filename to show the annotation for (string) 354 filename to show the annotation for (string)
267 </dd> 355 </dd>
268 </dl> 356 </dl>

Mercurial Repository: eric

eric ide

mercurial