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

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

eric ide

mercurial