Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgSummaryDialog.html

eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgSummaryDialog.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7721
331ecfa0e716
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgSummaryDialog</h1> 23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgSummaryDialog</h1>
24
23 <p> 25 <p>
24 Module implementing a dialog to show some summary information of the working 26 Module implementing a dialog to show some summary information of the working
25 directory state. 27 directory state.
26 </p> 28 </p>
27 <h3>Global Attributes</h3> 29 <h3>Global Attributes</h3>
30
28 <table> 31 <table>
29 <tr><td>None</td></tr> 32 <tr><td>None</td></tr>
30 </table> 33 </table>
31 <h3>Classes</h3> 34 <h3>Classes</h3>
32 <table> 35
36 <table>
37
33 <tr> 38 <tr>
34 <td><a href="#HgSummaryDialog">HgSummaryDialog</a></td> 39 <td><a href="#HgSummaryDialog">HgSummaryDialog</a></td>
35 <td>Class implementing a dialog to show some summary information of the working directory state.</td> 40 <td>Class implementing a dialog to show some summary information of the working directory state.</td>
36 </tr> 41 </tr>
37 </table> 42 </table>
38 <h3>Functions</h3> 43 <h3>Functions</h3>
39 <table> 44
40 <tr><td>None</td></tr> 45 <table>
41 </table> 46 <tr><td>None</td></tr>
42 <hr /><hr /> 47 </table>
48 <hr />
49 <hr />
43 <a NAME="HgSummaryDialog" ID="HgSummaryDialog"></a> 50 <a NAME="HgSummaryDialog" ID="HgSummaryDialog"></a>
44 <h2>HgSummaryDialog</h2> 51 <h2>HgSummaryDialog</h2>
52
45 <p> 53 <p>
46 Class implementing a dialog to show some summary information of the working 54 Class implementing a dialog to show some summary information of the working
47 directory state. 55 directory state.
48 </p> 56 </p>
49 <h3>Derived from</h3> 57 <h3>Derived from</h3>
50 QDialog, Ui_HgSummaryDialog 58 QDialog, Ui_HgSummaryDialog
51 <h3>Class Attributes</h3> 59 <h3>Class Attributes</h3>
60
52 <table> 61 <table>
53 <tr><td>None</td></tr> 62 <tr><td>None</td></tr>
54 </table> 63 </table>
55 <h3>Class Methods</h3> 64 <h3>Class Methods</h3>
65
56 <table> 66 <table>
57 <tr><td>None</td></tr> 67 <tr><td>None</td></tr>
58 </table> 68 </table>
59 <h3>Methods</h3> 69 <h3>Methods</h3>
60 <table> 70
71 <table>
72
61 <tr> 73 <tr>
62 <td><a href="#HgSummaryDialog.__init__">HgSummaryDialog</a></td> 74 <td><a href="#HgSummaryDialog.__init__">HgSummaryDialog</a></td>
63 <td>Constructor</td> 75 <td>Constructor</td>
64 </tr><tr> 76 </tr>
77 <tr>
65 <td><a href="#HgSummaryDialog.__committed">__committed</a></td> 78 <td><a href="#HgSummaryDialog.__committed">__committed</a></td>
66 <td>Private slot called after the commit has finished.</td> 79 <td>Private slot called after the commit has finished.</td>
67 </tr><tr> 80 </tr>
81 <tr>
68 <td><a href="#HgSummaryDialog.__finish">__finish</a></td> 82 <td><a href="#HgSummaryDialog.__finish">__finish</a></td>
69 <td>Private slot called when the process finished or the user pressed the button.</td> 83 <td>Private slot called when the process finished or the user pressed the button.</td>
70 </tr><tr> 84 </tr>
85 <tr>
71 <td><a href="#HgSummaryDialog.__procFinished">__procFinished</a></td> 86 <td><a href="#HgSummaryDialog.__procFinished">__procFinished</a></td>
72 <td>Private slot connected to the finished signal.</td> 87 <td>Private slot connected to the finished signal.</td>
73 </tr><tr> 88 </tr>
89 <tr>
74 <td><a href="#HgSummaryDialog.__processOutput">__processOutput</a></td> 90 <td><a href="#HgSummaryDialog.__processOutput">__processOutput</a></td>
75 <td>Private method to process the output into nice readable text.</td> 91 <td>Private method to process the output into nice readable text.</td>
76 </tr><tr> 92 </tr>
93 <tr>
77 <td><a href="#HgSummaryDialog.__readStderr">__readStderr</a></td> 94 <td><a href="#HgSummaryDialog.__readStderr">__readStderr</a></td>
78 <td>Private slot to handle the readyReadStandardError signal.</td> 95 <td>Private slot to handle the readyReadStandardError signal.</td>
79 </tr><tr> 96 </tr>
97 <tr>
80 <td><a href="#HgSummaryDialog.__readStdout">__readStdout</a></td> 98 <td><a href="#HgSummaryDialog.__readStdout">__readStdout</a></td>
81 <td>Private slot to handle the readyReadStandardOutput signal.</td> 99 <td>Private slot to handle the readyReadStandardOutput signal.</td>
82 </tr><tr> 100 </tr>
101 <tr>
83 <td><a href="#HgSummaryDialog.__showError">__showError</a></td> 102 <td><a href="#HgSummaryDialog.__showError">__showError</a></td>
84 <td>Private slot to show some error.</td> 103 <td>Private slot to show some error.</td>
85 </tr><tr> 104 </tr>
105 <tr>
86 <td><a href="#HgSummaryDialog.closeEvent">closeEvent</a></td> 106 <td><a href="#HgSummaryDialog.closeEvent">closeEvent</a></td>
87 <td>Protected slot implementing a close event handler.</td> 107 <td>Protected slot implementing a close event handler.</td>
88 </tr><tr> 108 </tr>
109 <tr>
89 <td><a href="#HgSummaryDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 110 <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> 111 <td>Private slot called by a button of the button box clicked.</td>
91 </tr><tr> 112 </tr>
113 <tr>
92 <td><a href="#HgSummaryDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> 114 <td><a href="#HgSummaryDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
93 <td>Private slot to refresh the status display.</td> 115 <td>Private slot to refresh the status display.</td>
94 </tr><tr> 116 </tr>
117 <tr>
95 <td><a href="#HgSummaryDialog.start">start</a></td> 118 <td><a href="#HgSummaryDialog.start">start</a></td>
96 <td>Public slot to start the hg summary command.</td> 119 <td>Public slot to start the hg summary command.</td>
97 </tr> 120 </tr>
98 </table> 121 </table>
99 <h3>Static Methods</h3> 122 <h3>Static Methods</h3>
100 <table> 123
101 <tr><td>None</td></tr> 124 <table>
102 </table> 125 <tr><td>None</td></tr>
126 </table>
127
103 <a NAME="HgSummaryDialog.__init__" ID="HgSummaryDialog.__init__"></a> 128 <a NAME="HgSummaryDialog.__init__" ID="HgSummaryDialog.__init__"></a>
104 <h4>HgSummaryDialog (Constructor)</h4> 129 <h4>HgSummaryDialog (Constructor)</h4>
105 <b>HgSummaryDialog</b>(<i>vcs, parent=None</i>) 130 <b>HgSummaryDialog</b>(<i>vcs, parent=None</i>)
131
106 <p> 132 <p>
107 Constructor 133 Constructor
108 </p><dl> 134 </p>
135 <dl>
136
109 <dt><i>vcs</i></dt> 137 <dt><i>vcs</i></dt>
110 <dd> 138 <dd>
111 reference to the vcs object 139 reference to the vcs object
112 </dd><dt><i>parent</i></dt> 140 </dd>
141 <dt><i>parent</i></dt>
113 <dd> 142 <dd>
114 parent widget (QWidget) 143 parent widget (QWidget)
115 </dd> 144 </dd>
116 </dl><a NAME="HgSummaryDialog.__committed" ID="HgSummaryDialog.__committed"></a> 145 </dl>
146 <a NAME="HgSummaryDialog.__committed" ID="HgSummaryDialog.__committed"></a>
117 <h4>HgSummaryDialog.__committed</h4> 147 <h4>HgSummaryDialog.__committed</h4>
118 <b>__committed</b>(<i></i>) 148 <b>__committed</b>(<i></i>)
149
119 <p> 150 <p>
120 Private slot called after the commit has finished. 151 Private slot called after the commit has finished.
121 </p><a NAME="HgSummaryDialog.__finish" ID="HgSummaryDialog.__finish"></a> 152 </p>
153 <a NAME="HgSummaryDialog.__finish" ID="HgSummaryDialog.__finish"></a>
122 <h4>HgSummaryDialog.__finish</h4> 154 <h4>HgSummaryDialog.__finish</h4>
123 <b>__finish</b>(<i></i>) 155 <b>__finish</b>(<i></i>)
156
124 <p> 157 <p>
125 Private slot called when the process finished or the user pressed 158 Private slot called when the process finished or the user pressed
126 the button. 159 the button.
127 </p><a NAME="HgSummaryDialog.__procFinished" ID="HgSummaryDialog.__procFinished"></a> 160 </p>
161 <a NAME="HgSummaryDialog.__procFinished" ID="HgSummaryDialog.__procFinished"></a>
128 <h4>HgSummaryDialog.__procFinished</h4> 162 <h4>HgSummaryDialog.__procFinished</h4>
129 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 163 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
164
130 <p> 165 <p>
131 Private slot connected to the finished signal. 166 Private slot connected to the finished signal.
132 </p><dl> 167 </p>
168 <dl>
169
133 <dt><i>exitCode</i></dt> 170 <dt><i>exitCode</i></dt>
134 <dd> 171 <dd>
135 exit code of the process (integer) 172 exit code of the process (integer)
136 </dd><dt><i>exitStatus</i></dt> 173 </dd>
174 <dt><i>exitStatus</i></dt>
137 <dd> 175 <dd>
138 exit status of the process (QProcess.ExitStatus) 176 exit status of the process (QProcess.ExitStatus)
139 </dd> 177 </dd>
140 </dl><a NAME="HgSummaryDialog.__processOutput" ID="HgSummaryDialog.__processOutput"></a> 178 </dl>
179 <a NAME="HgSummaryDialog.__processOutput" ID="HgSummaryDialog.__processOutput"></a>
141 <h4>HgSummaryDialog.__processOutput</h4> 180 <h4>HgSummaryDialog.__processOutput</h4>
142 <b>__processOutput</b>(<i>output</i>) 181 <b>__processOutput</b>(<i>output</i>)
182
143 <p> 183 <p>
144 Private method to process the output into nice readable text. 184 Private method to process the output into nice readable text.
145 </p><dl> 185 </p>
186 <dl>
187
146 <dt><i>output</i></dt> 188 <dt><i>output</i></dt>
147 <dd> 189 <dd>
148 output from the summary command (string) 190 output from the summary command (string)
149 </dd> 191 </dd>
150 </dl><a NAME="HgSummaryDialog.__readStderr" ID="HgSummaryDialog.__readStderr"></a> 192 </dl>
193 <a NAME="HgSummaryDialog.__readStderr" ID="HgSummaryDialog.__readStderr"></a>
151 <h4>HgSummaryDialog.__readStderr</h4> 194 <h4>HgSummaryDialog.__readStderr</h4>
152 <b>__readStderr</b>(<i></i>) 195 <b>__readStderr</b>(<i></i>)
196
153 <p> 197 <p>
154 Private slot to handle the readyReadStandardError signal. 198 Private slot to handle the readyReadStandardError signal.
155 </p><p> 199 </p>
200 <p>
156 It reads the error output of the process and inserts it into the 201 It reads the error output of the process and inserts it into the
157 error pane. 202 error pane.
158 </p><a NAME="HgSummaryDialog.__readStdout" ID="HgSummaryDialog.__readStdout"></a> 203 </p>
204 <a NAME="HgSummaryDialog.__readStdout" ID="HgSummaryDialog.__readStdout"></a>
159 <h4>HgSummaryDialog.__readStdout</h4> 205 <h4>HgSummaryDialog.__readStdout</h4>
160 <b>__readStdout</b>(<i></i>) 206 <b>__readStdout</b>(<i></i>)
207
161 <p> 208 <p>
162 Private slot to handle the readyReadStandardOutput signal. 209 Private slot to handle the readyReadStandardOutput signal.
163 </p><p> 210 </p>
211 <p>
164 It reads the output of the process, formats it and inserts it into 212 It reads the output of the process, formats it and inserts it into
165 the contents pane. 213 the contents pane.
166 </p><a NAME="HgSummaryDialog.__showError" ID="HgSummaryDialog.__showError"></a> 214 </p>
215 <a NAME="HgSummaryDialog.__showError" ID="HgSummaryDialog.__showError"></a>
167 <h4>HgSummaryDialog.__showError</h4> 216 <h4>HgSummaryDialog.__showError</h4>
168 <b>__showError</b>(<i>out</i>) 217 <b>__showError</b>(<i>out</i>)
218
169 <p> 219 <p>
170 Private slot to show some error. 220 Private slot to show some error.
171 </p><dl> 221 </p>
222 <dl>
223
172 <dt><i>out</i></dt> 224 <dt><i>out</i></dt>
173 <dd> 225 <dd>
174 error to be shown (string) 226 error to be shown (string)
175 </dd> 227 </dd>
176 </dl><a NAME="HgSummaryDialog.closeEvent" ID="HgSummaryDialog.closeEvent"></a> 228 </dl>
229 <a NAME="HgSummaryDialog.closeEvent" ID="HgSummaryDialog.closeEvent"></a>
177 <h4>HgSummaryDialog.closeEvent</h4> 230 <h4>HgSummaryDialog.closeEvent</h4>
178 <b>closeEvent</b>(<i>e</i>) 231 <b>closeEvent</b>(<i>e</i>)
232
179 <p> 233 <p>
180 Protected slot implementing a close event handler. 234 Protected slot implementing a close event handler.
181 </p><dl> 235 </p>
236 <dl>
237
182 <dt><i>e</i></dt> 238 <dt><i>e</i></dt>
183 <dd> 239 <dd>
184 close event (QCloseEvent) 240 close event (QCloseEvent)
185 </dd> 241 </dd>
186 </dl><a NAME="HgSummaryDialog.on_buttonBox_clicked" ID="HgSummaryDialog.on_buttonBox_clicked"></a> 242 </dl>
243 <a NAME="HgSummaryDialog.on_buttonBox_clicked" ID="HgSummaryDialog.on_buttonBox_clicked"></a>
187 <h4>HgSummaryDialog.on_buttonBox_clicked</h4> 244 <h4>HgSummaryDialog.on_buttonBox_clicked</h4>
188 <b>on_buttonBox_clicked</b>(<i>button</i>) 245 <b>on_buttonBox_clicked</b>(<i>button</i>)
246
189 <p> 247 <p>
190 Private slot called by a button of the button box clicked. 248 Private slot called by a button of the button box clicked.
191 </p><dl> 249 </p>
250 <dl>
251
192 <dt><i>button</i></dt> 252 <dt><i>button</i></dt>
193 <dd> 253 <dd>
194 button that was clicked (QAbstractButton) 254 button that was clicked (QAbstractButton)
195 </dd> 255 </dd>
196 </dl><a NAME="HgSummaryDialog.on_refreshButton_clicked" ID="HgSummaryDialog.on_refreshButton_clicked"></a> 256 </dl>
257 <a NAME="HgSummaryDialog.on_refreshButton_clicked" ID="HgSummaryDialog.on_refreshButton_clicked"></a>
197 <h4>HgSummaryDialog.on_refreshButton_clicked</h4> 258 <h4>HgSummaryDialog.on_refreshButton_clicked</h4>
198 <b>on_refreshButton_clicked</b>(<i></i>) 259 <b>on_refreshButton_clicked</b>(<i></i>)
260
199 <p> 261 <p>
200 Private slot to refresh the status display. 262 Private slot to refresh the status display.
201 </p><a NAME="HgSummaryDialog.start" ID="HgSummaryDialog.start"></a> 263 </p>
264 <a NAME="HgSummaryDialog.start" ID="HgSummaryDialog.start"></a>
202 <h4>HgSummaryDialog.start</h4> 265 <h4>HgSummaryDialog.start</h4>
203 <b>start</b>(<i>path, mq=False, largefiles=False</i>) 266 <b>start</b>(<i>path, mq=False, largefiles=False</i>)
267
204 <p> 268 <p>
205 Public slot to start the hg summary command. 269 Public slot to start the hg summary command.
206 </p><dl> 270 </p>
271 <dl>
272
207 <dt><i>path</i></dt> 273 <dt><i>path</i></dt>
208 <dd> 274 <dd>
209 path name of the working directory (string) 275 path name of the working directory (string)
210 </dd><dt><i>mq</i></dt> 276 </dd>
277 <dt><i>mq</i></dt>
211 <dd> 278 <dd>
212 flag indicating to show the queue status as well (boolean) 279 flag indicating to show the queue status as well (boolean)
213 </dd><dt><i>largefiles</i></dt> 280 </dd>
281 <dt><i>largefiles</i></dt>
214 <dd> 282 <dd>
215 flag indicating to show the largefiles status as 283 flag indicating to show the largefiles status as
216 well (boolean) 284 well (boolean)
217 </dd> 285 </dd>
218 </dl> 286 </dl>

Mercurial Repository: eric

eric ide

mercurial