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