Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial