Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgLogDialog.html
Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgLogDialog.html
- changeset 178
- dd9f0bca5e2f
- child 181
- 4af57f97c1bc
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.HgLogDialog</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.HgLogDialog</h1> | |
| 24 <p> | |
| 25 Module implementing a dialog to show the output of the hg log command process. | |
| 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="#HgLogDialog">HgLogDialog</a></td> | |
| 35 <td>Class implementing a dialog to show the output of the hg log command process.</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="HgLogDialog" ID="HgLogDialog"></a> | |
| 44 <h2>HgLogDialog</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog to show the output of the hg log command process. | |
| 47 </p><p> | |
| 48 The dialog is nonmodal. Clicking a link in the upper text pane shows | |
| 49 a diff of the revisions. | |
| 50 </p> | |
| 51 <h3>Derived from</h3> | |
| 52 QWidget, Ui_HgLogDialog | |
| 53 <h3>Class Attributes</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#HgLogDialog.__init__">HgLogDialog</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#HgLogDialog.__procFinished">__procFinished</a></td> | |
| 64 <td>Private slot connected to the finished signal.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#HgLogDialog.__readStderr">__readStderr</a></td> | |
| 67 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#HgLogDialog.__readStdout">__readStdout</a></td> | |
| 70 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#HgLogDialog.__sourceChanged">__sourceChanged</a></td> | |
| 73 <td>Private slot to handle the sourceChanged signal of the contents pane.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#HgLogDialog.closeEvent">closeEvent</a></td> | |
| 76 <td>Private slot implementing a close event handler.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#HgLogDialog.keyPressEvent">keyPressEvent</a></td> | |
| 79 <td>Protected slot to handle a key press event.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#HgLogDialog.on_input_returnPressed">on_input_returnPressed</a></td> | |
| 82 <td>Private slot to handle the press of the return key in the input field.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#HgLogDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> | |
| 85 <td>Private slot to handle the password checkbox toggled.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#HgLogDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> | |
| 88 <td>Private slot to send the input to the hg process.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#HgLogDialog.start">start</a></td> | |
| 91 <td>Public slot to start the hg log command.</td> | |
| 92 </tr> | |
| 93 </table> | |
| 94 <a NAME="HgLogDialog.__init__" ID="HgLogDialog.__init__"></a> | |
| 95 <h4>HgLogDialog (Constructor)</h4> | |
| 96 <b>HgLogDialog</b>(<i>vcs, mode = "log", parent = None</i>) | |
| 97 <p> | |
| 98 Constructor | |
| 99 </p><dl> | |
| 100 <dt><i>vcs</i></dt> | |
| 101 <dd> | |
| 102 reference to the vcs object | |
| 103 </dd><dt><i>mode</i></dt> | |
| 104 <dd> | |
| 105 mode of the dialog (string, one of log, incoming, outgoing) | |
| 106 </dd><dt><i>parent</i></dt> | |
| 107 <dd> | |
| 108 parent widget (QWidget) | |
| 109 </dd> | |
| 110 </dl><a NAME="HgLogDialog.__procFinished" ID="HgLogDialog.__procFinished"></a> | |
| 111 <h4>HgLogDialog.__procFinished</h4> | |
| 112 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) | |
| 113 <p> | |
| 114 Private slot connected to the finished signal. | |
| 115 </p><dl> | |
| 116 <dt><i>exitCode</i></dt> | |
| 117 <dd> | |
| 118 exit code of the process (integer) | |
| 119 </dd><dt><i>exitStatus</i></dt> | |
| 120 <dd> | |
| 121 exit status of the process (QProcess.ExitStatus) | |
| 122 </dd> | |
| 123 </dl><a NAME="HgLogDialog.__readStderr" ID="HgLogDialog.__readStderr"></a> | |
| 124 <h4>HgLogDialog.__readStderr</h4> | |
| 125 <b>__readStderr</b>(<i></i>) | |
| 126 <p> | |
| 127 Private slot to handle the readyReadStandardError signal. | |
| 128 </p><p> | |
| 129 It reads the error output of the process and inserts it into the | |
| 130 error pane. | |
| 131 </p><a NAME="HgLogDialog.__readStdout" ID="HgLogDialog.__readStdout"></a> | |
| 132 <h4>HgLogDialog.__readStdout</h4> | |
| 133 <b>__readStdout</b>(<i></i>) | |
| 134 <p> | |
| 135 Private slot to handle the readyReadStandardOutput signal. | |
| 136 </p><p> | |
| 137 It reads the output of the process and inserts it into a buffer. | |
| 138 </p><a NAME="HgLogDialog.__sourceChanged" ID="HgLogDialog.__sourceChanged"></a> | |
| 139 <h4>HgLogDialog.__sourceChanged</h4> | |
| 140 <b>__sourceChanged</b>(<i>url</i>) | |
| 141 <p> | |
| 142 Private slot to handle the sourceChanged signal of the contents pane. | |
| 143 </p><dl> | |
| 144 <dt><i>url</i></dt> | |
| 145 <dd> | |
| 146 the url that was clicked (QUrl) | |
| 147 </dd> | |
| 148 </dl><a NAME="HgLogDialog.closeEvent" ID="HgLogDialog.closeEvent"></a> | |
| 149 <h4>HgLogDialog.closeEvent</h4> | |
| 150 <b>closeEvent</b>(<i>e</i>) | |
| 151 <p> | |
| 152 Private slot implementing a close event handler. | |
| 153 </p><dl> | |
| 154 <dt><i>e</i></dt> | |
| 155 <dd> | |
| 156 close event (QCloseEvent) | |
| 157 </dd> | |
| 158 </dl><a NAME="HgLogDialog.keyPressEvent" ID="HgLogDialog.keyPressEvent"></a> | |
| 159 <h4>HgLogDialog.keyPressEvent</h4> | |
| 160 <b>keyPressEvent</b>(<i>evt</i>) | |
| 161 <p> | |
| 162 Protected slot to handle a key press event. | |
| 163 </p><dl> | |
| 164 <dt><i>evt</i></dt> | |
| 165 <dd> | |
| 166 the key press event (QKeyEvent) | |
| 167 </dd> | |
| 168 </dl><a NAME="HgLogDialog.on_input_returnPressed" ID="HgLogDialog.on_input_returnPressed"></a> | |
| 169 <h4>HgLogDialog.on_input_returnPressed</h4> | |
| 170 <b>on_input_returnPressed</b>(<i></i>) | |
| 171 <p> | |
| 172 Private slot to handle the press of the return key in the input field. | |
| 173 </p><a NAME="HgLogDialog.on_passwordCheckBox_toggled" ID="HgLogDialog.on_passwordCheckBox_toggled"></a> | |
| 174 <h4>HgLogDialog.on_passwordCheckBox_toggled</h4> | |
| 175 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) | |
| 176 <p> | |
| 177 Private slot to handle the password checkbox toggled. | |
| 178 </p><dl> | |
| 179 <dt><i>isOn</i></dt> | |
| 180 <dd> | |
| 181 flag indicating the status of the check box (boolean) | |
| 182 </dd> | |
| 183 </dl><a NAME="HgLogDialog.on_sendButton_clicked" ID="HgLogDialog.on_sendButton_clicked"></a> | |
| 184 <h4>HgLogDialog.on_sendButton_clicked</h4> | |
| 185 <b>on_sendButton_clicked</b>(<i></i>) | |
| 186 <p> | |
| 187 Private slot to send the input to the hg process. | |
| 188 </p><a NAME="HgLogDialog.start" ID="HgLogDialog.start"></a> | |
| 189 <h4>HgLogDialog.start</h4> | |
| 190 <b>start</b>(<i>fn, noEntries = 0</i>) | |
| 191 <p> | |
| 192 Public slot to start the hg log command. | |
| 193 </p><dl> | |
| 194 <dt><i>fn</i></dt> | |
| 195 <dd> | |
| 196 filename to show the log for (string) | |
| 197 </dd><dt><i>noEntries</i></dt> | |
| 198 <dd> | |
| 199 number of entries to show (integer) | |
| 200 </dd> | |
| 201 </dl> | |
| 202 <div align="right"><a href="#top">Up</a></div> | |
| 203 <hr /> | |
| 204 </body></html> |
