Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitRemoteRepositoriesDialog.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitRemoteRepositoriesDialog.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10438
- 4cd7e5a8b3cf
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitRemoteRepositoriesDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitRemoteRepositoriesDialog</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a dialog to show available remote repositories. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#GitRemoteRepositoriesDialog">GitRemoteRepositoriesDialog</a></td> | |
| 25 <td>Class implementing a dialog to show available remote repositories.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="GitRemoteRepositoriesDialog" ID="GitRemoteRepositoriesDialog"></a> | |
| 36 <h2>GitRemoteRepositoriesDialog</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a dialog to show available remote repositories. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QWidget, Ui_GitRemoteRepositoriesDialog | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#GitRemoteRepositoriesDialog.__init__">GitRemoteRepositoriesDialog</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#GitRemoteRepositoriesDialog.__finish">__finish</a></td> | |
| 63 <td>Private slot called when the process finished or the user pressed the button.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#GitRemoteRepositoriesDialog.__generateItem">__generateItem</a></td> | |
| 67 <td>Private method to generate a status item in the status list.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#GitRemoteRepositoriesDialog.__procFinished">__procFinished</a></td> | |
| 71 <td>Private slot connected to the finished signal.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#GitRemoteRepositoriesDialog.__readStderr">__readStderr</a></td> | |
| 75 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#GitRemoteRepositoriesDialog.__readStdout">__readStdout</a></td> | |
| 79 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#GitRemoteRepositoriesDialog.__resizeColumns">__resizeColumns</a></td> | |
| 83 <td>Private method to resize the list columns.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#GitRemoteRepositoriesDialog.__resort">__resort</a></td> | |
| 87 <td>Private method to resort the list.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#GitRemoteRepositoriesDialog.__updateButtons">__updateButtons</a></td> | |
| 91 <td>Private method to update the buttons status.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#GitRemoteRepositoriesDialog.closeEvent">closeEvent</a></td> | |
| 95 <td>Protected slot implementing a close event handler.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#GitRemoteRepositoriesDialog.keyPressEvent">keyPressEvent</a></td> | |
| 99 <td>Protected slot to handle a key press event.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#GitRemoteRepositoriesDialog.on_addButton_clicked">on_addButton_clicked</a></td> | |
| 103 <td>Private slot to add a remote repository.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#GitRemoteRepositoriesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 107 <td>Private slot called by a button of the button box clicked.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#GitRemoteRepositoriesDialog.on_changeUrlButton_clicked">on_changeUrlButton_clicked</a></td> | |
| 111 <td>Private slot to change the URL of a remote repository.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#GitRemoteRepositoriesDialog.on_credentialsButton_clicked">on_credentialsButton_clicked</a></td> | |
| 115 <td>Private slot to change the credentials of a remote repository.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#GitRemoteRepositoriesDialog.on_input_returnPressed">on_input_returnPressed</a></td> | |
| 119 <td>Private slot to handle the press of the return key in the input field.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> | |
| 123 <td>Private slot to handle the password checkbox toggled.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#GitRemoteRepositoriesDialog.on_pruneButton_clicked">on_pruneButton_clicked</a></td> | |
| 127 <td>Private slot to prune all stale remote-tracking branches.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#GitRemoteRepositoriesDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> | |
| 131 <td>Private slot to refresh the status display.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#GitRemoteRepositoriesDialog.on_removeButton_clicked">on_removeButton_clicked</a></td> | |
| 135 <td>Private slot to remove a remote repository.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#GitRemoteRepositoriesDialog.on_renameButton_clicked">on_renameButton_clicked</a></td> | |
| 139 <td>Private slot to rename a remote repository.</td> | |
| 140 </tr> | |
| 141 <tr> | |
| 142 <td><a href="#GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged">on_repolist_itemSelectionChanged</a></td> | |
| 143 <td>Private slot to act upon changes of selected items.</td> | |
| 144 </tr> | |
| 145 <tr> | |
| 146 <td><a href="#GitRemoteRepositoriesDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> | |
| 147 <td>Private slot to send the input to the git process.</td> | |
| 148 </tr> | |
| 149 <tr> | |
| 150 <td><a href="#GitRemoteRepositoriesDialog.on_showInfoButton_clicked">on_showInfoButton_clicked</a></td> | |
| 151 <td>Private slot to show information about a remote repository.</td> | |
| 152 </tr> | |
| 153 <tr> | |
| 154 <td><a href="#GitRemoteRepositoriesDialog.start">start</a></td> | |
| 155 <td>Public slot to start the git remote command.</td> | |
| 156 </tr> | |
| 157 </table> | |
| 158 <h3>Static Methods</h3> | |
| 159 | |
| 160 <table> | |
| 161 <tr><td>None</td></tr> | |
| 162 </table> | |
| 163 | |
| 164 <a NAME="GitRemoteRepositoriesDialog.__init__" ID="GitRemoteRepositoriesDialog.__init__"></a> | |
| 165 <h4>GitRemoteRepositoriesDialog (Constructor)</h4> | |
| 166 <b>GitRemoteRepositoriesDialog</b>(<i>vcs, parent=None</i>) | |
| 167 | |
| 168 <p> | |
| 169 Constructor | |
| 170 </p> | |
| 171 <dl> | |
| 172 | |
| 173 <dt><i>vcs</i></dt> | |
| 174 <dd> | |
| 175 reference to the vcs object | |
| 176 </dd> | |
| 177 <dt><i>parent</i></dt> | |
| 178 <dd> | |
| 179 parent widget (QWidget) | |
| 180 </dd> | |
| 181 </dl> | |
| 182 <a NAME="GitRemoteRepositoriesDialog.__finish" ID="GitRemoteRepositoriesDialog.__finish"></a> | |
| 183 <h4>GitRemoteRepositoriesDialog.__finish</h4> | |
| 184 <b>__finish</b>(<i></i>) | |
| 185 | |
| 186 <p> | |
| 187 Private slot called when the process finished or the user pressed | |
| 188 the button. | |
| 189 </p> | |
| 190 <a NAME="GitRemoteRepositoriesDialog.__generateItem" ID="GitRemoteRepositoriesDialog.__generateItem"></a> | |
| 191 <h4>GitRemoteRepositoriesDialog.__generateItem</h4> | |
| 192 <b>__generateItem</b>(<i>name, url, oper</i>) | |
| 193 | |
| 194 <p> | |
| 195 Private method to generate a status item in the status list. | |
| 196 </p> | |
| 197 <dl> | |
| 198 | |
| 199 <dt><i>name</i></dt> | |
| 200 <dd> | |
| 201 name of the remote repository (string) | |
| 202 </dd> | |
| 203 <dt><i>url</i></dt> | |
| 204 <dd> | |
| 205 URL of the remote repository (string) | |
| 206 </dd> | |
| 207 <dt><i>oper</i></dt> | |
| 208 <dd> | |
| 209 operation the remote repository may be used for (string) | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <a NAME="GitRemoteRepositoriesDialog.__procFinished" ID="GitRemoteRepositoriesDialog.__procFinished"></a> | |
| 213 <h4>GitRemoteRepositoriesDialog.__procFinished</h4> | |
| 214 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) | |
| 215 | |
| 216 <p> | |
| 217 Private slot connected to the finished signal. | |
| 218 </p> | |
| 219 <dl> | |
| 220 | |
| 221 <dt><i>exitCode</i></dt> | |
| 222 <dd> | |
| 223 exit code of the process (integer) | |
| 224 </dd> | |
| 225 <dt><i>exitStatus</i></dt> | |
| 226 <dd> | |
| 227 exit status of the process (QProcess.ExitStatus) | |
| 228 </dd> | |
| 229 </dl> | |
| 230 <a NAME="GitRemoteRepositoriesDialog.__readStderr" ID="GitRemoteRepositoriesDialog.__readStderr"></a> | |
| 231 <h4>GitRemoteRepositoriesDialog.__readStderr</h4> | |
| 232 <b>__readStderr</b>(<i></i>) | |
| 233 | |
| 234 <p> | |
| 235 Private slot to handle the readyReadStandardError signal. | |
| 236 </p> | |
| 237 <p> | |
| 238 It reads the error output of the process and inserts it into the | |
| 239 error pane. | |
| 240 </p> | |
| 241 <a NAME="GitRemoteRepositoriesDialog.__readStdout" ID="GitRemoteRepositoriesDialog.__readStdout"></a> | |
| 242 <h4>GitRemoteRepositoriesDialog.__readStdout</h4> | |
| 243 <b>__readStdout</b>(<i></i>) | |
| 244 | |
| 245 <p> | |
| 246 Private slot to handle the readyReadStandardOutput signal. | |
| 247 </p> | |
| 248 <p> | |
| 249 It reads the output of the process, formats it and inserts it into | |
| 250 the contents pane. | |
| 251 </p> | |
| 252 <a NAME="GitRemoteRepositoriesDialog.__resizeColumns" ID="GitRemoteRepositoriesDialog.__resizeColumns"></a> | |
| 253 <h4>GitRemoteRepositoriesDialog.__resizeColumns</h4> | |
| 254 <b>__resizeColumns</b>(<i></i>) | |
| 255 | |
| 256 <p> | |
| 257 Private method to resize the list columns. | |
| 258 </p> | |
| 259 <a NAME="GitRemoteRepositoriesDialog.__resort" ID="GitRemoteRepositoriesDialog.__resort"></a> | |
| 260 <h4>GitRemoteRepositoriesDialog.__resort</h4> | |
| 261 <b>__resort</b>(<i></i>) | |
| 262 | |
| 263 <p> | |
| 264 Private method to resort the list. | |
| 265 </p> | |
| 266 <a NAME="GitRemoteRepositoriesDialog.__updateButtons" ID="GitRemoteRepositoriesDialog.__updateButtons"></a> | |
| 267 <h4>GitRemoteRepositoriesDialog.__updateButtons</h4> | |
| 268 <b>__updateButtons</b>(<i></i>) | |
| 269 | |
| 270 <p> | |
| 271 Private method to update the buttons status. | |
| 272 </p> | |
| 273 <a NAME="GitRemoteRepositoriesDialog.closeEvent" ID="GitRemoteRepositoriesDialog.closeEvent"></a> | |
| 274 <h4>GitRemoteRepositoriesDialog.closeEvent</h4> | |
| 275 <b>closeEvent</b>(<i>e</i>) | |
| 276 | |
| 277 <p> | |
| 278 Protected slot implementing a close event handler. | |
| 279 </p> | |
| 280 <dl> | |
| 281 | |
| 282 <dt><i>e</i></dt> | |
| 283 <dd> | |
| 284 close event (QCloseEvent) | |
| 285 </dd> | |
| 286 </dl> | |
| 287 <a NAME="GitRemoteRepositoriesDialog.keyPressEvent" ID="GitRemoteRepositoriesDialog.keyPressEvent"></a> | |
| 288 <h4>GitRemoteRepositoriesDialog.keyPressEvent</h4> | |
| 289 <b>keyPressEvent</b>(<i>evt</i>) | |
| 290 | |
| 291 <p> | |
| 292 Protected slot to handle a key press event. | |
| 293 </p> | |
| 294 <dl> | |
| 295 | |
| 296 <dt><i>evt</i></dt> | |
| 297 <dd> | |
| 298 the key press event (QKeyEvent) | |
| 299 </dd> | |
| 300 </dl> | |
| 301 <a NAME="GitRemoteRepositoriesDialog.on_addButton_clicked" ID="GitRemoteRepositoriesDialog.on_addButton_clicked"></a> | |
| 302 <h4>GitRemoteRepositoriesDialog.on_addButton_clicked</h4> | |
| 303 <b>on_addButton_clicked</b>(<i></i>) | |
| 304 | |
| 305 <p> | |
| 306 Private slot to add a remote repository. | |
| 307 </p> | |
| 308 <a NAME="GitRemoteRepositoriesDialog.on_buttonBox_clicked" ID="GitRemoteRepositoriesDialog.on_buttonBox_clicked"></a> | |
| 309 <h4>GitRemoteRepositoriesDialog.on_buttonBox_clicked</h4> | |
| 310 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 311 | |
| 312 <p> | |
| 313 Private slot called by a button of the button box clicked. | |
| 314 </p> | |
| 315 <dl> | |
| 316 | |
| 317 <dt><i>button</i></dt> | |
| 318 <dd> | |
| 319 button that was clicked (QAbstractButton) | |
| 320 </dd> | |
| 321 </dl> | |
| 322 <a NAME="GitRemoteRepositoriesDialog.on_changeUrlButton_clicked" ID="GitRemoteRepositoriesDialog.on_changeUrlButton_clicked"></a> | |
| 323 <h4>GitRemoteRepositoriesDialog.on_changeUrlButton_clicked</h4> | |
| 324 <b>on_changeUrlButton_clicked</b>(<i></i>) | |
| 325 | |
| 326 <p> | |
| 327 Private slot to change the URL of a remote repository. | |
| 328 </p> | |
| 329 <a NAME="GitRemoteRepositoriesDialog.on_credentialsButton_clicked" ID="GitRemoteRepositoriesDialog.on_credentialsButton_clicked"></a> | |
| 330 <h4>GitRemoteRepositoriesDialog.on_credentialsButton_clicked</h4> | |
| 331 <b>on_credentialsButton_clicked</b>(<i></i>) | |
| 332 | |
| 333 <p> | |
| 334 Private slot to change the credentials of a remote repository. | |
| 335 </p> | |
| 336 <a NAME="GitRemoteRepositoriesDialog.on_input_returnPressed" ID="GitRemoteRepositoriesDialog.on_input_returnPressed"></a> | |
| 337 <h4>GitRemoteRepositoriesDialog.on_input_returnPressed</h4> | |
| 338 <b>on_input_returnPressed</b>(<i></i>) | |
| 339 | |
| 340 <p> | |
| 341 Private slot to handle the press of the return key in the input field. | |
| 342 </p> | |
| 343 <a NAME="GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled" ID="GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled"></a> | |
| 344 <h4>GitRemoteRepositoriesDialog.on_passwordCheckBox_toggled</h4> | |
| 345 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) | |
| 346 | |
| 347 <p> | |
| 348 Private slot to handle the password checkbox toggled. | |
| 349 </p> | |
| 350 <dl> | |
| 351 | |
| 352 <dt><i>isOn</i></dt> | |
| 353 <dd> | |
| 354 flag indicating the status of the check box (boolean) | |
| 355 </dd> | |
| 356 </dl> | |
| 357 <a NAME="GitRemoteRepositoriesDialog.on_pruneButton_clicked" ID="GitRemoteRepositoriesDialog.on_pruneButton_clicked"></a> | |
| 358 <h4>GitRemoteRepositoriesDialog.on_pruneButton_clicked</h4> | |
| 359 <b>on_pruneButton_clicked</b>(<i></i>) | |
| 360 | |
| 361 <p> | |
| 362 Private slot to prune all stale remote-tracking branches. | |
| 363 </p> | |
| 364 <a NAME="GitRemoteRepositoriesDialog.on_refreshButton_clicked" ID="GitRemoteRepositoriesDialog.on_refreshButton_clicked"></a> | |
| 365 <h4>GitRemoteRepositoriesDialog.on_refreshButton_clicked</h4> | |
| 366 <b>on_refreshButton_clicked</b>(<i></i>) | |
| 367 | |
| 368 <p> | |
| 369 Private slot to refresh the status display. | |
| 370 </p> | |
| 371 <a NAME="GitRemoteRepositoriesDialog.on_removeButton_clicked" ID="GitRemoteRepositoriesDialog.on_removeButton_clicked"></a> | |
| 372 <h4>GitRemoteRepositoriesDialog.on_removeButton_clicked</h4> | |
| 373 <b>on_removeButton_clicked</b>(<i></i>) | |
| 374 | |
| 375 <p> | |
| 376 Private slot to remove a remote repository. | |
| 377 </p> | |
| 378 <a NAME="GitRemoteRepositoriesDialog.on_renameButton_clicked" ID="GitRemoteRepositoriesDialog.on_renameButton_clicked"></a> | |
| 379 <h4>GitRemoteRepositoriesDialog.on_renameButton_clicked</h4> | |
| 380 <b>on_renameButton_clicked</b>(<i></i>) | |
| 381 | |
| 382 <p> | |
| 383 Private slot to rename a remote repository. | |
| 384 </p> | |
| 385 <a NAME="GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged" ID="GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged"></a> | |
| 386 <h4>GitRemoteRepositoriesDialog.on_repolist_itemSelectionChanged</h4> | |
| 387 <b>on_repolist_itemSelectionChanged</b>(<i></i>) | |
| 388 | |
| 389 <p> | |
| 390 Private slot to act upon changes of selected items. | |
| 391 </p> | |
| 392 <a NAME="GitRemoteRepositoriesDialog.on_sendButton_clicked" ID="GitRemoteRepositoriesDialog.on_sendButton_clicked"></a> | |
| 393 <h4>GitRemoteRepositoriesDialog.on_sendButton_clicked</h4> | |
| 394 <b>on_sendButton_clicked</b>(<i></i>) | |
| 395 | |
| 396 <p> | |
| 397 Private slot to send the input to the git process. | |
| 398 </p> | |
| 399 <a NAME="GitRemoteRepositoriesDialog.on_showInfoButton_clicked" ID="GitRemoteRepositoriesDialog.on_showInfoButton_clicked"></a> | |
| 400 <h4>GitRemoteRepositoriesDialog.on_showInfoButton_clicked</h4> | |
| 401 <b>on_showInfoButton_clicked</b>(<i></i>) | |
| 402 | |
| 403 <p> | |
| 404 Private slot to show information about a remote repository. | |
| 405 </p> | |
| 406 <a NAME="GitRemoteRepositoriesDialog.start" ID="GitRemoteRepositoriesDialog.start"></a> | |
| 407 <h4>GitRemoteRepositoriesDialog.start</h4> | |
| 408 <b>start</b>(<i>projectDir</i>) | |
| 409 | |
| 410 <p> | |
| 411 Public slot to start the git remote command. | |
| 412 </p> | |
| 413 <dl> | |
| 414 | |
| 415 <dt><i>projectDir</i></dt> | |
| 416 <dd> | |
| 417 name of the project directory (string) | |
| 418 </dd> | |
| 419 </dl> | |
| 420 <div align="right"><a href="#top">Up</a></div> | |
| 421 <hr /> | |
| 422 </body></html> |
