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.HgBookmarksInOutDialog</h1> |
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgBookmarksInOutDialog</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing a dialog to show a list of incoming or outgoing bookmarks. |
11 Module implementing a dialog to show a list of incoming or outgoing bookmarks. |
13 </p> |
12 </p> |
|
13 |
14 <h3>Global Attributes</h3> |
14 <h3>Global Attributes</h3> |
15 |
15 <table> |
16 <table> |
16 <tr><td>None</td></tr> |
17 <tr><td>None</td></tr> |
17 </table> |
18 </table> |
18 |
19 <h3>Classes</h3> |
19 <h3>Classes</h3> |
20 |
20 <table> |
21 <table> |
|
22 |
|
23 <tr> |
21 <tr> |
24 <td><a href="#HgBookmarksInOutDialog">HgBookmarksInOutDialog</a></td> |
22 <td><a href="#HgBookmarksInOutDialog">HgBookmarksInOutDialog</a></td> |
25 <td>Class implementing a dialog to show a list of incoming or outgoing bookmarks.</td> |
23 <td>Class implementing a dialog to show a list of incoming or outgoing bookmarks.</td> |
26 </tr> |
24 </tr> |
27 </table> |
25 </table> |
|
26 |
28 <h3>Functions</h3> |
27 <h3>Functions</h3> |
29 |
28 <table> |
30 <table> |
29 <tr><td>None</td></tr> |
31 <tr><td>None</td></tr> |
30 </table> |
32 </table> |
31 |
33 <hr /> |
32 <hr /> |
34 <hr /> |
33 <hr /> |
35 <a NAME="HgBookmarksInOutDialog" ID="HgBookmarksInOutDialog"></a> |
34 <a NAME="HgBookmarksInOutDialog" ID="HgBookmarksInOutDialog"></a> |
36 <h2>HgBookmarksInOutDialog</h2> |
35 <h2>HgBookmarksInOutDialog</h2> |
37 |
|
38 <p> |
36 <p> |
39 Class implementing a dialog to show a list of incoming or outgoing |
37 Class implementing a dialog to show a list of incoming or outgoing |
40 bookmarks. |
38 bookmarks. |
41 </p> |
39 </p> |
|
40 |
42 <h3>Derived from</h3> |
41 <h3>Derived from</h3> |
43 QDialog, Ui_HgBookmarksInOutDialog |
42 QDialog, Ui_HgBookmarksInOutDialog |
44 <h3>Class Attributes</h3> |
43 <h3>Class Attributes</h3> |
45 |
44 <table> |
46 <table> |
45 <tr><td>INCOMING</td></tr> |
47 <tr><td>INCOMING</td></tr><tr><td>OUTGOING</td></tr> |
46 <tr><td>OUTGOING</td></tr> |
48 </table> |
47 </table> |
|
48 |
49 <h3>Class Methods</h3> |
49 <h3>Class Methods</h3> |
50 |
50 <table> |
51 <table> |
51 <tr><td>None</td></tr> |
52 <tr><td>None</td></tr> |
52 </table> |
53 </table> |
53 |
54 <h3>Methods</h3> |
54 <h3>Methods</h3> |
55 |
55 <table> |
56 <table> |
|
57 |
|
58 <tr> |
56 <tr> |
59 <td><a href="#HgBookmarksInOutDialog.__init__">HgBookmarksInOutDialog</a></td> |
57 <td><a href="#HgBookmarksInOutDialog.__init__">HgBookmarksInOutDialog</a></td> |
60 <td>Constructor</td> |
58 <td>Constructor</td> |
61 </tr> |
59 </tr> |
62 <tr> |
60 <tr> |
94 <tr> |
92 <tr> |
95 <td><a href="#HgBookmarksInOutDialog.start">start</a></td> |
93 <td><a href="#HgBookmarksInOutDialog.start">start</a></td> |
96 <td>Public slot to start the bookmarks command.</td> |
94 <td>Public slot to start the bookmarks command.</td> |
97 </tr> |
95 </tr> |
98 </table> |
96 </table> |
|
97 |
99 <h3>Static Methods</h3> |
98 <h3>Static Methods</h3> |
100 |
99 <table> |
101 <table> |
100 <tr><td>None</td></tr> |
102 <tr><td>None</td></tr> |
101 </table> |
103 </table> |
102 |
104 |
103 |
105 <a NAME="HgBookmarksInOutDialog.__init__" ID="HgBookmarksInOutDialog.__init__"></a> |
104 <a NAME="HgBookmarksInOutDialog.__init__" ID="HgBookmarksInOutDialog.__init__"></a> |
106 <h4>HgBookmarksInOutDialog (Constructor)</h4> |
105 <h4>HgBookmarksInOutDialog (Constructor)</h4> |
107 <b>HgBookmarksInOutDialog</b>(<i>vcs, mode, parent=None</i>) |
106 <b>HgBookmarksInOutDialog</b>(<i>vcs, mode, parent=None</i>) |
108 |
|
109 <p> |
107 <p> |
110 Constructor |
108 Constructor |
111 </p> |
109 </p> |
|
110 |
112 <dl> |
111 <dl> |
113 |
112 |
114 <dt><i>vcs</i> (Hg)</dt> |
113 <dt><i>vcs</i> (Hg)</dt> |
115 <dd> |
114 <dd> |
116 reference to the vcs object |
115 reference to the vcs object |
133 </dd> |
132 </dd> |
134 </dl> |
133 </dl> |
135 <a NAME="HgBookmarksInOutDialog.__finish" ID="HgBookmarksInOutDialog.__finish"></a> |
134 <a NAME="HgBookmarksInOutDialog.__finish" ID="HgBookmarksInOutDialog.__finish"></a> |
136 <h4>HgBookmarksInOutDialog.__finish</h4> |
135 <h4>HgBookmarksInOutDialog.__finish</h4> |
137 <b>__finish</b>(<i></i>) |
136 <b>__finish</b>(<i></i>) |
138 |
|
139 <p> |
137 <p> |
140 Private slot called when the process finished or the user pressed |
138 Private slot called when the process finished or the user pressed |
141 the button. |
139 the button. |
142 </p> |
140 </p> |
|
141 |
143 <a NAME="HgBookmarksInOutDialog.__generateItem" ID="HgBookmarksInOutDialog.__generateItem"></a> |
142 <a NAME="HgBookmarksInOutDialog.__generateItem" ID="HgBookmarksInOutDialog.__generateItem"></a> |
144 <h4>HgBookmarksInOutDialog.__generateItem</h4> |
143 <h4>HgBookmarksInOutDialog.__generateItem</h4> |
145 <b>__generateItem</b>(<i>changeset, name</i>) |
144 <b>__generateItem</b>(<i>changeset, name</i>) |
146 |
|
147 <p> |
145 <p> |
148 Private method to generate a bookmark item in the bookmarks list. |
146 Private method to generate a bookmark item in the bookmarks list. |
149 </p> |
147 </p> |
|
148 |
150 <dl> |
149 <dl> |
151 |
150 |
152 <dt><i>changeset</i> (str)</dt> |
151 <dt><i>changeset</i> (str)</dt> |
153 <dd> |
152 <dd> |
154 changeset of the bookmark |
153 changeset of the bookmark |
159 </dd> |
158 </dd> |
160 </dl> |
159 </dl> |
161 <a NAME="HgBookmarksInOutDialog.__processOutputLine" ID="HgBookmarksInOutDialog.__processOutputLine"></a> |
160 <a NAME="HgBookmarksInOutDialog.__processOutputLine" ID="HgBookmarksInOutDialog.__processOutputLine"></a> |
162 <h4>HgBookmarksInOutDialog.__processOutputLine</h4> |
161 <h4>HgBookmarksInOutDialog.__processOutputLine</h4> |
163 <b>__processOutputLine</b>(<i>line</i>) |
162 <b>__processOutputLine</b>(<i>line</i>) |
164 |
|
165 <p> |
163 <p> |
166 Private method to process the lines of output. |
164 Private method to process the lines of output. |
167 </p> |
165 </p> |
|
166 |
168 <dl> |
167 <dl> |
169 |
168 |
170 <dt><i>line</i> (str)</dt> |
169 <dt><i>line</i> (str)</dt> |
171 <dd> |
170 <dd> |
172 output line to be processed |
171 output line to be processed |
173 </dd> |
172 </dd> |
174 </dl> |
173 </dl> |
175 <a NAME="HgBookmarksInOutDialog.__resizeColumns" ID="HgBookmarksInOutDialog.__resizeColumns"></a> |
174 <a NAME="HgBookmarksInOutDialog.__resizeColumns" ID="HgBookmarksInOutDialog.__resizeColumns"></a> |
176 <h4>HgBookmarksInOutDialog.__resizeColumns</h4> |
175 <h4>HgBookmarksInOutDialog.__resizeColumns</h4> |
177 <b>__resizeColumns</b>(<i></i>) |
176 <b>__resizeColumns</b>(<i></i>) |
178 |
|
179 <p> |
177 <p> |
180 Private method to resize the list columns. |
178 Private method to resize the list columns. |
181 </p> |
179 </p> |
|
180 |
182 <a NAME="HgBookmarksInOutDialog.__resort" ID="HgBookmarksInOutDialog.__resort"></a> |
181 <a NAME="HgBookmarksInOutDialog.__resort" ID="HgBookmarksInOutDialog.__resort"></a> |
183 <h4>HgBookmarksInOutDialog.__resort</h4> |
182 <h4>HgBookmarksInOutDialog.__resort</h4> |
184 <b>__resort</b>(<i></i>) |
183 <b>__resort</b>(<i></i>) |
185 |
|
186 <p> |
184 <p> |
187 Private method to resort the tree. |
185 Private method to resort the tree. |
188 </p> |
186 </p> |
|
187 |
189 <a NAME="HgBookmarksInOutDialog.__showError" ID="HgBookmarksInOutDialog.__showError"></a> |
188 <a NAME="HgBookmarksInOutDialog.__showError" ID="HgBookmarksInOutDialog.__showError"></a> |
190 <h4>HgBookmarksInOutDialog.__showError</h4> |
189 <h4>HgBookmarksInOutDialog.__showError</h4> |
191 <b>__showError</b>(<i>out</i>) |
190 <b>__showError</b>(<i>out</i>) |
192 |
|
193 <p> |
191 <p> |
194 Private slot to show some error. |
192 Private slot to show some error. |
195 </p> |
193 </p> |
|
194 |
196 <dl> |
195 <dl> |
197 |
196 |
198 <dt><i>out</i> (str)</dt> |
197 <dt><i>out</i> (str)</dt> |
199 <dd> |
198 <dd> |
200 error to be shown |
199 error to be shown |
201 </dd> |
200 </dd> |
202 </dl> |
201 </dl> |
203 <a NAME="HgBookmarksInOutDialog.closeEvent" ID="HgBookmarksInOutDialog.closeEvent"></a> |
202 <a NAME="HgBookmarksInOutDialog.closeEvent" ID="HgBookmarksInOutDialog.closeEvent"></a> |
204 <h4>HgBookmarksInOutDialog.closeEvent</h4> |
203 <h4>HgBookmarksInOutDialog.closeEvent</h4> |
205 <b>closeEvent</b>(<i>e</i>) |
204 <b>closeEvent</b>(<i>e</i>) |
206 |
|
207 <p> |
205 <p> |
208 Protected slot implementing a close event handler. |
206 Protected slot implementing a close event handler. |
209 </p> |
207 </p> |
|
208 |
210 <dl> |
209 <dl> |
211 |
210 |
212 <dt><i>e</i> (QCloseEvent)</dt> |
211 <dt><i>e</i> (QCloseEvent)</dt> |
213 <dd> |
212 <dd> |
214 close event |
213 close event |
215 </dd> |
214 </dd> |
216 </dl> |
215 </dl> |
217 <a NAME="HgBookmarksInOutDialog.on_buttonBox_clicked" ID="HgBookmarksInOutDialog.on_buttonBox_clicked"></a> |
216 <a NAME="HgBookmarksInOutDialog.on_buttonBox_clicked" ID="HgBookmarksInOutDialog.on_buttonBox_clicked"></a> |
218 <h4>HgBookmarksInOutDialog.on_buttonBox_clicked</h4> |
217 <h4>HgBookmarksInOutDialog.on_buttonBox_clicked</h4> |
219 <b>on_buttonBox_clicked</b>(<i>button</i>) |
218 <b>on_buttonBox_clicked</b>(<i>button</i>) |
220 |
|
221 <p> |
219 <p> |
222 Private slot called by a button of the button box clicked. |
220 Private slot called by a button of the button box clicked. |
223 </p> |
221 </p> |
|
222 |
224 <dl> |
223 <dl> |
225 |
224 |
226 <dt><i>button</i> (QAbstractButton)</dt> |
225 <dt><i>button</i> (QAbstractButton)</dt> |
227 <dd> |
226 <dd> |
228 button that was clicked |
227 button that was clicked |
229 </dd> |
228 </dd> |
230 </dl> |
229 </dl> |
231 <a NAME="HgBookmarksInOutDialog.start" ID="HgBookmarksInOutDialog.start"></a> |
230 <a NAME="HgBookmarksInOutDialog.start" ID="HgBookmarksInOutDialog.start"></a> |
232 <h4>HgBookmarksInOutDialog.start</h4> |
231 <h4>HgBookmarksInOutDialog.start</h4> |
233 <b>start</b>(<i></i>) |
232 <b>start</b>(<i></i>) |
234 |
|
235 <p> |
233 <p> |
236 Public slot to start the bookmarks command. |
234 Public slot to start the bookmarks command. |
237 </p> |
235 </p> |
|
236 |
238 <dl> |
237 <dl> |
239 |
238 |
240 <dt>Raises <b>ValueError</b>:</dt> |
239 <dt>Raises <b>ValueError</b>:</dt> |
241 <dd> |
240 <dd> |
242 raised to indicate an invalid dialog mode |
241 raised to indicate an invalid dialog mode |