Mercurial Repositories > eric / file comparison

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

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

changeset 3562
ef3f13a2c599
child 3591
2f2a4a76dd22
equal deleted inserted replaced
3559:8938a2a66dee 3562:ef3f13a2c599
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric5.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>eric5.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.__finish">__finish</a></td>
64 <td>Private slot called when the process finished or the user pressed the button.</td>
65 </tr><tr>
66 <td><a href="#HgBookmarksListDialog.__generateItem">__generateItem</a></td>
67 <td>Private method to generate a bookmark item in the bookmarks list.</td>
68 </tr><tr>
69 <td><a href="#HgBookmarksListDialog.__procFinished">__procFinished</a></td>
70 <td>Private slot connected to the finished signal.</td>
71 </tr><tr>
72 <td><a href="#HgBookmarksListDialog.__processOutputLine">__processOutputLine</a></td>
73 <td>Private method to process the lines of output.</td>
74 </tr><tr>
75 <td><a href="#HgBookmarksListDialog.__readStderr">__readStderr</a></td>
76 <td>Private slot to handle the readyReadStderr signal.</td>
77 </tr><tr>
78 <td><a href="#HgBookmarksListDialog.__readStdout">__readStdout</a></td>
79 <td>Private slot to handle the readyReadStdout signal.</td>
80 </tr><tr>
81 <td><a href="#HgBookmarksListDialog.__resizeColumns">__resizeColumns</a></td>
82 <td>Private method to resize the list columns.</td>
83 </tr><tr>
84 <td><a href="#HgBookmarksListDialog.__resort">__resort</a></td>
85 <td>Private method to resort the tree.</td>
86 </tr><tr>
87 <td><a href="#HgBookmarksListDialog.__showError">__showError</a></td>
88 <td>Private slot to show some error.</td>
89 </tr><tr>
90 <td><a href="#HgBookmarksListDialog.closeEvent">closeEvent</a></td>
91 <td>Private slot implementing a close event handler.</td>
92 </tr><tr>
93 <td><a href="#HgBookmarksListDialog.keyPressEvent">keyPressEvent</a></td>
94 <td>Protected slot to handle a key press event.</td>
95 </tr><tr>
96 <td><a href="#HgBookmarksListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
97 <td>Private slot called by a button of the button box clicked.</td>
98 </tr><tr>
99 <td><a href="#HgBookmarksListDialog.on_input_returnPressed">on_input_returnPressed</a></td>
100 <td>Private slot to handle the press of the return key in the input field.</td>
101 </tr><tr>
102 <td><a href="#HgBookmarksListDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
103 <td>Private slot to handle the password checkbox toggled.</td>
104 </tr><tr>
105 <td><a href="#HgBookmarksListDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
106 <td>Private slot to send the input to the subversion process.</td>
107 </tr><tr>
108 <td><a href="#HgBookmarksListDialog.start">start</a></td>
109 <td>Public slot to start the bookmarks command.</td>
110 </tr>
111 </table>
112 <h3>Static Methods</h3>
113 <table>
114 <tr><td>None</td></tr>
115 </table>
116 <a NAME="HgBookmarksListDialog.__init__" ID="HgBookmarksListDialog.__init__"></a>
117 <h4>HgBookmarksListDialog (Constructor)</h4>
118 <b>HgBookmarksListDialog</b>(<i>vcs, parent=None</i>)
119 <p>
120 Constructor
121 </p><dl>
122 <dt><i>vcs</i></dt>
123 <dd>
124 reference to the vcs object
125 </dd><dt><i>parent</i></dt>
126 <dd>
127 parent widget (QWidget)
128 </dd>
129 </dl><a NAME="HgBookmarksListDialog.__finish" ID="HgBookmarksListDialog.__finish"></a>
130 <h4>HgBookmarksListDialog.__finish</h4>
131 <b>__finish</b>(<i></i>)
132 <p>
133 Private slot called when the process finished or the user pressed
134 the button.
135 </p><a NAME="HgBookmarksListDialog.__generateItem" ID="HgBookmarksListDialog.__generateItem"></a>
136 <h4>HgBookmarksListDialog.__generateItem</h4>
137 <b>__generateItem</b>(<i>revision, changeset, status, name</i>)
138 <p>
139 Private method to generate a bookmark item in the bookmarks list.
140 </p><dl>
141 <dt><i>revision</i></dt>
142 <dd>
143 revision of the bookmark (string)
144 </dd><dt><i>changeset</i></dt>
145 <dd>
146 changeset of the bookmark (string)
147 </dd><dt><i>status</i></dt>
148 <dd>
149 of the bookmark (string)
150 </dd><dt><i>name</i></dt>
151 <dd>
152 name of the bookmark (string)
153 </dd>
154 </dl><a NAME="HgBookmarksListDialog.__procFinished" ID="HgBookmarksListDialog.__procFinished"></a>
155 <h4>HgBookmarksListDialog.__procFinished</h4>
156 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
157 <p>
158 Private slot connected to the finished signal.
159 </p><dl>
160 <dt><i>exitCode</i></dt>
161 <dd>
162 exit code of the process (integer)
163 </dd><dt><i>exitStatus</i></dt>
164 <dd>
165 exit status of the process (QProcess.ExitStatus)
166 </dd>
167 </dl><a NAME="HgBookmarksListDialog.__processOutputLine" ID="HgBookmarksListDialog.__processOutputLine"></a>
168 <h4>HgBookmarksListDialog.__processOutputLine</h4>
169 <b>__processOutputLine</b>(<i>line</i>)
170 <p>
171 Private method to process the lines of output.
172 </p><dl>
173 <dt><i>line</i></dt>
174 <dd>
175 output line to be processed (string)
176 </dd>
177 </dl><a NAME="HgBookmarksListDialog.__readStderr" ID="HgBookmarksListDialog.__readStderr"></a>
178 <h4>HgBookmarksListDialog.__readStderr</h4>
179 <b>__readStderr</b>(<i></i>)
180 <p>
181 Private slot to handle the readyReadStderr signal.
182 </p><p>
183 It reads the error output of the process and inserts it into the
184 error pane.
185 </p><a NAME="HgBookmarksListDialog.__readStdout" ID="HgBookmarksListDialog.__readStdout"></a>
186 <h4>HgBookmarksListDialog.__readStdout</h4>
187 <b>__readStdout</b>(<i></i>)
188 <p>
189 Private slot to handle the readyReadStdout signal.
190 </p><p>
191 It reads the output of the process, formats it and inserts it into
192 the contents pane.
193 </p><a NAME="HgBookmarksListDialog.__resizeColumns" ID="HgBookmarksListDialog.__resizeColumns"></a>
194 <h4>HgBookmarksListDialog.__resizeColumns</h4>
195 <b>__resizeColumns</b>(<i></i>)
196 <p>
197 Private method to resize the list columns.
198 </p><a NAME="HgBookmarksListDialog.__resort" ID="HgBookmarksListDialog.__resort"></a>
199 <h4>HgBookmarksListDialog.__resort</h4>
200 <b>__resort</b>(<i></i>)
201 <p>
202 Private method to resort the tree.
203 </p><a NAME="HgBookmarksListDialog.__showError" ID="HgBookmarksListDialog.__showError"></a>
204 <h4>HgBookmarksListDialog.__showError</h4>
205 <b>__showError</b>(<i>out</i>)
206 <p>
207 Private slot to show some error.
208 </p><dl>
209 <dt><i>out</i></dt>
210 <dd>
211 error to be shown (string)
212 </dd>
213 </dl><a NAME="HgBookmarksListDialog.closeEvent" ID="HgBookmarksListDialog.closeEvent"></a>
214 <h4>HgBookmarksListDialog.closeEvent</h4>
215 <b>closeEvent</b>(<i>e</i>)
216 <p>
217 Private slot implementing a close event handler.
218 </p><dl>
219 <dt><i>e</i></dt>
220 <dd>
221 close event (QCloseEvent)
222 </dd>
223 </dl><a NAME="HgBookmarksListDialog.keyPressEvent" ID="HgBookmarksListDialog.keyPressEvent"></a>
224 <h4>HgBookmarksListDialog.keyPressEvent</h4>
225 <b>keyPressEvent</b>(<i>evt</i>)
226 <p>
227 Protected slot to handle a key press event.
228 </p><dl>
229 <dt><i>evt</i></dt>
230 <dd>
231 the key press event (QKeyEvent)
232 </dd>
233 </dl><a NAME="HgBookmarksListDialog.on_buttonBox_clicked" ID="HgBookmarksListDialog.on_buttonBox_clicked"></a>
234 <h4>HgBookmarksListDialog.on_buttonBox_clicked</h4>
235 <b>on_buttonBox_clicked</b>(<i>button</i>)
236 <p>
237 Private slot called by a button of the button box clicked.
238 </p><dl>
239 <dt><i>button</i></dt>
240 <dd>
241 button that was clicked (QAbstractButton)
242 </dd>
243 </dl><a NAME="HgBookmarksListDialog.on_input_returnPressed" ID="HgBookmarksListDialog.on_input_returnPressed"></a>
244 <h4>HgBookmarksListDialog.on_input_returnPressed</h4>
245 <b>on_input_returnPressed</b>(<i></i>)
246 <p>
247 Private slot to handle the press of the return key in the input field.
248 </p><a NAME="HgBookmarksListDialog.on_passwordCheckBox_toggled" ID="HgBookmarksListDialog.on_passwordCheckBox_toggled"></a>
249 <h4>HgBookmarksListDialog.on_passwordCheckBox_toggled</h4>
250 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
251 <p>
252 Private slot to handle the password checkbox toggled.
253 </p><dl>
254 <dt><i>isOn</i></dt>
255 <dd>
256 flag indicating the status of the check box (boolean)
257 </dd>
258 </dl><a NAME="HgBookmarksListDialog.on_sendButton_clicked" ID="HgBookmarksListDialog.on_sendButton_clicked"></a>
259 <h4>HgBookmarksListDialog.on_sendButton_clicked</h4>
260 <b>on_sendButton_clicked</b>(<i></i>)
261 <p>
262 Private slot to send the input to the subversion process.
263 </p><a NAME="HgBookmarksListDialog.start" ID="HgBookmarksListDialog.start"></a>
264 <h4>HgBookmarksListDialog.start</h4>
265 <b>start</b>(<i>path, bookmarksList</i>)
266 <p>
267 Public slot to start the bookmarks command.
268 </p><dl>
269 <dt><i>path</i></dt>
270 <dd>
271 name of directory to be listed (string)
272 </dd><dt><i>bookmarksList</i></dt>
273 <dd>
274 reference to string list receiving the bookmarks
275 (list of strings)
276 </dd>
277 </dl>
278 <div align="right"><a href="#top">Up</a></div>
279 <hr />
280 </body></html>

Mercurial Repository: eric

eric ide

mercurial