Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
child 10690
fab36645aa7d
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.vcsGit.GitDescribeDialog</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitDescribeDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to show the results of the git describe action. 11 Module implementing a dialog to show the results of the git describe action.
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="#GitDescribeDialog">GitDescribeDialog</a></td> 22 <td><a href="#GitDescribeDialog">GitDescribeDialog</a></td>
25 <td>Class implementing a dialog to show the results of the git describe action.</td> 23 <td>Class implementing a dialog to show the results of the git describe action.</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="GitDescribeDialog" ID="GitDescribeDialog"></a> 34 <a NAME="GitDescribeDialog" ID="GitDescribeDialog"></a>
36 <h2>GitDescribeDialog</h2> 35 <h2>GitDescribeDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to show the results of the git describe action. 37 Class implementing a dialog to show the results of the git describe action.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_GitDescribeDialog 41 QDialog, Ui_GitDescribeDialog
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="#GitDescribeDialog.__init__">GitDescribeDialog</a></td> 55 <td><a href="#GitDescribeDialog.__init__">GitDescribeDialog</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
109 <tr> 106 <tr>
110 <td><a href="#GitDescribeDialog.start">start</a></td> 107 <td><a href="#GitDescribeDialog.start">start</a></td>
111 <td>Public slot to start the tag/branch list command.</td> 108 <td>Public slot to start the tag/branch list command.</td>
112 </tr> 109 </tr>
113 </table> 110 </table>
111
114 <h3>Static Methods</h3> 112 <h3>Static Methods</h3>
115 113 <table>
116 <table> 114 <tr><td>None</td></tr>
117 <tr><td>None</td></tr> 115 </table>
118 </table> 116
119 117
120 <a NAME="GitDescribeDialog.__init__" ID="GitDescribeDialog.__init__"></a> 118 <a NAME="GitDescribeDialog.__init__" ID="GitDescribeDialog.__init__"></a>
121 <h4>GitDescribeDialog (Constructor)</h4> 119 <h4>GitDescribeDialog (Constructor)</h4>
122 <b>GitDescribeDialog</b>(<i>vcs, parent=None</i>) 120 <b>GitDescribeDialog</b>(<i>vcs, parent=None</i>)
123
124 <p> 121 <p>
125 Constructor 122 Constructor
126 </p> 123 </p>
124
127 <dl> 125 <dl>
128 126
129 <dt><i>vcs</i> (Git)</dt> 127 <dt><i>vcs</i> (Git)</dt>
130 <dd> 128 <dd>
131 reference to the vcs object 129 reference to the vcs object
136 </dd> 134 </dd>
137 </dl> 135 </dl>
138 <a NAME="GitDescribeDialog.__finish" ID="GitDescribeDialog.__finish"></a> 136 <a NAME="GitDescribeDialog.__finish" ID="GitDescribeDialog.__finish"></a>
139 <h4>GitDescribeDialog.__finish</h4> 137 <h4>GitDescribeDialog.__finish</h4>
140 <b>__finish</b>(<i></i>) 138 <b>__finish</b>(<i></i>)
141
142 <p> 139 <p>
143 Private slot called when the process finished or the user pressed 140 Private slot called when the process finished or the user pressed
144 the button. 141 the button.
145 </p> 142 </p>
143
146 <a NAME="GitDescribeDialog.__procFinished" ID="GitDescribeDialog.__procFinished"></a> 144 <a NAME="GitDescribeDialog.__procFinished" ID="GitDescribeDialog.__procFinished"></a>
147 <h4>GitDescribeDialog.__procFinished</h4> 145 <h4>GitDescribeDialog.__procFinished</h4>
148 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 146 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
149
150 <p> 147 <p>
151 Private slot connected to the finished signal. 148 Private slot connected to the finished signal.
152 </p> 149 </p>
150
153 <dl> 151 <dl>
154 152
155 <dt><i>exitCode</i> (int)</dt> 153 <dt><i>exitCode</i> (int)</dt>
156 <dd> 154 <dd>
157 exit code of the process 155 exit code of the process
162 </dd> 160 </dd>
163 </dl> 161 </dl>
164 <a NAME="GitDescribeDialog.__readStderr" ID="GitDescribeDialog.__readStderr"></a> 162 <a NAME="GitDescribeDialog.__readStderr" ID="GitDescribeDialog.__readStderr"></a>
165 <h4>GitDescribeDialog.__readStderr</h4> 163 <h4>GitDescribeDialog.__readStderr</h4>
166 <b>__readStderr</b>(<i></i>) 164 <b>__readStderr</b>(<i></i>)
167
168 <p> 165 <p>
169 Private slot to handle the readyReadStderr signal. 166 Private slot to handle the readyReadStderr signal.
170 </p> 167 </p>
171 <p> 168 <p>
172 It reads the error output of the process and inserts it into the 169 It reads the error output of the process and inserts it into the
173 error pane. 170 error pane.
174 </p> 171 </p>
172
175 <a NAME="GitDescribeDialog.__readStdout" ID="GitDescribeDialog.__readStdout"></a> 173 <a NAME="GitDescribeDialog.__readStdout" ID="GitDescribeDialog.__readStdout"></a>
176 <h4>GitDescribeDialog.__readStdout</h4> 174 <h4>GitDescribeDialog.__readStdout</h4>
177 <b>__readStdout</b>(<i></i>) 175 <b>__readStdout</b>(<i></i>)
178
179 <p> 176 <p>
180 Private slot to handle the readyReadStdout signal. 177 Private slot to handle the readyReadStdout signal.
181 </p> 178 </p>
182 <p> 179 <p>
183 It reads the output of the process, formats it and inserts it into 180 It reads the output of the process, formats it and inserts it into
184 the contents pane. 181 the contents pane.
185 </p> 182 </p>
183
186 <a NAME="GitDescribeDialog.__resizeColumns" ID="GitDescribeDialog.__resizeColumns"></a> 184 <a NAME="GitDescribeDialog.__resizeColumns" ID="GitDescribeDialog.__resizeColumns"></a>
187 <h4>GitDescribeDialog.__resizeColumns</h4> 185 <h4>GitDescribeDialog.__resizeColumns</h4>
188 <b>__resizeColumns</b>(<i></i>) 186 <b>__resizeColumns</b>(<i></i>)
189
190 <p> 187 <p>
191 Private method to resize the list columns. 188 Private method to resize the list columns.
192 </p> 189 </p>
190
193 <a NAME="GitDescribeDialog.__resort" ID="GitDescribeDialog.__resort"></a> 191 <a NAME="GitDescribeDialog.__resort" ID="GitDescribeDialog.__resort"></a>
194 <h4>GitDescribeDialog.__resort</h4> 192 <h4>GitDescribeDialog.__resort</h4>
195 <b>__resort</b>(<i></i>) 193 <b>__resort</b>(<i></i>)
196
197 <p> 194 <p>
198 Private method to resort the tree. 195 Private method to resort the tree.
199 </p> 196 </p>
197
200 <a NAME="GitDescribeDialog.closeEvent" ID="GitDescribeDialog.closeEvent"></a> 198 <a NAME="GitDescribeDialog.closeEvent" ID="GitDescribeDialog.closeEvent"></a>
201 <h4>GitDescribeDialog.closeEvent</h4> 199 <h4>GitDescribeDialog.closeEvent</h4>
202 <b>closeEvent</b>(<i>e</i>) 200 <b>closeEvent</b>(<i>e</i>)
203
204 <p> 201 <p>
205 Protected slot implementing a close event handler. 202 Protected slot implementing a close event handler.
206 </p> 203 </p>
204
207 <dl> 205 <dl>
208 206
209 <dt><i>e</i> (QCloseEvent)</dt> 207 <dt><i>e</i> (QCloseEvent)</dt>
210 <dd> 208 <dd>
211 close event 209 close event
212 </dd> 210 </dd>
213 </dl> 211 </dl>
214 <a NAME="GitDescribeDialog.keyPressEvent" ID="GitDescribeDialog.keyPressEvent"></a> 212 <a NAME="GitDescribeDialog.keyPressEvent" ID="GitDescribeDialog.keyPressEvent"></a>
215 <h4>GitDescribeDialog.keyPressEvent</h4> 213 <h4>GitDescribeDialog.keyPressEvent</h4>
216 <b>keyPressEvent</b>(<i>evt</i>) 214 <b>keyPressEvent</b>(<i>evt</i>)
217
218 <p> 215 <p>
219 Protected slot to handle a key press event. 216 Protected slot to handle a key press event.
220 </p> 217 </p>
218
221 <dl> 219 <dl>
222 220
223 <dt><i>evt</i> (QKeyEvent)</dt> 221 <dt><i>evt</i> (QKeyEvent)</dt>
224 <dd> 222 <dd>
225 the key press event 223 the key press event
226 </dd> 224 </dd>
227 </dl> 225 </dl>
228 <a NAME="GitDescribeDialog.on_buttonBox_clicked" ID="GitDescribeDialog.on_buttonBox_clicked"></a> 226 <a NAME="GitDescribeDialog.on_buttonBox_clicked" ID="GitDescribeDialog.on_buttonBox_clicked"></a>
229 <h4>GitDescribeDialog.on_buttonBox_clicked</h4> 227 <h4>GitDescribeDialog.on_buttonBox_clicked</h4>
230 <b>on_buttonBox_clicked</b>(<i>button</i>) 228 <b>on_buttonBox_clicked</b>(<i>button</i>)
231
232 <p> 229 <p>
233 Private slot called by a button of the button box clicked. 230 Private slot called by a button of the button box clicked.
234 </p> 231 </p>
232
235 <dl> 233 <dl>
236 234
237 <dt><i>button</i> (QAbstractButton)</dt> 235 <dt><i>button</i> (QAbstractButton)</dt>
238 <dd> 236 <dd>
239 button that was clicked 237 button that was clicked
240 </dd> 238 </dd>
241 </dl> 239 </dl>
242 <a NAME="GitDescribeDialog.on_input_returnPressed" ID="GitDescribeDialog.on_input_returnPressed"></a> 240 <a NAME="GitDescribeDialog.on_input_returnPressed" ID="GitDescribeDialog.on_input_returnPressed"></a>
243 <h4>GitDescribeDialog.on_input_returnPressed</h4> 241 <h4>GitDescribeDialog.on_input_returnPressed</h4>
244 <b>on_input_returnPressed</b>(<i></i>) 242 <b>on_input_returnPressed</b>(<i></i>)
245
246 <p> 243 <p>
247 Private slot to handle the press of the return key in the input field. 244 Private slot to handle the press of the return key in the input field.
248 </p> 245 </p>
246
249 <a NAME="GitDescribeDialog.on_passwordCheckBox_toggled" ID="GitDescribeDialog.on_passwordCheckBox_toggled"></a> 247 <a NAME="GitDescribeDialog.on_passwordCheckBox_toggled" ID="GitDescribeDialog.on_passwordCheckBox_toggled"></a>
250 <h4>GitDescribeDialog.on_passwordCheckBox_toggled</h4> 248 <h4>GitDescribeDialog.on_passwordCheckBox_toggled</h4>
251 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) 249 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
252
253 <p> 250 <p>
254 Private slot to handle the password checkbox toggled. 251 Private slot to handle the password checkbox toggled.
255 </p> 252 </p>
253
256 <dl> 254 <dl>
257 255
258 <dt><i>isOn</i> (bool)</dt> 256 <dt><i>isOn</i> (bool)</dt>
259 <dd> 257 <dd>
260 flag indicating the status of the check box 258 flag indicating the status of the check box
261 </dd> 259 </dd>
262 </dl> 260 </dl>
263 <a NAME="GitDescribeDialog.on_sendButton_clicked" ID="GitDescribeDialog.on_sendButton_clicked"></a> 261 <a NAME="GitDescribeDialog.on_sendButton_clicked" ID="GitDescribeDialog.on_sendButton_clicked"></a>
264 <h4>GitDescribeDialog.on_sendButton_clicked</h4> 262 <h4>GitDescribeDialog.on_sendButton_clicked</h4>
265 <b>on_sendButton_clicked</b>(<i></i>) 263 <b>on_sendButton_clicked</b>(<i></i>)
266
267 <p> 264 <p>
268 Private slot to send the input to the git process. 265 Private slot to send the input to the git process.
269 </p> 266 </p>
267
270 <a NAME="GitDescribeDialog.start" ID="GitDescribeDialog.start"></a> 268 <a NAME="GitDescribeDialog.start" ID="GitDescribeDialog.start"></a>
271 <h4>GitDescribeDialog.start</h4> 269 <h4>GitDescribeDialog.start</h4>
272 <b>start</b>(<i>path, commits</i>) 270 <b>start</b>(<i>path, commits</i>)
273
274 <p> 271 <p>
275 Public slot to start the tag/branch list command. 272 Public slot to start the tag/branch list command.
276 </p> 273 </p>
274
277 <dl> 275 <dl>
278 276
279 <dt><i>path</i> (str)</dt> 277 <dt><i>path</i> (str)</dt>
280 <dd> 278 <dd>
281 name of directory to be listed 279 name of directory to be listed

Mercurial Repository: eric

eric ide

mercurial