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

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

eric ide

mercurial