Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgBookmarksListDialog.html

eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgBookmarksListDialog.html

changeset 6942
2602857055c5
parent 5328
9c11e9285a46
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsMercurial.HgBookmarksListDialog</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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgBookmarksListDialog</h1>
23 <p>
24 Module implementing a dialog to show a list of bookmarks.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#HgBookmarksListDialog">HgBookmarksListDialog</a></td>
34 <td>Class implementing a dialog to show a list of bookmarks.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="HgBookmarksListDialog" ID="HgBookmarksListDialog"></a>
43 <h2>HgBookmarksListDialog</h2>
44 <p>
45 Class implementing a dialog to show a list of bookmarks.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_HgBookmarksListDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#HgBookmarksListDialog.__init__">HgBookmarksListDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#HgBookmarksListDialog.__deleteBookmark">__deleteBookmark</a></td>
64 <td>Private slot to delete the selected bookmark.</td>
65 </tr><tr>
66 <td><a href="#HgBookmarksListDialog.__finish">__finish</a></td>
67 <td>Private slot called when the process finished or the user pressed the button.</td>
68 </tr><tr>
69 <td><a href="#HgBookmarksListDialog.__generateItem">__generateItem</a></td>
70 <td>Private method to generate a bookmark item in the bookmarks list.</td>
71 </tr><tr>
72 <td><a href="#HgBookmarksListDialog.__procFinished">__procFinished</a></td>
73 <td>Private slot connected to the finished signal.</td>
74 </tr><tr>
75 <td><a href="#HgBookmarksListDialog.__processOutputLine">__processOutputLine</a></td>
76 <td>Private method to process the lines of output.</td>
77 </tr><tr>
78 <td><a href="#HgBookmarksListDialog.__pullBookmark">__pullBookmark</a></td>
79 <td>Private slot to pull the selected bookmark.</td>
80 </tr><tr>
81 <td><a href="#HgBookmarksListDialog.__pushBookmark">__pushBookmark</a></td>
82 <td>Private slot to push the selected bookmark.</td>
83 </tr><tr>
84 <td><a href="#HgBookmarksListDialog.__readStderr">__readStderr</a></td>
85 <td>Private slot to handle the readyReadStderr signal.</td>
86 </tr><tr>
87 <td><a href="#HgBookmarksListDialog.__readStdout">__readStdout</a></td>
88 <td>Private slot to handle the readyReadStdout signal.</td>
89 </tr><tr>
90 <td><a href="#HgBookmarksListDialog.__renameBookmark">__renameBookmark</a></td>
91 <td>Private slot to rename the selected bookmark.</td>
92 </tr><tr>
93 <td><a href="#HgBookmarksListDialog.__resizeColumns">__resizeColumns</a></td>
94 <td>Private method to resize the list columns.</td>
95 </tr><tr>
96 <td><a href="#HgBookmarksListDialog.__resort">__resort</a></td>
97 <td>Private method to resort the tree.</td>
98 </tr><tr>
99 <td><a href="#HgBookmarksListDialog.__showError">__showError</a></td>
100 <td>Private slot to show some error.</td>
101 </tr><tr>
102 <td><a href="#HgBookmarksListDialog.__switchTo">__switchTo</a></td>
103 <td>Private slot to switch the working directory to the selected revision.</td>
104 </tr><tr>
105 <td><a href="#HgBookmarksListDialog.closeEvent">closeEvent</a></td>
106 <td>Protected slot implementing a close event handler.</td>
107 </tr><tr>
108 <td><a href="#HgBookmarksListDialog.keyPressEvent">keyPressEvent</a></td>
109 <td>Protected slot to handle a key press event.</td>
110 </tr><tr>
111 <td><a href="#HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested">on_bookmarksList_customContextMenuRequested</a></td>
112 <td>Private slot to handle the context menu request.</td>
113 </tr><tr>
114 <td><a href="#HgBookmarksListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
115 <td>Private slot called by a button of the button box clicked.</td>
116 </tr><tr>
117 <td><a href="#HgBookmarksListDialog.on_input_returnPressed">on_input_returnPressed</a></td>
118 <td>Private slot to handle the press of the return key in the input field.</td>
119 </tr><tr>
120 <td><a href="#HgBookmarksListDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
121 <td>Private slot to handle the password checkbox toggled.</td>
122 </tr><tr>
123 <td><a href="#HgBookmarksListDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
124 <td>Private slot to refresh the status display.</td>
125 </tr><tr>
126 <td><a href="#HgBookmarksListDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
127 <td>Private slot to send the input to the subversion process.</td>
128 </tr><tr>
129 <td><a href="#HgBookmarksListDialog.start">start</a></td>
130 <td>Public slot to start the bookmarks command.</td>
131 </tr>
132 </table>
133 <h3>Static Methods</h3>
134 <table>
135 <tr><td>None</td></tr>
136 </table>
137 <a NAME="HgBookmarksListDialog.__init__" ID="HgBookmarksListDialog.__init__"></a>
138 <h4>HgBookmarksListDialog (Constructor)</h4>
139 <b>HgBookmarksListDialog</b>(<i>vcs, parent=None</i>)
140 <p>
141 Constructor
142 </p><dl>
143 <dt><i>vcs</i></dt>
144 <dd>
145 reference to the vcs object
146 </dd><dt><i>parent</i></dt>
147 <dd>
148 parent widget (QWidget)
149 </dd>
150 </dl><a NAME="HgBookmarksListDialog.__deleteBookmark" ID="HgBookmarksListDialog.__deleteBookmark"></a>
151 <h4>HgBookmarksListDialog.__deleteBookmark</h4>
152 <b>__deleteBookmark</b>(<i></i>)
153 <p>
154 Private slot to delete the selected bookmark.
155 </p><a NAME="HgBookmarksListDialog.__finish" ID="HgBookmarksListDialog.__finish"></a>
156 <h4>HgBookmarksListDialog.__finish</h4>
157 <b>__finish</b>(<i></i>)
158 <p>
159 Private slot called when the process finished or the user pressed
160 the button.
161 </p><a NAME="HgBookmarksListDialog.__generateItem" ID="HgBookmarksListDialog.__generateItem"></a>
162 <h4>HgBookmarksListDialog.__generateItem</h4>
163 <b>__generateItem</b>(<i>revision, changeset, status, name</i>)
164 <p>
165 Private method to generate a bookmark item in the bookmarks list.
166 </p><dl>
167 <dt><i>revision</i></dt>
168 <dd>
169 revision of the bookmark (string)
170 </dd><dt><i>changeset</i></dt>
171 <dd>
172 changeset of the bookmark (string)
173 </dd><dt><i>status</i></dt>
174 <dd>
175 of the bookmark (string)
176 </dd><dt><i>name</i></dt>
177 <dd>
178 name of the bookmark (string)
179 </dd>
180 </dl><a NAME="HgBookmarksListDialog.__procFinished" ID="HgBookmarksListDialog.__procFinished"></a>
181 <h4>HgBookmarksListDialog.__procFinished</h4>
182 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
183 <p>
184 Private slot connected to the finished signal.
185 </p><dl>
186 <dt><i>exitCode</i></dt>
187 <dd>
188 exit code of the process (integer)
189 </dd><dt><i>exitStatus</i></dt>
190 <dd>
191 exit status of the process (QProcess.ExitStatus)
192 </dd>
193 </dl><a NAME="HgBookmarksListDialog.__processOutputLine" ID="HgBookmarksListDialog.__processOutputLine"></a>
194 <h4>HgBookmarksListDialog.__processOutputLine</h4>
195 <b>__processOutputLine</b>(<i>line</i>)
196 <p>
197 Private method to process the lines of output.
198 </p><dl>
199 <dt><i>line</i></dt>
200 <dd>
201 output line to be processed (string)
202 </dd>
203 </dl><a NAME="HgBookmarksListDialog.__pullBookmark" ID="HgBookmarksListDialog.__pullBookmark"></a>
204 <h4>HgBookmarksListDialog.__pullBookmark</h4>
205 <b>__pullBookmark</b>(<i></i>)
206 <p>
207 Private slot to pull the selected bookmark.
208 </p><a NAME="HgBookmarksListDialog.__pushBookmark" ID="HgBookmarksListDialog.__pushBookmark"></a>
209 <h4>HgBookmarksListDialog.__pushBookmark</h4>
210 <b>__pushBookmark</b>(<i></i>)
211 <p>
212 Private slot to push the selected bookmark.
213 </p><a NAME="HgBookmarksListDialog.__readStderr" ID="HgBookmarksListDialog.__readStderr"></a>
214 <h4>HgBookmarksListDialog.__readStderr</h4>
215 <b>__readStderr</b>(<i></i>)
216 <p>
217 Private slot to handle the readyReadStderr signal.
218 </p><p>
219 It reads the error output of the process and inserts it into the
220 error pane.
221 </p><a NAME="HgBookmarksListDialog.__readStdout" ID="HgBookmarksListDialog.__readStdout"></a>
222 <h4>HgBookmarksListDialog.__readStdout</h4>
223 <b>__readStdout</b>(<i></i>)
224 <p>
225 Private slot to handle the readyReadStdout signal.
226 </p><p>
227 It reads the output of the process, formats it and inserts it into
228 the contents pane.
229 </p><a NAME="HgBookmarksListDialog.__renameBookmark" ID="HgBookmarksListDialog.__renameBookmark"></a>
230 <h4>HgBookmarksListDialog.__renameBookmark</h4>
231 <b>__renameBookmark</b>(<i></i>)
232 <p>
233 Private slot to rename the selected bookmark.
234 </p><a NAME="HgBookmarksListDialog.__resizeColumns" ID="HgBookmarksListDialog.__resizeColumns"></a>
235 <h4>HgBookmarksListDialog.__resizeColumns</h4>
236 <b>__resizeColumns</b>(<i></i>)
237 <p>
238 Private method to resize the list columns.
239 </p><a NAME="HgBookmarksListDialog.__resort" ID="HgBookmarksListDialog.__resort"></a>
240 <h4>HgBookmarksListDialog.__resort</h4>
241 <b>__resort</b>(<i></i>)
242 <p>
243 Private method to resort the tree.
244 </p><a NAME="HgBookmarksListDialog.__showError" ID="HgBookmarksListDialog.__showError"></a>
245 <h4>HgBookmarksListDialog.__showError</h4>
246 <b>__showError</b>(<i>out</i>)
247 <p>
248 Private slot to show some error.
249 </p><dl>
250 <dt><i>out</i></dt>
251 <dd>
252 error to be shown (string)
253 </dd>
254 </dl><a NAME="HgBookmarksListDialog.__switchTo" ID="HgBookmarksListDialog.__switchTo"></a>
255 <h4>HgBookmarksListDialog.__switchTo</h4>
256 <b>__switchTo</b>(<i></i>)
257 <p>
258 Private slot to switch the working directory to the selected revision.
259 </p><a NAME="HgBookmarksListDialog.closeEvent" ID="HgBookmarksListDialog.closeEvent"></a>
260 <h4>HgBookmarksListDialog.closeEvent</h4>
261 <b>closeEvent</b>(<i>e</i>)
262 <p>
263 Protected slot implementing a close event handler.
264 </p><dl>
265 <dt><i>e</i></dt>
266 <dd>
267 close event (QCloseEvent)
268 </dd>
269 </dl><a NAME="HgBookmarksListDialog.keyPressEvent" ID="HgBookmarksListDialog.keyPressEvent"></a>
270 <h4>HgBookmarksListDialog.keyPressEvent</h4>
271 <b>keyPressEvent</b>(<i>evt</i>)
272 <p>
273 Protected slot to handle a key press event.
274 </p><dl>
275 <dt><i>evt</i></dt>
276 <dd>
277 the key press event (QKeyEvent)
278 </dd>
279 </dl><a NAME="HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested" ID="HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested"></a>
280 <h4>HgBookmarksListDialog.on_bookmarksList_customContextMenuRequested</h4>
281 <b>on_bookmarksList_customContextMenuRequested</b>(<i>pos</i>)
282 <p>
283 Private slot to handle the context menu request.
284 </p><dl>
285 <dt><i>pos</i> (QPoint)</dt>
286 <dd>
287 position the context menu was requetsed at
288 </dd>
289 </dl><a NAME="HgBookmarksListDialog.on_buttonBox_clicked" ID="HgBookmarksListDialog.on_buttonBox_clicked"></a>
290 <h4>HgBookmarksListDialog.on_buttonBox_clicked</h4>
291 <b>on_buttonBox_clicked</b>(<i>button</i>)
292 <p>
293 Private slot called by a button of the button box clicked.
294 </p><dl>
295 <dt><i>button</i></dt>
296 <dd>
297 button that was clicked (QAbstractButton)
298 </dd>
299 </dl><a NAME="HgBookmarksListDialog.on_input_returnPressed" ID="HgBookmarksListDialog.on_input_returnPressed"></a>
300 <h4>HgBookmarksListDialog.on_input_returnPressed</h4>
301 <b>on_input_returnPressed</b>(<i></i>)
302 <p>
303 Private slot to handle the press of the return key in the input field.
304 </p><a NAME="HgBookmarksListDialog.on_passwordCheckBox_toggled" ID="HgBookmarksListDialog.on_passwordCheckBox_toggled"></a>
305 <h4>HgBookmarksListDialog.on_passwordCheckBox_toggled</h4>
306 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
307 <p>
308 Private slot to handle the password checkbox toggled.
309 </p><dl>
310 <dt><i>isOn</i></dt>
311 <dd>
312 flag indicating the status of the check box (boolean)
313 </dd>
314 </dl><a NAME="HgBookmarksListDialog.on_refreshButton_clicked" ID="HgBookmarksListDialog.on_refreshButton_clicked"></a>
315 <h4>HgBookmarksListDialog.on_refreshButton_clicked</h4>
316 <b>on_refreshButton_clicked</b>(<i></i>)
317 <p>
318 Private slot to refresh the status display.
319 </p><a NAME="HgBookmarksListDialog.on_sendButton_clicked" ID="HgBookmarksListDialog.on_sendButton_clicked"></a>
320 <h4>HgBookmarksListDialog.on_sendButton_clicked</h4>
321 <b>on_sendButton_clicked</b>(<i></i>)
322 <p>
323 Private slot to send the input to the subversion process.
324 </p><a NAME="HgBookmarksListDialog.start" ID="HgBookmarksListDialog.start"></a>
325 <h4>HgBookmarksListDialog.start</h4>
326 <b>start</b>(<i>path, bookmarksList</i>)
327 <p>
328 Public slot to start the bookmarks command.
329 </p><dl>
330 <dt><i>path</i></dt>
331 <dd>
332 name of directory to be listed (string)
333 </dd><dt><i>bookmarksList</i></dt>
334 <dd>
335 reference to string list receiving the bookmarks
336 (list of strings)
337 </dd>
338 </dl>
339 <div align="right"><a href="#top">Up</a></div>
340 <hr />
341 </body></html>

Mercurial Repository: eric

eric ide

mercurial