eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog.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.HgAnnotateDialog</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.HgAnnotateDialog</h1>
24
25 <p>
26 Module implementing a dialog to show the output of the hg annotate command.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#HgAnnotateDialog">HgAnnotateDialog</a></td>
39 <td>Class implementing a dialog to show the output of the hg annotate command.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="HgAnnotateDialog" ID="HgAnnotateDialog"></a>
50 <h2>HgAnnotateDialog</h2>
51
52 <p>
53 Class implementing a dialog to show the output of the hg annotate command.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_HgAnnotateDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#HgAnnotateDialog.__init__">HgAnnotateDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#HgAnnotateDialog.__finish">__finish</a></td>
77 <td>Private slot called when the process finished or the user pressed the button.</td>
78 </tr>
79 <tr>
80 <td><a href="#HgAnnotateDialog.__generateItem">__generateItem</a></td>
81 <td>Private method to generate an annotate item in the annotation list.</td>
82 </tr>
83 <tr>
84 <td><a href="#HgAnnotateDialog.__processOutputLine">__processOutputLine</a></td>
85 <td>Private method to process the lines of output.</td>
86 </tr>
87 <tr>
88 <td><a href="#HgAnnotateDialog.__resizeColumns">__resizeColumns</a></td>
89 <td>Private method to resize the list columns.</td>
90 </tr>
91 <tr>
92 <td><a href="#HgAnnotateDialog.__showError">__showError</a></td>
93 <td>Private slot to show some error.</td>
94 </tr>
95 <tr>
96 <td><a href="#HgAnnotateDialog.closeEvent">closeEvent</a></td>
97 <td>Protected slot implementing a close event handler.</td>
98 </tr>
99 <tr>
100 <td><a href="#HgAnnotateDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
101 <td>Private slot called by a button of the button box clicked.</td>
102 </tr>
103 <tr>
104 <td><a href="#HgAnnotateDialog.start">start</a></td>
105 <td>Public slot to start the annotate command.</td>
106 </tr>
107 </table>
108 <h3>Static Methods</h3>
109
110 <table>
111 <tr><td>None</td></tr>
112 </table>
113
114 <a NAME="HgAnnotateDialog.__init__" ID="HgAnnotateDialog.__init__"></a>
115 <h4>HgAnnotateDialog (Constructor)</h4>
116 <b>HgAnnotateDialog</b>(<i>vcs, parent=None</i>)
117
118 <p>
119 Constructor
120 </p>
121 <dl>
122
123 <dt><i>vcs</i></dt>
124 <dd>
125 reference to the vcs object
126 </dd>
127 <dt><i>parent</i></dt>
128 <dd>
129 parent widget (QWidget)
130 </dd>
131 </dl>
132 <a NAME="HgAnnotateDialog.__finish" ID="HgAnnotateDialog.__finish"></a>
133 <h4>HgAnnotateDialog.__finish</h4>
134 <b>__finish</b>(<i></i>)
135
136 <p>
137 Private slot called when the process finished or the user pressed
138 the button.
139 </p>
140 <a NAME="HgAnnotateDialog.__generateItem" ID="HgAnnotateDialog.__generateItem"></a>
141 <h4>HgAnnotateDialog.__generateItem</h4>
142 <b>__generateItem</b>(<i>revision, changeset, author, date, text</i>)
143
144 <p>
145 Private method to generate an annotate item in the annotation list.
146 </p>
147 <dl>
148
149 <dt><i>revision</i></dt>
150 <dd>
151 revision string (string)
152 </dd>
153 <dt><i>changeset</i></dt>
154 <dd>
155 changeset string (string)
156 </dd>
157 <dt><i>author</i></dt>
158 <dd>
159 author of the change (string)
160 </dd>
161 <dt><i>date</i></dt>
162 <dd>
163 date of the change (string)
164 </dd>
165 <dt><i>text</i></dt>
166 <dd>
167 text of the change (string)
168 </dd>
169 </dl>
170 <a NAME="HgAnnotateDialog.__processOutputLine" ID="HgAnnotateDialog.__processOutputLine"></a>
171 <h4>HgAnnotateDialog.__processOutputLine</h4>
172 <b>__processOutputLine</b>(<i>line</i>)
173
174 <p>
175 Private method to process the lines of output.
176 </p>
177 <dl>
178
179 <dt><i>line</i></dt>
180 <dd>
181 output line to be processed (string)
182 </dd>
183 </dl>
184 <a NAME="HgAnnotateDialog.__resizeColumns" ID="HgAnnotateDialog.__resizeColumns"></a>
185 <h4>HgAnnotateDialog.__resizeColumns</h4>
186 <b>__resizeColumns</b>(<i></i>)
187
188 <p>
189 Private method to resize the list columns.
190 </p>
191 <a NAME="HgAnnotateDialog.__showError" ID="HgAnnotateDialog.__showError"></a>
192 <h4>HgAnnotateDialog.__showError</h4>
193 <b>__showError</b>(<i>out</i>)
194
195 <p>
196 Private slot to show some error.
197 </p>
198 <dl>
199
200 <dt><i>out</i></dt>
201 <dd>
202 error to be shown (string)
203 </dd>
204 </dl>
205 <a NAME="HgAnnotateDialog.closeEvent" ID="HgAnnotateDialog.closeEvent"></a>
206 <h4>HgAnnotateDialog.closeEvent</h4>
207 <b>closeEvent</b>(<i>e</i>)
208
209 <p>
210 Protected slot implementing a close event handler.
211 </p>
212 <dl>
213
214 <dt><i>e</i></dt>
215 <dd>
216 close event (QCloseEvent)
217 </dd>
218 </dl>
219 <a NAME="HgAnnotateDialog.on_buttonBox_clicked" ID="HgAnnotateDialog.on_buttonBox_clicked"></a>
220 <h4>HgAnnotateDialog.on_buttonBox_clicked</h4>
221 <b>on_buttonBox_clicked</b>(<i>button</i>)
222
223 <p>
224 Private slot called by a button of the button box clicked.
225 </p>
226 <dl>
227
228 <dt><i>button</i></dt>
229 <dd>
230 button that was clicked (QAbstractButton)
231 </dd>
232 </dl>
233 <a NAME="HgAnnotateDialog.start" ID="HgAnnotateDialog.start"></a>
234 <h4>HgAnnotateDialog.start</h4>
235 <b>start</b>(<i>fn</i>)
236
237 <p>
238 Public slot to start the annotate command.
239 </p>
240 <dl>
241
242 <dt><i>fn</i></dt>
243 <dd>
244 filename to show the annotation for (string)
245 </dd>
246 </dl>
247 <div align="right"><a href="#top">Up</a></div>
248 <hr />
249 </body></html>

eric ide

mercurial