Mercurial Repositories > eric / file comparison

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

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

changeset 1020
adf7e95f05e7
child 1228
7afaf2fca55b
equal deleted inserted replaced
1019:d8a9697f78d1 1020:adf7e95f05e7
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.HgBookmarksListDialog</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.HgBookmarksListDialog</h1>
24 <p>
25 Module implementing a dialog to show a list of bookmarks.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#HgBookmarksListDialog">HgBookmarksListDialog</a></td>
35 <td>Class implementing a dialog to show a list of bookmarks.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="HgBookmarksListDialog" ID="HgBookmarksListDialog"></a>
44 <h2>HgBookmarksListDialog</h2>
45 <p>
46 Class implementing a dialog to show a list of bookmarks.
47 </p>
48 <h3>Derived from</h3>
49 QDialog, Ui_HgBookmarksListDialog
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#HgBookmarksListDialog.__init__">HgBookmarksListDialog</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#HgBookmarksListDialog.__finish">__finish</a></td>
61 <td>Private slot called when the process finished or the user pressed the button.</td>
62 </tr><tr>
63 <td><a href="#HgBookmarksListDialog.__generateItem">__generateItem</a></td>
64 <td>Private method to generate a bookmark item in the bookmarks list.</td>
65 </tr><tr>
66 <td><a href="#HgBookmarksListDialog.__procFinished">__procFinished</a></td>
67 <td>Private slot connected to the finished signal.</td>
68 </tr><tr>
69 <td><a href="#HgBookmarksListDialog.__readStderr">__readStderr</a></td>
70 <td>Private slot to handle the readyReadStderr signal.</td>
71 </tr><tr>
72 <td><a href="#HgBookmarksListDialog.__readStdout">__readStdout</a></td>
73 <td>Private slot to handle the readyReadStdout signal.</td>
74 </tr><tr>
75 <td><a href="#HgBookmarksListDialog.__resizeColumns">__resizeColumns</a></td>
76 <td>Private method to resize the list columns.</td>
77 </tr><tr>
78 <td><a href="#HgBookmarksListDialog.__resort">__resort</a></td>
79 <td>Private method to resort the tree.</td>
80 </tr><tr>
81 <td><a href="#HgBookmarksListDialog.closeEvent">closeEvent</a></td>
82 <td>Private slot implementing a close event handler.</td>
83 </tr><tr>
84 <td><a href="#HgBookmarksListDialog.keyPressEvent">keyPressEvent</a></td>
85 <td>Protected slot to handle a key press event.</td>
86 </tr><tr>
87 <td><a href="#HgBookmarksListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
88 <td>Private slot called by a button of the button box clicked.</td>
89 </tr><tr>
90 <td><a href="#HgBookmarksListDialog.on_input_returnPressed">on_input_returnPressed</a></td>
91 <td>Private slot to handle the press of the return key in the input field.</td>
92 </tr><tr>
93 <td><a href="#HgBookmarksListDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
94 <td>Private slot to handle the password checkbox toggled.</td>
95 </tr><tr>
96 <td><a href="#HgBookmarksListDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
97 <td>Private slot to send the input to the subversion process.</td>
98 </tr><tr>
99 <td><a href="#HgBookmarksListDialog.start">start</a></td>
100 <td>Public slot to start the bookmarks command.</td>
101 </tr>
102 </table>
103 <a NAME="HgBookmarksListDialog.__init__" ID="HgBookmarksListDialog.__init__"></a>
104 <h4>HgBookmarksListDialog (Constructor)</h4>
105 <b>HgBookmarksListDialog</b>(<i>vcs, parent=None</i>)
106 <p>
107 Constructor
108 </p><dl>
109 <dt><i>vcs</i></dt>
110 <dd>
111 reference to the vcs object
112 </dd><dt><i>parent</i></dt>
113 <dd>
114 parent widget (QWidget)
115 </dd>
116 </dl><a NAME="HgBookmarksListDialog.__finish" ID="HgBookmarksListDialog.__finish"></a>
117 <h4>HgBookmarksListDialog.__finish</h4>
118 <b>__finish</b>(<i></i>)
119 <p>
120 Private slot called when the process finished or the user pressed the button.
121 </p><a NAME="HgBookmarksListDialog.__generateItem" ID="HgBookmarksListDialog.__generateItem"></a>
122 <h4>HgBookmarksListDialog.__generateItem</h4>
123 <b>__generateItem</b>(<i>revision, changeset, status, name</i>)
124 <p>
125 Private method to generate a bookmark item in the bookmarks list.
126 </p><dl>
127 <dt><i>revision</i></dt>
128 <dd>
129 revision of the bookmark (string)
130 </dd><dt><i>changeset</i></dt>
131 <dd>
132 changeset of the bookmark (string)
133 </dd><dt><i>status</i></dt>
134 <dd>
135 of the bookmark (string)
136 </dd><dt><i>name</i></dt>
137 <dd>
138 name of the bookmark (string)
139 </dd>
140 </dl><a NAME="HgBookmarksListDialog.__procFinished" ID="HgBookmarksListDialog.__procFinished"></a>
141 <h4>HgBookmarksListDialog.__procFinished</h4>
142 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
143 <p>
144 Private slot connected to the finished signal.
145 </p><dl>
146 <dt><i>exitCode</i></dt>
147 <dd>
148 exit code of the process (integer)
149 </dd><dt><i>exitStatus</i></dt>
150 <dd>
151 exit status of the process (QProcess.ExitStatus)
152 </dd>
153 </dl><a NAME="HgBookmarksListDialog.__readStderr" ID="HgBookmarksListDialog.__readStderr"></a>
154 <h4>HgBookmarksListDialog.__readStderr</h4>
155 <b>__readStderr</b>(<i></i>)
156 <p>
157 Private slot to handle the readyReadStderr signal.
158 </p><p>
159 It reads the error output of the process and inserts it into the
160 error pane.
161 </p><a NAME="HgBookmarksListDialog.__readStdout" ID="HgBookmarksListDialog.__readStdout"></a>
162 <h4>HgBookmarksListDialog.__readStdout</h4>
163 <b>__readStdout</b>(<i></i>)
164 <p>
165 Private slot to handle the readyReadStdout signal.
166 </p><p>
167 It reads the output of the process, formats it and inserts it into
168 the contents pane.
169 </p><a NAME="HgBookmarksListDialog.__resizeColumns" ID="HgBookmarksListDialog.__resizeColumns"></a>
170 <h4>HgBookmarksListDialog.__resizeColumns</h4>
171 <b>__resizeColumns</b>(<i></i>)
172 <p>
173 Private method to resize the list columns.
174 </p><a NAME="HgBookmarksListDialog.__resort" ID="HgBookmarksListDialog.__resort"></a>
175 <h4>HgBookmarksListDialog.__resort</h4>
176 <b>__resort</b>(<i></i>)
177 <p>
178 Private method to resort the tree.
179 </p><a NAME="HgBookmarksListDialog.closeEvent" ID="HgBookmarksListDialog.closeEvent"></a>
180 <h4>HgBookmarksListDialog.closeEvent</h4>
181 <b>closeEvent</b>(<i>e</i>)
182 <p>
183 Private slot implementing a close event handler.
184 </p><dl>
185 <dt><i>e</i></dt>
186 <dd>
187 close event (QCloseEvent)
188 </dd>
189 </dl><a NAME="HgBookmarksListDialog.keyPressEvent" ID="HgBookmarksListDialog.keyPressEvent"></a>
190 <h4>HgBookmarksListDialog.keyPressEvent</h4>
191 <b>keyPressEvent</b>(<i>evt</i>)
192 <p>
193 Protected slot to handle a key press event.
194 </p><dl>
195 <dt><i>evt</i></dt>
196 <dd>
197 the key press event (QKeyEvent)
198 </dd>
199 </dl><a NAME="HgBookmarksListDialog.on_buttonBox_clicked" ID="HgBookmarksListDialog.on_buttonBox_clicked"></a>
200 <h4>HgBookmarksListDialog.on_buttonBox_clicked</h4>
201 <b>on_buttonBox_clicked</b>(<i>button</i>)
202 <p>
203 Private slot called by a button of the button box clicked.
204 </p><dl>
205 <dt><i>button</i></dt>
206 <dd>
207 button that was clicked (QAbstractButton)
208 </dd>
209 </dl><a NAME="HgBookmarksListDialog.on_input_returnPressed" ID="HgBookmarksListDialog.on_input_returnPressed"></a>
210 <h4>HgBookmarksListDialog.on_input_returnPressed</h4>
211 <b>on_input_returnPressed</b>(<i></i>)
212 <p>
213 Private slot to handle the press of the return key in the input field.
214 </p><a NAME="HgBookmarksListDialog.on_passwordCheckBox_toggled" ID="HgBookmarksListDialog.on_passwordCheckBox_toggled"></a>
215 <h4>HgBookmarksListDialog.on_passwordCheckBox_toggled</h4>
216 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
217 <p>
218 Private slot to handle the password checkbox toggled.
219 </p><dl>
220 <dt><i>isOn</i></dt>
221 <dd>
222 flag indicating the status of the check box (boolean)
223 </dd>
224 </dl><a NAME="HgBookmarksListDialog.on_sendButton_clicked" ID="HgBookmarksListDialog.on_sendButton_clicked"></a>
225 <h4>HgBookmarksListDialog.on_sendButton_clicked</h4>
226 <b>on_sendButton_clicked</b>(<i></i>)
227 <p>
228 Private slot to send the input to the subversion process.
229 </p><a NAME="HgBookmarksListDialog.start" ID="HgBookmarksListDialog.start"></a>
230 <h4>HgBookmarksListDialog.start</h4>
231 <b>start</b>(<i>path, bookmarksList</i>)
232 <p>
233 Public slot to start the bookmarks command.
234 </p><dl>
235 <dt><i>path</i></dt>
236 <dd>
237 name of directory to be listed (string)
238 </dd><dt><i>bookmarksList</i></dt>
239 <dd>
240 reference to string list receiving the bookmarks
241 (list of strings)
242 </dd>
243 </dl>
244 <div align="right"><a href="#top">Up</a></div>
245 <hr />
246 </body></html>

Mercurial Repository: eric

eric ide

mercurial