Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgSummaryDialog.html
Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgSummaryDialog.html
- changeset 2812
- 35c3302da595
- child 3018
- 70924c0bdaf1
equal
deleted
inserted
replaced
| 2811:7b2ec3af3505 | 2812:35c3302da595 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric5.Plugins.VcsPlugins.vcsMercurial.HgSummaryDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.HgSummaryDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to show some summary information of the working | |
| 25 directory state. | |
| 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="#HgSummaryDialog">HgSummaryDialog</a></td> | |
| 35 <td>Class implementing a dialog to show some summary information of the working directory state.</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="HgSummaryDialog" ID="HgSummaryDialog"></a> | |
| 44 <h2>HgSummaryDialog</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog to show some summary information of the working | |
| 47 directory state. | |
| 48 </p> | |
| 49 <h3>Derived from</h3> | |
| 50 QDialog, Ui_HgSummaryDialog | |
| 51 <h3>Class Attributes</h3> | |
| 52 <table> | |
| 53 <tr><td>None</td></tr> | |
| 54 </table> | |
| 55 <h3>Class Methods</h3> | |
| 56 <table> | |
| 57 <tr><td>None</td></tr> | |
| 58 </table> | |
| 59 <h3>Methods</h3> | |
| 60 <table> | |
| 61 <tr> | |
| 62 <td><a href="#HgSummaryDialog.__init__">HgSummaryDialog</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr><tr> | |
| 65 <td><a href="#HgSummaryDialog.__committed">__committed</a></td> | |
| 66 <td>Private slot called after the commit has finished.</td> | |
| 67 </tr><tr> | |
| 68 <td><a href="#HgSummaryDialog.__finish">__finish</a></td> | |
| 69 <td>Private slot called when the process finished or the user pressed the button.</td> | |
| 70 </tr><tr> | |
| 71 <td><a href="#HgSummaryDialog.__procFinished">__procFinished</a></td> | |
| 72 <td>Private slot connected to the finished signal.</td> | |
| 73 </tr><tr> | |
| 74 <td><a href="#HgSummaryDialog.__processOutput">__processOutput</a></td> | |
| 75 <td>Private method to process the output into nice readable text.</td> | |
| 76 </tr><tr> | |
| 77 <td><a href="#HgSummaryDialog.__readStderr">__readStderr</a></td> | |
| 78 <td>Private slot to handle the readyReadStandardError signal.</td> | |
| 79 </tr><tr> | |
| 80 <td><a href="#HgSummaryDialog.__readStdout">__readStdout</a></td> | |
| 81 <td>Private slot to handle the readyReadStandardOutput signal.</td> | |
| 82 </tr><tr> | |
| 83 <td><a href="#HgSummaryDialog.__showError">__showError</a></td> | |
| 84 <td>Private slot to show some error.</td> | |
| 85 </tr><tr> | |
| 86 <td><a href="#HgSummaryDialog.closeEvent">closeEvent</a></td> | |
| 87 <td>Private slot implementing a close event handler.</td> | |
| 88 </tr><tr> | |
| 89 <td><a href="#HgSummaryDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 90 <td>Private slot called by a button of the button box clicked.</td> | |
| 91 </tr><tr> | |
| 92 <td><a href="#HgSummaryDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> | |
| 93 <td>Private slot to refresh the status display.</td> | |
| 94 </tr><tr> | |
| 95 <td><a href="#HgSummaryDialog.start">start</a></td> | |
| 96 <td>Public slot to start the hg summary command.</td> | |
| 97 </tr> | |
| 98 </table> | |
| 99 <h3>Static Methods</h3> | |
| 100 <table> | |
| 101 <tr><td>None</td></tr> | |
| 102 </table> | |
| 103 <a NAME="HgSummaryDialog.__init__" ID="HgSummaryDialog.__init__"></a> | |
| 104 <h4>HgSummaryDialog (Constructor)</h4> | |
| 105 <b>HgSummaryDialog</b>(<i>vcs, parent=None</i>) | |
| 106 <p> | |
| 107 Constructor | |
| 108 </p><dl> | |
| 109 <dt><i>vcs</i></dt> | |
| 110 <dd> | |
| 111 reference to the vcs object | |
| 112 </dd><dt><i>parent</i></dt> | |
| 113 <dd> | |
| 114 parent widget (QWidget) | |
| 115 </dd> | |
| 116 </dl><a NAME="HgSummaryDialog.__committed" ID="HgSummaryDialog.__committed"></a> | |
| 117 <h4>HgSummaryDialog.__committed</h4> | |
| 118 <b>__committed</b>(<i></i>) | |
| 119 <p> | |
| 120 Private slot called after the commit has finished. | |
| 121 </p><a NAME="HgSummaryDialog.__finish" ID="HgSummaryDialog.__finish"></a> | |
| 122 <h4>HgSummaryDialog.__finish</h4> | |
| 123 <b>__finish</b>(<i></i>) | |
| 124 <p> | |
| 125 Private slot called when the process finished or the user pressed the button. | |
| 126 </p><a NAME="HgSummaryDialog.__procFinished" ID="HgSummaryDialog.__procFinished"></a> | |
| 127 <h4>HgSummaryDialog.__procFinished</h4> | |
| 128 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) | |
| 129 <p> | |
| 130 Private slot connected to the finished signal. | |
| 131 </p><dl> | |
| 132 <dt><i>exitCode</i></dt> | |
| 133 <dd> | |
| 134 exit code of the process (integer) | |
| 135 </dd><dt><i>exitStatus</i></dt> | |
| 136 <dd> | |
| 137 exit status of the process (QProcess.ExitStatus) | |
| 138 </dd> | |
| 139 </dl><a NAME="HgSummaryDialog.__processOutput" ID="HgSummaryDialog.__processOutput"></a> | |
| 140 <h4>HgSummaryDialog.__processOutput</h4> | |
| 141 <b>__processOutput</b>(<i>output</i>) | |
| 142 <p> | |
| 143 Private method to process the output into nice readable text. | |
| 144 </p><dl> | |
| 145 <dt><i>output</i></dt> | |
| 146 <dd> | |
| 147 output from the summary command (string) | |
| 148 </dd> | |
| 149 </dl><a NAME="HgSummaryDialog.__readStderr" ID="HgSummaryDialog.__readStderr"></a> | |
| 150 <h4>HgSummaryDialog.__readStderr</h4> | |
| 151 <b>__readStderr</b>(<i></i>) | |
| 152 <p> | |
| 153 Private slot to handle the readyReadStandardError signal. | |
| 154 </p><p> | |
| 155 It reads the error output of the process and inserts it into the | |
| 156 error pane. | |
| 157 </p><a NAME="HgSummaryDialog.__readStdout" ID="HgSummaryDialog.__readStdout"></a> | |
| 158 <h4>HgSummaryDialog.__readStdout</h4> | |
| 159 <b>__readStdout</b>(<i></i>) | |
| 160 <p> | |
| 161 Private slot to handle the readyReadStandardOutput signal. | |
| 162 </p><p> | |
| 163 It reads the output of the process, formats it and inserts it into | |
| 164 the contents pane. | |
| 165 </p><a NAME="HgSummaryDialog.__showError" ID="HgSummaryDialog.__showError"></a> | |
| 166 <h4>HgSummaryDialog.__showError</h4> | |
| 167 <b>__showError</b>(<i>out</i>) | |
| 168 <p> | |
| 169 Private slot to show some error. | |
| 170 </p><dl> | |
| 171 <dt><i>out</i></dt> | |
| 172 <dd> | |
| 173 error to be shown (string) | |
| 174 </dd> | |
| 175 </dl><a NAME="HgSummaryDialog.closeEvent" ID="HgSummaryDialog.closeEvent"></a> | |
| 176 <h4>HgSummaryDialog.closeEvent</h4> | |
| 177 <b>closeEvent</b>(<i>e</i>) | |
| 178 <p> | |
| 179 Private slot implementing a close event handler. | |
| 180 </p><dl> | |
| 181 <dt><i>e</i></dt> | |
| 182 <dd> | |
| 183 close event (QCloseEvent) | |
| 184 </dd> | |
| 185 </dl><a NAME="HgSummaryDialog.on_buttonBox_clicked" ID="HgSummaryDialog.on_buttonBox_clicked"></a> | |
| 186 <h4>HgSummaryDialog.on_buttonBox_clicked</h4> | |
| 187 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 188 <p> | |
| 189 Private slot called by a button of the button box clicked. | |
| 190 </p><dl> | |
| 191 <dt><i>button</i></dt> | |
| 192 <dd> | |
| 193 button that was clicked (QAbstractButton) | |
| 194 </dd> | |
| 195 </dl><a NAME="HgSummaryDialog.on_refreshButton_clicked" ID="HgSummaryDialog.on_refreshButton_clicked"></a> | |
| 196 <h4>HgSummaryDialog.on_refreshButton_clicked</h4> | |
| 197 <b>on_refreshButton_clicked</b>(<i></i>) | |
| 198 <p> | |
| 199 Private slot to refresh the status display. | |
| 200 </p><a NAME="HgSummaryDialog.start" ID="HgSummaryDialog.start"></a> | |
| 201 <h4>HgSummaryDialog.start</h4> | |
| 202 <b>start</b>(<i>path, mq=False</i>) | |
| 203 <p> | |
| 204 Public slot to start the hg summary command. | |
| 205 </p><dl> | |
| 206 <dt><i>path</i></dt> | |
| 207 <dd> | |
| 208 path name of the working directory (string) | |
| 209 </dd><dt><i>mq</i></dt> | |
| 210 <dd> | |
| 211 flag indicating to show the queue status as well (boolean) | |
| 212 </dd> | |
| 213 </dl> | |
| 214 <div align="right"><a href="#top">Up</a></div> | |
| 215 <hr /> | |
| 216 </body></html> |
