Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.BookmarksExtension.HgBookmarksInOutDialog.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.HgBookmarksInOutDialog</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.HgBookmarksInOutDialog</h1>
24 <p>
25 Module implementing a dialog to show a list of incoming or outgoing 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="#HgBookmarksInOutDialog">HgBookmarksInOutDialog</a></td>
35 <td>Class implementing a dialog to show a list of incoming or outgoing 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="HgBookmarksInOutDialog" ID="HgBookmarksInOutDialog"></a>
44 <h2>HgBookmarksInOutDialog</h2>
45 <p>
46 Class implementing a dialog to show a list of incoming or outgoing 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>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#HgBookmarksInOutDialog.__init__">HgBookmarksInOutDialog</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#HgBookmarksInOutDialog.__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="#HgBookmarksInOutDialog.__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="#HgBookmarksInOutDialog.__procFinished">__procFinished</a></td>
67 <td>Private slot connected to the finished signal.</td>
68 </tr><tr>
69 <td><a href="#HgBookmarksInOutDialog.__readStderr">__readStderr</a></td>
70 <td>Private slot to handle the readyReadStderr signal.</td>
71 </tr><tr>
72 <td><a href="#HgBookmarksInOutDialog.__readStdout">__readStdout</a></td>
73 <td>Private slot to handle the readyReadStdout signal.</td>
74 </tr><tr>
75 <td><a href="#HgBookmarksInOutDialog.__resizeColumns">__resizeColumns</a></td>
76 <td>Private method to resize the list columns.</td>
77 </tr><tr>
78 <td><a href="#HgBookmarksInOutDialog.__resort">__resort</a></td>
79 <td>Private method to resort the tree.</td>
80 </tr><tr>
81 <td><a href="#HgBookmarksInOutDialog.closeEvent">closeEvent</a></td>
82 <td>Private slot implementing a close event handler.</td>
83 </tr><tr>
84 <td><a href="#HgBookmarksInOutDialog.keyPressEvent">keyPressEvent</a></td>
85 <td>Protected slot to handle a key press event.</td>
86 </tr><tr>
87 <td><a href="#HgBookmarksInOutDialog.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="#HgBookmarksInOutDialog.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="#HgBookmarksInOutDialog.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="#HgBookmarksInOutDialog.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="#HgBookmarksInOutDialog.start">start</a></td>
100 <td>Public slot to start the bookmarks command.</td>
101 </tr>
102 </table>
103 <a NAME="HgBookmarksInOutDialog.__init__" ID="HgBookmarksInOutDialog.__init__"></a>
104 <h4>HgBookmarksInOutDialog (Constructor)</h4>
105 <b>HgBookmarksInOutDialog</b>(<i>vcs, mode, 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>mode</i></dt>
113 <dd>
114 mode of the dialog (HgBookmarksInOutDialog.INCOMING,
115 HgBookmarksInOutDialog.OUTGOING)
116 </dd><dt><i>parent</i></dt>
117 <dd>
118 reference to the parent widget (QWidget)
119 </dd>
120 </dl><a NAME="HgBookmarksInOutDialog.__finish" ID="HgBookmarksInOutDialog.__finish"></a>
121 <h4>HgBookmarksInOutDialog.__finish</h4>
122 <b>__finish</b>(<i></i>)
123 <p>
124 Private slot called when the process finished or the user pressed the button.
125 </p><a NAME="HgBookmarksInOutDialog.__generateItem" ID="HgBookmarksInOutDialog.__generateItem"></a>
126 <h4>HgBookmarksInOutDialog.__generateItem</h4>
127 <b>__generateItem</b>(<i>changeset, name</i>)
128 <p>
129 Private method to generate a bookmark item in the bookmarks list.
130 </p><dl>
131 <dt><i>changeset</i></dt>
132 <dd>
133 changeset of the bookmark (string)
134 </dd><dt><i>name</i></dt>
135 <dd>
136 name of the bookmark (string)
137 </dd>
138 </dl><a NAME="HgBookmarksInOutDialog.__procFinished" ID="HgBookmarksInOutDialog.__procFinished"></a>
139 <h4>HgBookmarksInOutDialog.__procFinished</h4>
140 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
141 <p>
142 Private slot connected to the finished signal.
143 </p><dl>
144 <dt><i>exitCode</i></dt>
145 <dd>
146 exit code of the process (integer)
147 </dd><dt><i>exitStatus</i></dt>
148 <dd>
149 exit status of the process (QProcess.ExitStatus)
150 </dd>
151 </dl><a NAME="HgBookmarksInOutDialog.__readStderr" ID="HgBookmarksInOutDialog.__readStderr"></a>
152 <h4>HgBookmarksInOutDialog.__readStderr</h4>
153 <b>__readStderr</b>(<i></i>)
154 <p>
155 Private slot to handle the readyReadStderr signal.
156 </p><p>
157 It reads the error output of the process and inserts it into the
158 error pane.
159 </p><a NAME="HgBookmarksInOutDialog.__readStdout" ID="HgBookmarksInOutDialog.__readStdout"></a>
160 <h4>HgBookmarksInOutDialog.__readStdout</h4>
161 <b>__readStdout</b>(<i></i>)
162 <p>
163 Private slot to handle the readyReadStdout signal.
164 </p><p>
165 It reads the output of the process, formats it and inserts it into
166 the contents pane.
167 </p><a NAME="HgBookmarksInOutDialog.__resizeColumns" ID="HgBookmarksInOutDialog.__resizeColumns"></a>
168 <h4>HgBookmarksInOutDialog.__resizeColumns</h4>
169 <b>__resizeColumns</b>(<i></i>)
170 <p>
171 Private method to resize the list columns.
172 </p><a NAME="HgBookmarksInOutDialog.__resort" ID="HgBookmarksInOutDialog.__resort"></a>
173 <h4>HgBookmarksInOutDialog.__resort</h4>
174 <b>__resort</b>(<i></i>)
175 <p>
176 Private method to resort the tree.
177 </p><a NAME="HgBookmarksInOutDialog.closeEvent" ID="HgBookmarksInOutDialog.closeEvent"></a>
178 <h4>HgBookmarksInOutDialog.closeEvent</h4>
179 <b>closeEvent</b>(<i>e</i>)
180 <p>
181 Private slot implementing a close event handler.
182 </p><dl>
183 <dt><i>e</i></dt>
184 <dd>
185 close event (QCloseEvent)
186 </dd>
187 </dl><a NAME="HgBookmarksInOutDialog.keyPressEvent" ID="HgBookmarksInOutDialog.keyPressEvent"></a>
188 <h4>HgBookmarksInOutDialog.keyPressEvent</h4>
189 <b>keyPressEvent</b>(<i>evt</i>)
190 <p>
191 Protected slot to handle a key press event.
192 </p><dl>
193 <dt><i>evt</i></dt>
194 <dd>
195 the key press event (QKeyEvent)
196 </dd>
197 </dl><a NAME="HgBookmarksInOutDialog.on_buttonBox_clicked" ID="HgBookmarksInOutDialog.on_buttonBox_clicked"></a>
198 <h4>HgBookmarksInOutDialog.on_buttonBox_clicked</h4>
199 <b>on_buttonBox_clicked</b>(<i>button</i>)
200 <p>
201 Private slot called by a button of the button box clicked.
202 </p><dl>
203 <dt><i>button</i></dt>
204 <dd>
205 button that was clicked (QAbstractButton)
206 </dd>
207 </dl><a NAME="HgBookmarksInOutDialog.on_input_returnPressed" ID="HgBookmarksInOutDialog.on_input_returnPressed"></a>
208 <h4>HgBookmarksInOutDialog.on_input_returnPressed</h4>
209 <b>on_input_returnPressed</b>(<i></i>)
210 <p>
211 Private slot to handle the press of the return key in the input field.
212 </p><a NAME="HgBookmarksInOutDialog.on_passwordCheckBox_toggled" ID="HgBookmarksInOutDialog.on_passwordCheckBox_toggled"></a>
213 <h4>HgBookmarksInOutDialog.on_passwordCheckBox_toggled</h4>
214 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
215 <p>
216 Private slot to handle the password checkbox toggled.
217 </p><dl>
218 <dt><i>isOn</i></dt>
219 <dd>
220 flag indicating the status of the check box (boolean)
221 </dd>
222 </dl><a NAME="HgBookmarksInOutDialog.on_sendButton_clicked" ID="HgBookmarksInOutDialog.on_sendButton_clicked"></a>
223 <h4>HgBookmarksInOutDialog.on_sendButton_clicked</h4>
224 <b>on_sendButton_clicked</b>(<i></i>)
225 <p>
226 Private slot to send the input to the subversion process.
227 </p><a NAME="HgBookmarksInOutDialog.start" ID="HgBookmarksInOutDialog.start"></a>
228 <h4>HgBookmarksInOutDialog.start</h4>
229 <b>start</b>(<i>path</i>)
230 <p>
231 Public slot to start the bookmarks command.
232 </p><dl>
233 <dt><i>path</i></dt>
234 <dd>
235 name of directory to be listed (string)
236 </dd>
237 </dl>
238 <div align="right"><a href="#top">Up</a></div>
239 <hr />
240 </body></html>

Mercurial Repository: eric

eric ide

mercurial