Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog.html
Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog.html
- changeset 178
- dd9f0bca5e2f
- child 409
- 0ea528e80202
equal
deleted
inserted
replaced
| 177:c822ccc4d138 | 178:dd9f0bca5e2f |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog</h1> | |
| 24 <p> | |
| 25 Module implementing a dialog to show the output of the hg annotate command. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#HgAnnotateDialog">HgAnnotateDialog</a></td> | |
| 35 <td>Class implementing a dialog to show the output of the hg annotate command.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="HgAnnotateDialog" ID="HgAnnotateDialog"></a> | |
| 44 <h2>HgAnnotateDialog</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog to show the output of the hg annotate command. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QDialog, Ui_HgAnnotateDialog | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#HgAnnotateDialog.__init__">HgAnnotateDialog</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#HgAnnotateDialog.__finish">__finish</a></td> | |
| 61 <td>Private slot called when the process finished or the user pressed the button.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#HgAnnotateDialog.__generateItem">__generateItem</a></td> | |
| 64 <td>Private method to generate a tag item in the taglist.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#HgAnnotateDialog.__procFinished">__procFinished</a></td> | |
| 67 <td>Private slot connected to the finished signal.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#HgAnnotateDialog.__readStderr">__readStderr</a></td> | |
| 70 <td>Private slot to handle the readyReadStderr signal.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#HgAnnotateDialog.__readStdout">__readStdout</a></td> | |
| 73 <td>Private slot to handle the readyReadStdout signal.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#HgAnnotateDialog.__resizeColumns">__resizeColumns</a></td> | |
| 76 <td>Private method to resize the list columns.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#HgAnnotateDialog.closeEvent">closeEvent</a></td> | |
| 79 <td>Private slot implementing a close event handler.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#HgAnnotateDialog.keyPressEvent">keyPressEvent</a></td> | |
| 82 <td>Protected slot to handle a key press event.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#HgAnnotateDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 85 <td>Private slot called by a button of the button box clicked.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#HgAnnotateDialog.on_input_returnPressed">on_input_returnPressed</a></td> | |
| 88 <td>Private slot to handle the press of the return key in the input field.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#HgAnnotateDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> | |
| 91 <td>Private slot to handle the password checkbox toggled.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#HgAnnotateDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> | |
| 94 <td>Private slot to send the input to the subversion process.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#HgAnnotateDialog.start">start</a></td> | |
| 97 <td>Public slot to start the annotate command.</td> | |
| 98 </tr> | |
| 99 </table> | |
| 100 <a NAME="HgAnnotateDialog.__init__" ID="HgAnnotateDialog.__init__"></a> | |
| 101 <h4>HgAnnotateDialog (Constructor)</h4> | |
| 102 <b>HgAnnotateDialog</b>(<i>vcs, parent = None</i>) | |
| 103 <p> | |
| 104 Constructor | |
| 105 </p><dl> | |
| 106 <dt><i>vcs</i></dt> | |
| 107 <dd> | |
| 108 reference to the vcs object | |
| 109 </dd><dt><i>parent</i></dt> | |
| 110 <dd> | |
| 111 parent widget (QWidget) | |
| 112 </dd> | |
| 113 </dl><a NAME="HgAnnotateDialog.__finish" ID="HgAnnotateDialog.__finish"></a> | |
| 114 <h4>HgAnnotateDialog.__finish</h4> | |
| 115 <b>__finish</b>(<i></i>) | |
| 116 <p> | |
| 117 Private slot called when the process finished or the user pressed the button. | |
| 118 </p><a NAME="HgAnnotateDialog.__generateItem" ID="HgAnnotateDialog.__generateItem"></a> | |
| 119 <h4>HgAnnotateDialog.__generateItem</h4> | |
| 120 <b>__generateItem</b>(<i>revision, changeset, author, date, text</i>) | |
| 121 <p> | |
| 122 Private method to generate a tag item in the taglist. | |
| 123 </p><dl> | |
| 124 <dt><i>revision</i></dt> | |
| 125 <dd> | |
| 126 revision string (string) | |
| 127 </dd><dt><i>changeset</i></dt> | |
| 128 <dd> | |
| 129 changeset string (string) | |
| 130 </dd><dt><i>author</i></dt> | |
| 131 <dd> | |
| 132 author of the change (string) | |
| 133 </dd><dt><i>date</i></dt> | |
| 134 <dd> | |
| 135 date of the tag (string) | |
| 136 </dd><dt><i>name</i></dt> | |
| 137 <dd> | |
| 138 name (path) of the tag (string) | |
| 139 </dd> | |
| 140 </dl><a NAME="HgAnnotateDialog.__procFinished" ID="HgAnnotateDialog.__procFinished"></a> | |
| 141 <h4>HgAnnotateDialog.__procFinished</h4> | |
| 142 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) | |
| 143 <p> | |
| 144 Private slot connected to the finished signal. | |
| 145 </p><dl> | |
| 146 <dt><i>exitCode</i></dt> | |
| 147 <dd> | |
| 148 exit code of the process (integer) | |
| 149 </dd><dt><i>exitStatus</i></dt> | |
| 150 <dd> | |
| 151 exit status of the process (QProcess.ExitStatus) | |
| 152 </dd> | |
| 153 </dl><a NAME="HgAnnotateDialog.__readStderr" ID="HgAnnotateDialog.__readStderr"></a> | |
| 154 <h4>HgAnnotateDialog.__readStderr</h4> | |
| 155 <b>__readStderr</b>(<i></i>) | |
| 156 <p> | |
| 157 Private slot to handle the readyReadStderr signal. | |
| 158 </p><p> | |
| 159 It reads the error output of the process and inserts it into the | |
| 160 error pane. | |
| 161 </p><a NAME="HgAnnotateDialog.__readStdout" ID="HgAnnotateDialog.__readStdout"></a> | |
| 162 <h4>HgAnnotateDialog.__readStdout</h4> | |
| 163 <b>__readStdout</b>(<i></i>) | |
| 164 <p> | |
| 165 Private slot to handle the readyReadStdout signal. | |
| 166 </p><p> | |
| 167 It reads the output of the process, formats it and inserts it into | |
| 168 the annotation list. | |
| 169 </p><a NAME="HgAnnotateDialog.__resizeColumns" ID="HgAnnotateDialog.__resizeColumns"></a> | |
| 170 <h4>HgAnnotateDialog.__resizeColumns</h4> | |
| 171 <b>__resizeColumns</b>(<i></i>) | |
| 172 <p> | |
| 173 Private method to resize the list columns. | |
| 174 </p><a NAME="HgAnnotateDialog.closeEvent" ID="HgAnnotateDialog.closeEvent"></a> | |
| 175 <h4>HgAnnotateDialog.closeEvent</h4> | |
| 176 <b>closeEvent</b>(<i>e</i>) | |
| 177 <p> | |
| 178 Private slot implementing a close event handler. | |
| 179 </p><dl> | |
| 180 <dt><i>e</i></dt> | |
| 181 <dd> | |
| 182 close event (QCloseEvent) | |
| 183 </dd> | |
| 184 </dl><a NAME="HgAnnotateDialog.keyPressEvent" ID="HgAnnotateDialog.keyPressEvent"></a> | |
| 185 <h4>HgAnnotateDialog.keyPressEvent</h4> | |
| 186 <b>keyPressEvent</b>(<i>evt</i>) | |
| 187 <p> | |
| 188 Protected slot to handle a key press event. | |
| 189 </p><dl> | |
| 190 <dt><i>evt</i></dt> | |
| 191 <dd> | |
| 192 the key press event (QKeyEvent) | |
| 193 </dd> | |
| 194 </dl><a NAME="HgAnnotateDialog.on_buttonBox_clicked" ID="HgAnnotateDialog.on_buttonBox_clicked"></a> | |
| 195 <h4>HgAnnotateDialog.on_buttonBox_clicked</h4> | |
| 196 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 197 <p> | |
| 198 Private slot called by a button of the button box clicked. | |
| 199 </p><dl> | |
| 200 <dt><i>button</i></dt> | |
| 201 <dd> | |
| 202 button that was clicked (QAbstractButton) | |
| 203 </dd> | |
| 204 </dl><a NAME="HgAnnotateDialog.on_input_returnPressed" ID="HgAnnotateDialog.on_input_returnPressed"></a> | |
| 205 <h4>HgAnnotateDialog.on_input_returnPressed</h4> | |
| 206 <b>on_input_returnPressed</b>(<i></i>) | |
| 207 <p> | |
| 208 Private slot to handle the press of the return key in the input field. | |
| 209 </p><a NAME="HgAnnotateDialog.on_passwordCheckBox_toggled" ID="HgAnnotateDialog.on_passwordCheckBox_toggled"></a> | |
| 210 <h4>HgAnnotateDialog.on_passwordCheckBox_toggled</h4> | |
| 211 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) | |
| 212 <p> | |
| 213 Private slot to handle the password checkbox toggled. | |
| 214 </p><dl> | |
| 215 <dt><i>isOn</i></dt> | |
| 216 <dd> | |
| 217 flag indicating the status of the check box (boolean) | |
| 218 </dd> | |
| 219 </dl><a NAME="HgAnnotateDialog.on_sendButton_clicked" ID="HgAnnotateDialog.on_sendButton_clicked"></a> | |
| 220 <h4>HgAnnotateDialog.on_sendButton_clicked</h4> | |
| 221 <b>on_sendButton_clicked</b>(<i></i>) | |
| 222 <p> | |
| 223 Private slot to send the input to the subversion process. | |
| 224 </p><a NAME="HgAnnotateDialog.start" ID="HgAnnotateDialog.start"></a> | |
| 225 <h4>HgAnnotateDialog.start</h4> | |
| 226 <b>start</b>(<i>fn</i>) | |
| 227 <p> | |
| 228 Public slot to start the annotate command. | |
| 229 </p><dl> | |
| 230 <dt><i>fn</i></dt> | |
| 231 <dd> | |
| 232 filename to show the log for (string) | |
| 233 </dd> | |
| 234 </dl> | |
| 235 <div align="right"><a href="#top">Up</a></div> | |
| 236 <hr /> | |
| 237 </body></html> |
