Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.QueuesExtension.HgQueuesListDialog.html

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

eric ide

mercurial