Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDescribeDialog.html

eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDescribeDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitDescribeDialog</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitDescribeDialog</h1>
24
25 <p>
26 Module implementing a dialog to show the results of the git describe action.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#GitDescribeDialog">GitDescribeDialog</a></td>
39 <td>Class implementing a dialog to show the results of the git describe action.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="GitDescribeDialog" ID="GitDescribeDialog"></a>
50 <h2>GitDescribeDialog</h2>
51
52 <p>
53 Class implementing a dialog to show the results of the git describe action.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_GitDescribeDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#GitDescribeDialog.__init__">GitDescribeDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#GitDescribeDialog.__finish">__finish</a></td>
77 <td>Private slot called when the process finished or the user pressed the button.</td>
78 </tr>
79 <tr>
80 <td><a href="#GitDescribeDialog.__procFinished">__procFinished</a></td>
81 <td>Private slot connected to the finished signal.</td>
82 </tr>
83 <tr>
84 <td><a href="#GitDescribeDialog.__readStderr">__readStderr</a></td>
85 <td>Private slot to handle the readyReadStderr signal.</td>
86 </tr>
87 <tr>
88 <td><a href="#GitDescribeDialog.__readStdout">__readStdout</a></td>
89 <td>Private slot to handle the readyReadStdout signal.</td>
90 </tr>
91 <tr>
92 <td><a href="#GitDescribeDialog.__resizeColumns">__resizeColumns</a></td>
93 <td>Private method to resize the list columns.</td>
94 </tr>
95 <tr>
96 <td><a href="#GitDescribeDialog.__resort">__resort</a></td>
97 <td>Private method to resort the tree.</td>
98 </tr>
99 <tr>
100 <td><a href="#GitDescribeDialog.closeEvent">closeEvent</a></td>
101 <td>Protected slot implementing a close event handler.</td>
102 </tr>
103 <tr>
104 <td><a href="#GitDescribeDialog.keyPressEvent">keyPressEvent</a></td>
105 <td>Protected slot to handle a key press event.</td>
106 </tr>
107 <tr>
108 <td><a href="#GitDescribeDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
109 <td>Private slot called by a button of the button box clicked.</td>
110 </tr>
111 <tr>
112 <td><a href="#GitDescribeDialog.on_input_returnPressed">on_input_returnPressed</a></td>
113 <td>Private slot to handle the press of the return key in the input field.</td>
114 </tr>
115 <tr>
116 <td><a href="#GitDescribeDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
117 <td>Private slot to handle the password checkbox toggled.</td>
118 </tr>
119 <tr>
120 <td><a href="#GitDescribeDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
121 <td>Private slot to send the input to the git process.</td>
122 </tr>
123 <tr>
124 <td><a href="#GitDescribeDialog.start">start</a></td>
125 <td>Public slot to start the tag/branch list command.</td>
126 </tr>
127 </table>
128 <h3>Static Methods</h3>
129
130 <table>
131 <tr><td>None</td></tr>
132 </table>
133
134 <a NAME="GitDescribeDialog.__init__" ID="GitDescribeDialog.__init__"></a>
135 <h4>GitDescribeDialog (Constructor)</h4>
136 <b>GitDescribeDialog</b>(<i>vcs, parent=None</i>)
137
138 <p>
139 Constructor
140 </p>
141 <dl>
142
143 <dt><i>vcs</i></dt>
144 <dd>
145 reference to the vcs object
146 </dd>
147 <dt><i>parent</i></dt>
148 <dd>
149 reference to the parent widget (QWidget)
150 </dd>
151 </dl>
152 <a NAME="GitDescribeDialog.__finish" ID="GitDescribeDialog.__finish"></a>
153 <h4>GitDescribeDialog.__finish</h4>
154 <b>__finish</b>(<i></i>)
155
156 <p>
157 Private slot called when the process finished or the user pressed
158 the button.
159 </p>
160 <a NAME="GitDescribeDialog.__procFinished" ID="GitDescribeDialog.__procFinished"></a>
161 <h4>GitDescribeDialog.__procFinished</h4>
162 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
163
164 <p>
165 Private slot connected to the finished signal.
166 </p>
167 <dl>
168
169 <dt><i>exitCode</i></dt>
170 <dd>
171 exit code of the process (integer)
172 </dd>
173 <dt><i>exitStatus</i></dt>
174 <dd>
175 exit status of the process (QProcess.ExitStatus)
176 </dd>
177 </dl>
178 <a NAME="GitDescribeDialog.__readStderr" ID="GitDescribeDialog.__readStderr"></a>
179 <h4>GitDescribeDialog.__readStderr</h4>
180 <b>__readStderr</b>(<i></i>)
181
182 <p>
183 Private slot to handle the readyReadStderr signal.
184 </p>
185 <p>
186 It reads the error output of the process and inserts it into the
187 error pane.
188 </p>
189 <a NAME="GitDescribeDialog.__readStdout" ID="GitDescribeDialog.__readStdout"></a>
190 <h4>GitDescribeDialog.__readStdout</h4>
191 <b>__readStdout</b>(<i></i>)
192
193 <p>
194 Private slot to handle the readyReadStdout signal.
195 </p>
196 <p>
197 It reads the output of the process, formats it and inserts it into
198 the contents pane.
199 </p>
200 <a NAME="GitDescribeDialog.__resizeColumns" ID="GitDescribeDialog.__resizeColumns"></a>
201 <h4>GitDescribeDialog.__resizeColumns</h4>
202 <b>__resizeColumns</b>(<i></i>)
203
204 <p>
205 Private method to resize the list columns.
206 </p>
207 <a NAME="GitDescribeDialog.__resort" ID="GitDescribeDialog.__resort"></a>
208 <h4>GitDescribeDialog.__resort</h4>
209 <b>__resort</b>(<i></i>)
210
211 <p>
212 Private method to resort the tree.
213 </p>
214 <a NAME="GitDescribeDialog.closeEvent" ID="GitDescribeDialog.closeEvent"></a>
215 <h4>GitDescribeDialog.closeEvent</h4>
216 <b>closeEvent</b>(<i>e</i>)
217
218 <p>
219 Protected slot implementing a close event handler.
220 </p>
221 <dl>
222
223 <dt><i>e</i></dt>
224 <dd>
225 close event (QCloseEvent)
226 </dd>
227 </dl>
228 <a NAME="GitDescribeDialog.keyPressEvent" ID="GitDescribeDialog.keyPressEvent"></a>
229 <h4>GitDescribeDialog.keyPressEvent</h4>
230 <b>keyPressEvent</b>(<i>evt</i>)
231
232 <p>
233 Protected slot to handle a key press event.
234 </p>
235 <dl>
236
237 <dt><i>evt</i></dt>
238 <dd>
239 the key press event (QKeyEvent)
240 </dd>
241 </dl>
242 <a NAME="GitDescribeDialog.on_buttonBox_clicked" ID="GitDescribeDialog.on_buttonBox_clicked"></a>
243 <h4>GitDescribeDialog.on_buttonBox_clicked</h4>
244 <b>on_buttonBox_clicked</b>(<i>button</i>)
245
246 <p>
247 Private slot called by a button of the button box clicked.
248 </p>
249 <dl>
250
251 <dt><i>button</i></dt>
252 <dd>
253 button that was clicked (QAbstractButton)
254 </dd>
255 </dl>
256 <a NAME="GitDescribeDialog.on_input_returnPressed" ID="GitDescribeDialog.on_input_returnPressed"></a>
257 <h4>GitDescribeDialog.on_input_returnPressed</h4>
258 <b>on_input_returnPressed</b>(<i></i>)
259
260 <p>
261 Private slot to handle the press of the return key in the input field.
262 </p>
263 <a NAME="GitDescribeDialog.on_passwordCheckBox_toggled" ID="GitDescribeDialog.on_passwordCheckBox_toggled"></a>
264 <h4>GitDescribeDialog.on_passwordCheckBox_toggled</h4>
265 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
266
267 <p>
268 Private slot to handle the password checkbox toggled.
269 </p>
270 <dl>
271
272 <dt><i>isOn</i></dt>
273 <dd>
274 flag indicating the status of the check box (boolean)
275 </dd>
276 </dl>
277 <a NAME="GitDescribeDialog.on_sendButton_clicked" ID="GitDescribeDialog.on_sendButton_clicked"></a>
278 <h4>GitDescribeDialog.on_sendButton_clicked</h4>
279 <b>on_sendButton_clicked</b>(<i></i>)
280
281 <p>
282 Private slot to send the input to the git process.
283 </p>
284 <a NAME="GitDescribeDialog.start" ID="GitDescribeDialog.start"></a>
285 <h4>GitDescribeDialog.start</h4>
286 <b>start</b>(<i>path, commits</i>)
287
288 <p>
289 Public slot to start the tag/branch list command.
290 </p>
291 <dl>
292
293 <dt><i>path</i></dt>
294 <dd>
295 name of directory to be listed (string)
296 </dd>
297 <dt><i>commits</i></dt>
298 <dd>
299 list of commits to be described (list of string)
300 </dd>
301 </dl>
302 <div align="right"><a href="#top">Up</a></div>
303 <hr />
304 </body></html>

Mercurial Repository: eric

eric ide

mercurial