Mercurial Repositories > eric / file comparison

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

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

Mercurial Repository: eric

eric ide

mercurial