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 6942
2602857055c5
parent 4126
c28d0cf3b639
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog</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.HgAnnotateDialog</h1>
23 <p>
24 Module implementing a dialog to show the output of the hg annotate command.
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="#HgAnnotateDialog">HgAnnotateDialog</a></td>
34 <td>Class implementing a dialog to show the output of the hg annotate command.</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="HgAnnotateDialog" ID="HgAnnotateDialog"></a>
43 <h2>HgAnnotateDialog</h2>
44 <p>
45 Class implementing a dialog to show the output of the hg annotate command.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_HgAnnotateDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#HgAnnotateDialog.__init__">HgAnnotateDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#HgAnnotateDialog.__finish">__finish</a></td>
64 <td>Private slot called when the process finished or the user pressed the button.</td>
65 </tr><tr>
66 <td><a href="#HgAnnotateDialog.__generateItem">__generateItem</a></td>
67 <td>Private method to generate an annotate item in the annotation list.</td>
68 </tr><tr>
69 <td><a href="#HgAnnotateDialog.__procFinished">__procFinished</a></td>
70 <td>Private slot connected to the finished signal.</td>
71 </tr><tr>
72 <td><a href="#HgAnnotateDialog.__processOutputLine">__processOutputLine</a></td>
73 <td>Private method to process the lines of output.</td>
74 </tr><tr>
75 <td><a href="#HgAnnotateDialog.__readStderr">__readStderr</a></td>
76 <td>Private slot to handle the readyReadStderr signal.</td>
77 </tr><tr>
78 <td><a href="#HgAnnotateDialog.__readStdout">__readStdout</a></td>
79 <td>Private slot to handle the readyReadStdout signal.</td>
80 </tr><tr>
81 <td><a href="#HgAnnotateDialog.__resizeColumns">__resizeColumns</a></td>
82 <td>Private method to resize the list columns.</td>
83 </tr><tr>
84 <td><a href="#HgAnnotateDialog.__showError">__showError</a></td>
85 <td>Private slot to show some error.</td>
86 </tr><tr>
87 <td><a href="#HgAnnotateDialog.closeEvent">closeEvent</a></td>
88 <td>Protected slot implementing a close event handler.</td>
89 </tr><tr>
90 <td><a href="#HgAnnotateDialog.keyPressEvent">keyPressEvent</a></td>
91 <td>Protected slot to handle a key press event.</td>
92 </tr><tr>
93 <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>
95 </tr><tr>
96 <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>
98 </tr><tr>
99 <td><a href="#HgAnnotateDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
100 <td>Private slot to handle the password checkbox toggled.</td>
101 </tr><tr>
102 <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>
104 </tr><tr>
105 <td><a href="#HgAnnotateDialog.start">start</a></td>
106 <td>Public slot to start the annotate command.</td>
107 </tr>
108 </table>
109 <h3>Static Methods</h3>
110 <table>
111 <tr><td>None</td></tr>
112 </table>
113 <a NAME="HgAnnotateDialog.__init__" ID="HgAnnotateDialog.__init__"></a>
114 <h4>HgAnnotateDialog (Constructor)</h4>
115 <b>HgAnnotateDialog</b>(<i>vcs, parent=None</i>)
116 <p>
117 Constructor
118 </p><dl>
119 <dt><i>vcs</i></dt>
120 <dd>
121 reference to the vcs object
122 </dd><dt><i>parent</i></dt>
123 <dd>
124 parent widget (QWidget)
125 </dd>
126 </dl><a NAME="HgAnnotateDialog.__finish" ID="HgAnnotateDialog.__finish"></a>
127 <h4>HgAnnotateDialog.__finish</h4>
128 <b>__finish</b>(<i></i>)
129 <p>
130 Private slot called when the process finished or the user pressed
131 the button.
132 </p><a NAME="HgAnnotateDialog.__generateItem" ID="HgAnnotateDialog.__generateItem"></a>
133 <h4>HgAnnotateDialog.__generateItem</h4>
134 <b>__generateItem</b>(<i>revision, changeset, author, date, text</i>)
135 <p>
136 Private method to generate an annotate item in the annotation list.
137 </p><dl>
138 <dt><i>revision</i></dt>
139 <dd>
140 revision string (string)
141 </dd><dt><i>changeset</i></dt>
142 <dd>
143 changeset string (string)
144 </dd><dt><i>author</i></dt>
145 <dd>
146 author of the change (string)
147 </dd><dt><i>date</i></dt>
148 <dd>
149 date of the change (string)
150 </dd><dt><i>text</i></dt>
151 <dd>
152 text of the change (string)
153 </dd>
154 </dl><a NAME="HgAnnotateDialog.__procFinished" ID="HgAnnotateDialog.__procFinished"></a>
155 <h4>HgAnnotateDialog.__procFinished</h4>
156 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
157 <p>
158 Private slot connected to the finished signal.
159 </p><dl>
160 <dt><i>exitCode</i></dt>
161 <dd>
162 exit code of the process (integer)
163 </dd><dt><i>exitStatus</i></dt>
164 <dd>
165 exit status of the process (QProcess.ExitStatus)
166 </dd>
167 </dl><a NAME="HgAnnotateDialog.__processOutputLine" ID="HgAnnotateDialog.__processOutputLine"></a>
168 <h4>HgAnnotateDialog.__processOutputLine</h4>
169 <b>__processOutputLine</b>(<i>line</i>)
170 <p>
171 Private method to process the lines of output.
172 </p><dl>
173 <dt><i>line</i></dt>
174 <dd>
175 output line to be processed (string)
176 </dd>
177 </dl><a NAME="HgAnnotateDialog.__readStderr" ID="HgAnnotateDialog.__readStderr"></a>
178 <h4>HgAnnotateDialog.__readStderr</h4>
179 <b>__readStderr</b>(<i></i>)
180 <p>
181 Private slot to handle the readyReadStderr signal.
182 </p><p>
183 It reads the error output of the process and inserts it into the
184 error pane.
185 </p><a NAME="HgAnnotateDialog.__readStdout" ID="HgAnnotateDialog.__readStdout"></a>
186 <h4>HgAnnotateDialog.__readStdout</h4>
187 <b>__readStdout</b>(<i></i>)
188 <p>
189 Private slot to handle the readyReadStdout signal.
190 </p><p>
191 It reads the output of the process, formats it and inserts it into
192 the annotation list.
193 </p><a NAME="HgAnnotateDialog.__resizeColumns" ID="HgAnnotateDialog.__resizeColumns"></a>
194 <h4>HgAnnotateDialog.__resizeColumns</h4>
195 <b>__resizeColumns</b>(<i></i>)
196 <p>
197 Private method to resize the list columns.
198 </p><a NAME="HgAnnotateDialog.__showError" ID="HgAnnotateDialog.__showError"></a>
199 <h4>HgAnnotateDialog.__showError</h4>
200 <b>__showError</b>(<i>out</i>)
201 <p>
202 Private slot to show some error.
203 </p><dl>
204 <dt><i>out</i></dt>
205 <dd>
206 error to be shown (string)
207 </dd>
208 </dl><a NAME="HgAnnotateDialog.closeEvent" ID="HgAnnotateDialog.closeEvent"></a>
209 <h4>HgAnnotateDialog.closeEvent</h4>
210 <b>closeEvent</b>(<i>e</i>)
211 <p>
212 Protected slot implementing a close event handler.
213 </p><dl>
214 <dt><i>e</i></dt>
215 <dd>
216 close event (QCloseEvent)
217 </dd>
218 </dl><a NAME="HgAnnotateDialog.keyPressEvent" ID="HgAnnotateDialog.keyPressEvent"></a>
219 <h4>HgAnnotateDialog.keyPressEvent</h4>
220 <b>keyPressEvent</b>(<i>evt</i>)
221 <p>
222 Protected slot to handle a key press event.
223 </p><dl>
224 <dt><i>evt</i></dt>
225 <dd>
226 the key press event (QKeyEvent)
227 </dd>
228 </dl><a NAME="HgAnnotateDialog.on_buttonBox_clicked" ID="HgAnnotateDialog.on_buttonBox_clicked"></a>
229 <h4>HgAnnotateDialog.on_buttonBox_clicked</h4>
230 <b>on_buttonBox_clicked</b>(<i>button</i>)
231 <p>
232 Private slot called by a button of the button box clicked.
233 </p><dl>
234 <dt><i>button</i></dt>
235 <dd>
236 button that was clicked (QAbstractButton)
237 </dd>
238 </dl><a NAME="HgAnnotateDialog.on_input_returnPressed" ID="HgAnnotateDialog.on_input_returnPressed"></a>
239 <h4>HgAnnotateDialog.on_input_returnPressed</h4>
240 <b>on_input_returnPressed</b>(<i></i>)
241 <p>
242 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>
244 <h4>HgAnnotateDialog.on_passwordCheckBox_toggled</h4>
245 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
246 <p>
247 Private slot to handle the password checkbox toggled.
248 </p><dl>
249 <dt><i>isOn</i></dt>
250 <dd>
251 flag indicating the status of the check box (boolean)
252 </dd>
253 </dl><a NAME="HgAnnotateDialog.on_sendButton_clicked" ID="HgAnnotateDialog.on_sendButton_clicked"></a>
254 <h4>HgAnnotateDialog.on_sendButton_clicked</h4>
255 <b>on_sendButton_clicked</b>(<i></i>)
256 <p>
257 Private slot to send the input to the hg process.
258 </p><a NAME="HgAnnotateDialog.start" ID="HgAnnotateDialog.start"></a>
259 <h4>HgAnnotateDialog.start</h4>
260 <b>start</b>(<i>fn</i>)
261 <p>
262 Public slot to start the annotate command.
263 </p><dl>
264 <dt><i>fn</i></dt>
265 <dd>
266 filename to show the annotation for (string)
267 </dd>
268 </dl>
269 <div align="right"><a href="#top">Up</a></div>
270 <hr />
271 </body></html>

Mercurial Repository: eric

eric ide

mercurial