5 <link rel="stylesheet" href="styles.css"> |
5 <link rel="stylesheet" href="styles.css"> |
6 </head> |
6 </head> |
7 <body> |
7 <body> |
8 <a NAME="top" ID="top"></a> |
8 <a NAME="top" ID="top"></a> |
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgSummaryDialog</h1> |
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgSummaryDialog</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing a dialog to show some summary information of the working |
11 Module implementing a dialog to show some summary information of the working |
13 directory state. |
12 directory state. |
14 </p> |
13 </p> |
|
14 |
15 <h3>Global Attributes</h3> |
15 <h3>Global Attributes</h3> |
16 |
|
17 <table> |
16 <table> |
18 <tr><td>None</td></tr> |
17 <tr><td>None</td></tr> |
19 </table> |
18 </table> |
|
19 |
20 <h3>Classes</h3> |
20 <h3>Classes</h3> |
21 |
|
22 <table> |
21 <table> |
23 |
|
24 <tr> |
22 <tr> |
25 <td><a href="#HgSummaryDialog">HgSummaryDialog</a></td> |
23 <td><a href="#HgSummaryDialog">HgSummaryDialog</a></td> |
26 <td>Class implementing a dialog to show some summary information of the working directory state.</td> |
24 <td>Class implementing a dialog to show some summary information of the working directory state.</td> |
27 </tr> |
25 </tr> |
28 </table> |
26 </table> |
|
27 |
29 <h3>Functions</h3> |
28 <h3>Functions</h3> |
30 |
|
31 <table> |
29 <table> |
32 <tr><td>None</td></tr> |
30 <tr><td>None</td></tr> |
33 </table> |
31 </table> |
|
32 |
34 <hr /> |
33 <hr /> |
35 <hr /> |
34 <hr /> |
36 <a NAME="HgSummaryDialog" ID="HgSummaryDialog"></a> |
35 <a NAME="HgSummaryDialog" ID="HgSummaryDialog"></a> |
37 <h2>HgSummaryDialog</h2> |
36 <h2>HgSummaryDialog</h2> |
38 |
|
39 <p> |
37 <p> |
40 Class implementing a dialog to show some summary information of the working |
38 Class implementing a dialog to show some summary information of the working |
41 directory state. |
39 directory state. |
42 </p> |
40 </p> |
|
41 |
43 <h3>Derived from</h3> |
42 <h3>Derived from</h3> |
44 QDialog, Ui_HgSummaryDialog |
43 QDialog, Ui_HgSummaryDialog |
45 <h3>Class Attributes</h3> |
44 <h3>Class Attributes</h3> |
46 |
|
47 <table> |
45 <table> |
48 <tr><td>None</td></tr> |
46 <tr><td>None</td></tr> |
49 </table> |
47 </table> |
|
48 |
50 <h3>Class Methods</h3> |
49 <h3>Class Methods</h3> |
51 |
|
52 <table> |
50 <table> |
53 <tr><td>None</td></tr> |
51 <tr><td>None</td></tr> |
54 </table> |
52 </table> |
|
53 |
55 <h3>Methods</h3> |
54 <h3>Methods</h3> |
56 |
|
57 <table> |
55 <table> |
58 |
|
59 <tr> |
56 <tr> |
60 <td><a href="#HgSummaryDialog.__init__">HgSummaryDialog</a></td> |
57 <td><a href="#HgSummaryDialog.__init__">HgSummaryDialog</a></td> |
61 <td>Constructor</td> |
58 <td>Constructor</td> |
62 </tr> |
59 </tr> |
63 <tr> |
60 <tr> |
83 <tr> |
80 <tr> |
84 <td><a href="#HgSummaryDialog.start">start</a></td> |
81 <td><a href="#HgSummaryDialog.start">start</a></td> |
85 <td>Public slot to start the hg summary command.</td> |
82 <td>Public slot to start the hg summary command.</td> |
86 </tr> |
83 </tr> |
87 </table> |
84 </table> |
|
85 |
88 <h3>Static Methods</h3> |
86 <h3>Static Methods</h3> |
89 |
|
90 <table> |
87 <table> |
91 <tr><td>None</td></tr> |
88 <tr><td>None</td></tr> |
92 </table> |
89 </table> |
93 |
90 |
|
91 |
94 <a NAME="HgSummaryDialog.__init__" ID="HgSummaryDialog.__init__"></a> |
92 <a NAME="HgSummaryDialog.__init__" ID="HgSummaryDialog.__init__"></a> |
95 <h4>HgSummaryDialog (Constructor)</h4> |
93 <h4>HgSummaryDialog (Constructor)</h4> |
96 <b>HgSummaryDialog</b>(<i>vcs, parent=None</i>) |
94 <b>HgSummaryDialog</b>(<i>vcs, parent=None</i>) |
97 |
|
98 <p> |
95 <p> |
99 Constructor |
96 Constructor |
100 </p> |
97 </p> |
|
98 |
101 <dl> |
99 <dl> |
102 |
100 |
103 <dt><i>vcs</i> (Hg)</dt> |
101 <dt><i>vcs</i> (Hg)</dt> |
104 <dd> |
102 <dd> |
105 reference to the vcs object |
103 reference to the vcs object |
110 </dd> |
108 </dd> |
111 </dl> |
109 </dl> |
112 <a NAME="HgSummaryDialog.__committed" ID="HgSummaryDialog.__committed"></a> |
110 <a NAME="HgSummaryDialog.__committed" ID="HgSummaryDialog.__committed"></a> |
113 <h4>HgSummaryDialog.__committed</h4> |
111 <h4>HgSummaryDialog.__committed</h4> |
114 <b>__committed</b>(<i></i>) |
112 <b>__committed</b>(<i></i>) |
115 |
|
116 <p> |
113 <p> |
117 Private slot called after the commit has finished. |
114 Private slot called after the commit has finished. |
118 </p> |
115 </p> |
|
116 |
119 <a NAME="HgSummaryDialog.__processOutput" ID="HgSummaryDialog.__processOutput"></a> |
117 <a NAME="HgSummaryDialog.__processOutput" ID="HgSummaryDialog.__processOutput"></a> |
120 <h4>HgSummaryDialog.__processOutput</h4> |
118 <h4>HgSummaryDialog.__processOutput</h4> |
121 <b>__processOutput</b>(<i>output</i>) |
119 <b>__processOutput</b>(<i>output</i>) |
122 |
|
123 <p> |
120 <p> |
124 Private method to process the output into nice readable text. |
121 Private method to process the output into nice readable text. |
125 </p> |
122 </p> |
|
123 |
126 <dl> |
124 <dl> |
127 |
125 |
128 <dt><i>output</i> (str)</dt> |
126 <dt><i>output</i> (str)</dt> |
129 <dd> |
127 <dd> |
130 output from the summary command |
128 output from the summary command |
131 </dd> |
129 </dd> |
132 </dl> |
130 </dl> |
133 <a NAME="HgSummaryDialog.__showError" ID="HgSummaryDialog.__showError"></a> |
131 <a NAME="HgSummaryDialog.__showError" ID="HgSummaryDialog.__showError"></a> |
134 <h4>HgSummaryDialog.__showError</h4> |
132 <h4>HgSummaryDialog.__showError</h4> |
135 <b>__showError</b>(<i>out</i>) |
133 <b>__showError</b>(<i>out</i>) |
136 |
|
137 <p> |
134 <p> |
138 Private slot to show some error. |
135 Private slot to show some error. |
139 </p> |
136 </p> |
|
137 |
140 <dl> |
138 <dl> |
141 |
139 |
142 <dt><i>out</i> (str)</dt> |
140 <dt><i>out</i> (str)</dt> |
143 <dd> |
141 <dd> |
144 error to be shown |
142 error to be shown |
145 </dd> |
143 </dd> |
146 </dl> |
144 </dl> |
147 <a NAME="HgSummaryDialog.on_buttonBox_clicked" ID="HgSummaryDialog.on_buttonBox_clicked"></a> |
145 <a NAME="HgSummaryDialog.on_buttonBox_clicked" ID="HgSummaryDialog.on_buttonBox_clicked"></a> |
148 <h4>HgSummaryDialog.on_buttonBox_clicked</h4> |
146 <h4>HgSummaryDialog.on_buttonBox_clicked</h4> |
149 <b>on_buttonBox_clicked</b>(<i>button</i>) |
147 <b>on_buttonBox_clicked</b>(<i>button</i>) |
150 |
|
151 <p> |
148 <p> |
152 Private slot called by a button of the button box clicked. |
149 Private slot called by a button of the button box clicked. |
153 </p> |
150 </p> |
|
151 |
154 <dl> |
152 <dl> |
155 |
153 |
156 <dt><i>button</i> (QAbstractButton)</dt> |
154 <dt><i>button</i> (QAbstractButton)</dt> |
157 <dd> |
155 <dd> |
158 button that was clicked |
156 button that was clicked |
159 </dd> |
157 </dd> |
160 </dl> |
158 </dl> |
161 <a NAME="HgSummaryDialog.on_refreshButton_clicked" ID="HgSummaryDialog.on_refreshButton_clicked"></a> |
159 <a NAME="HgSummaryDialog.on_refreshButton_clicked" ID="HgSummaryDialog.on_refreshButton_clicked"></a> |
162 <h4>HgSummaryDialog.on_refreshButton_clicked</h4> |
160 <h4>HgSummaryDialog.on_refreshButton_clicked</h4> |
163 <b>on_refreshButton_clicked</b>(<i></i>) |
161 <b>on_refreshButton_clicked</b>(<i></i>) |
164 |
|
165 <p> |
162 <p> |
166 Private slot to refresh the status display. |
163 Private slot to refresh the status display. |
167 </p> |
164 </p> |
|
165 |
168 <a NAME="HgSummaryDialog.start" ID="HgSummaryDialog.start"></a> |
166 <a NAME="HgSummaryDialog.start" ID="HgSummaryDialog.start"></a> |
169 <h4>HgSummaryDialog.start</h4> |
167 <h4>HgSummaryDialog.start</h4> |
170 <b>start</b>(<i>mq=False, largefiles=False</i>) |
168 <b>start</b>(<i>mq=False, largefiles=False</i>) |
171 |
|
172 <p> |
169 <p> |
173 Public slot to start the hg summary command. |
170 Public slot to start the hg summary command. |
174 </p> |
171 </p> |
|
172 |
175 <dl> |
173 <dl> |
176 |
174 |
177 <dt><i>mq</i> (bool)</dt> |
175 <dt><i>mq</i> (bool)</dt> |
178 <dd> |
176 <dd> |
179 flag indicating to show the queue status as well |
177 flag indicating to show the queue status as well |