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

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgSummaryDialog</h1>
24
25 <p>
26 Module implementing a dialog to show some summary information of the working
27 directory state.
28 </p>
29 <h3>Global Attributes</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <h3>Classes</h3>
35
36 <table>
37
38 <tr>
39 <td><a href="#HgSummaryDialog">HgSummaryDialog</a></td>
40 <td>Class implementing a dialog to show some summary information of the working directory state.</td>
41 </tr>
42 </table>
43 <h3>Functions</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <hr />
49 <hr />
50 <a NAME="HgSummaryDialog" ID="HgSummaryDialog"></a>
51 <h2>HgSummaryDialog</h2>
52
53 <p>
54 Class implementing a dialog to show some summary information of the working
55 directory state.
56 </p>
57 <h3>Derived from</h3>
58 QDialog, Ui_HgSummaryDialog
59 <h3>Class Attributes</h3>
60
61 <table>
62 <tr><td>None</td></tr>
63 </table>
64 <h3>Class Methods</h3>
65
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <h3>Methods</h3>
70
71 <table>
72
73 <tr>
74 <td><a href="#HgSummaryDialog.__init__">HgSummaryDialog</a></td>
75 <td>Constructor</td>
76 </tr>
77 <tr>
78 <td><a href="#HgSummaryDialog.__committed">__committed</a></td>
79 <td>Private slot called after the commit has finished.</td>
80 </tr>
81 <tr>
82 <td><a href="#HgSummaryDialog.__processOutput">__processOutput</a></td>
83 <td>Private method to process the output into nice readable text.</td>
84 </tr>
85 <tr>
86 <td><a href="#HgSummaryDialog.__showError">__showError</a></td>
87 <td>Private slot to show some error.</td>
88 </tr>
89 <tr>
90 <td><a href="#HgSummaryDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
91 <td>Private slot called by a button of the button box clicked.</td>
92 </tr>
93 <tr>
94 <td><a href="#HgSummaryDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
95 <td>Private slot to refresh the status display.</td>
96 </tr>
97 <tr>
98 <td><a href="#HgSummaryDialog.start">start</a></td>
99 <td>Public slot to start the hg summary command.</td>
100 </tr>
101 </table>
102 <h3>Static Methods</h3>
103
104 <table>
105 <tr><td>None</td></tr>
106 </table>
107
108 <a NAME="HgSummaryDialog.__init__" ID="HgSummaryDialog.__init__"></a>
109 <h4>HgSummaryDialog (Constructor)</h4>
110 <b>HgSummaryDialog</b>(<i>vcs, parent=None</i>)
111
112 <p>
113 Constructor
114 </p>
115 <dl>
116
117 <dt><i>vcs</i></dt>
118 <dd>
119 reference to the vcs object
120 </dd>
121 <dt><i>parent</i></dt>
122 <dd>
123 parent widget (QWidget)
124 </dd>
125 </dl>
126 <a NAME="HgSummaryDialog.__committed" ID="HgSummaryDialog.__committed"></a>
127 <h4>HgSummaryDialog.__committed</h4>
128 <b>__committed</b>(<i></i>)
129
130 <p>
131 Private slot called after the commit has finished.
132 </p>
133 <a NAME="HgSummaryDialog.__processOutput" ID="HgSummaryDialog.__processOutput"></a>
134 <h4>HgSummaryDialog.__processOutput</h4>
135 <b>__processOutput</b>(<i>output</i>)
136
137 <p>
138 Private method to process the output into nice readable text.
139 </p>
140 <dl>
141
142 <dt><i>output</i></dt>
143 <dd>
144 output from the summary command (string)
145 </dd>
146 </dl>
147 <a NAME="HgSummaryDialog.__showError" ID="HgSummaryDialog.__showError"></a>
148 <h4>HgSummaryDialog.__showError</h4>
149 <b>__showError</b>(<i>out</i>)
150
151 <p>
152 Private slot to show some error.
153 </p>
154 <dl>
155
156 <dt><i>out</i></dt>
157 <dd>
158 error to be shown (string)
159 </dd>
160 </dl>
161 <a NAME="HgSummaryDialog.on_buttonBox_clicked" ID="HgSummaryDialog.on_buttonBox_clicked"></a>
162 <h4>HgSummaryDialog.on_buttonBox_clicked</h4>
163 <b>on_buttonBox_clicked</b>(<i>button</i>)
164
165 <p>
166 Private slot called by a button of the button box clicked.
167 </p>
168 <dl>
169
170 <dt><i>button</i></dt>
171 <dd>
172 button that was clicked (QAbstractButton)
173 </dd>
174 </dl>
175 <a NAME="HgSummaryDialog.on_refreshButton_clicked" ID="HgSummaryDialog.on_refreshButton_clicked"></a>
176 <h4>HgSummaryDialog.on_refreshButton_clicked</h4>
177 <b>on_refreshButton_clicked</b>(<i></i>)
178
179 <p>
180 Private slot to refresh the status display.
181 </p>
182 <a NAME="HgSummaryDialog.start" ID="HgSummaryDialog.start"></a>
183 <h4>HgSummaryDialog.start</h4>
184 <b>start</b>(<i>mq=False, largefiles=False</i>)
185
186 <p>
187 Public slot to start the hg summary command.
188 </p>
189 <dl>
190
191 <dt><i>mq</i></dt>
192 <dd>
193 flag indicating to show the queue status as well (boolean)
194 </dd>
195 <dt><i>largefiles</i></dt>
196 <dd>
197 flag indicating to show the largefiles status as
198 well (boolean)
199 </dd>
200 </dl>
201 <div align="right"><a href="#top">Up</a></div>
202 <hr />
203 </body></html>

eric ide

mercurial