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