|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Plugins.VcsPlugins.vcsSubversion.SvnPropListDialog</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.Plugins.VcsPlugins.vcsSubversion.SvnPropListDialog</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing a dialog to show the output of the svn proplist command |
|
13 process. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 |
|
17 <table> |
|
18 <tr><td>None</td></tr> |
|
19 </table> |
|
20 <h3>Classes</h3> |
|
21 |
|
22 <table> |
|
23 |
|
24 <tr> |
|
25 <td><a href="#SvnPropListDialog">SvnPropListDialog</a></td> |
|
26 <td>Class implementing a dialog to show the output of the svn proplist command process.</td> |
|
27 </tr> |
|
28 </table> |
|
29 <h3>Functions</h3> |
|
30 |
|
31 <table> |
|
32 <tr><td>None</td></tr> |
|
33 </table> |
|
34 <hr /> |
|
35 <hr /> |
|
36 <a NAME="SvnPropListDialog" ID="SvnPropListDialog"></a> |
|
37 <h2>SvnPropListDialog</h2> |
|
38 |
|
39 <p> |
|
40 Class implementing a dialog to show the output of the svn proplist command |
|
41 process. |
|
42 </p> |
|
43 <h3>Derived from</h3> |
|
44 QWidget, Ui_SvnPropListDialog |
|
45 <h3>Class Attributes</h3> |
|
46 |
|
47 <table> |
|
48 <tr><td>None</td></tr> |
|
49 </table> |
|
50 <h3>Class Methods</h3> |
|
51 |
|
52 <table> |
|
53 <tr><td>None</td></tr> |
|
54 </table> |
|
55 <h3>Methods</h3> |
|
56 |
|
57 <table> |
|
58 |
|
59 <tr> |
|
60 <td><a href="#SvnPropListDialog.__init__">SvnPropListDialog</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr> |
|
63 <tr> |
|
64 <td><a href="#SvnPropListDialog.__finish">__finish</a></td> |
|
65 <td>Private slot called when the process finished or the user pressed the button.</td> |
|
66 </tr> |
|
67 <tr> |
|
68 <td><a href="#SvnPropListDialog.__generateItem">__generateItem</a></td> |
|
69 <td>Private method to generate a properties item in the properties list.</td> |
|
70 </tr> |
|
71 <tr> |
|
72 <td><a href="#SvnPropListDialog.__procFinished">__procFinished</a></td> |
|
73 <td>Private slot connected to the finished signal.</td> |
|
74 </tr> |
|
75 <tr> |
|
76 <td><a href="#SvnPropListDialog.__readStderr">__readStderr</a></td> |
|
77 <td>Private slot to handle the readyReadStandardError signal.</td> |
|
78 </tr> |
|
79 <tr> |
|
80 <td><a href="#SvnPropListDialog.__readStdout">__readStdout</a></td> |
|
81 <td>Private slot to handle the readyReadStandardOutput signal.</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#SvnPropListDialog.__resizeColumns">__resizeColumns</a></td> |
|
85 <td>Private method to resize the list columns.</td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td><a href="#SvnPropListDialog.__resort">__resort</a></td> |
|
89 <td>Private method to resort the tree.</td> |
|
90 </tr> |
|
91 <tr> |
|
92 <td><a href="#SvnPropListDialog.closeEvent">closeEvent</a></td> |
|
93 <td>Protected slot implementing a close event handler.</td> |
|
94 </tr> |
|
95 <tr> |
|
96 <td><a href="#SvnPropListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
97 <td>Private slot called by a button of the button box clicked.</td> |
|
98 </tr> |
|
99 <tr> |
|
100 <td><a href="#SvnPropListDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> |
|
101 <td>Private slot to refresh the status display.</td> |
|
102 </tr> |
|
103 <tr> |
|
104 <td><a href="#SvnPropListDialog.start">start</a></td> |
|
105 <td>Public slot to start the svn status command.</td> |
|
106 </tr> |
|
107 </table> |
|
108 <h3>Static Methods</h3> |
|
109 |
|
110 <table> |
|
111 <tr><td>None</td></tr> |
|
112 </table> |
|
113 |
|
114 <a NAME="SvnPropListDialog.__init__" ID="SvnPropListDialog.__init__"></a> |
|
115 <h4>SvnPropListDialog (Constructor)</h4> |
|
116 <b>SvnPropListDialog</b>(<i>vcs, parent=None</i>) |
|
117 |
|
118 <p> |
|
119 Constructor |
|
120 </p> |
|
121 <dl> |
|
122 |
|
123 <dt><i>vcs</i></dt> |
|
124 <dd> |
|
125 reference to the vcs object |
|
126 </dd> |
|
127 <dt><i>parent</i></dt> |
|
128 <dd> |
|
129 parent widget (QWidget) |
|
130 </dd> |
|
131 </dl> |
|
132 <a NAME="SvnPropListDialog.__finish" ID="SvnPropListDialog.__finish"></a> |
|
133 <h4>SvnPropListDialog.__finish</h4> |
|
134 <b>__finish</b>(<i></i>) |
|
135 |
|
136 <p> |
|
137 Private slot called when the process finished or the user pressed the |
|
138 button. |
|
139 </p> |
|
140 <a NAME="SvnPropListDialog.__generateItem" ID="SvnPropListDialog.__generateItem"></a> |
|
141 <h4>SvnPropListDialog.__generateItem</h4> |
|
142 <b>__generateItem</b>(<i>path, propName, propValue</i>) |
|
143 |
|
144 <p> |
|
145 Private method to generate a properties item in the properties list. |
|
146 </p> |
|
147 <dl> |
|
148 |
|
149 <dt><i>path</i></dt> |
|
150 <dd> |
|
151 file/directory name the property applies to (string) |
|
152 </dd> |
|
153 <dt><i>propName</i></dt> |
|
154 <dd> |
|
155 name of the property (string) |
|
156 </dd> |
|
157 <dt><i>propValue</i></dt> |
|
158 <dd> |
|
159 value of the property (string) |
|
160 </dd> |
|
161 </dl> |
|
162 <a NAME="SvnPropListDialog.__procFinished" ID="SvnPropListDialog.__procFinished"></a> |
|
163 <h4>SvnPropListDialog.__procFinished</h4> |
|
164 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) |
|
165 |
|
166 <p> |
|
167 Private slot connected to the finished signal. |
|
168 </p> |
|
169 <dl> |
|
170 |
|
171 <dt><i>exitCode</i></dt> |
|
172 <dd> |
|
173 exit code of the process (integer) |
|
174 </dd> |
|
175 <dt><i>exitStatus</i></dt> |
|
176 <dd> |
|
177 exit status of the process (QProcess.ExitStatus) |
|
178 </dd> |
|
179 </dl> |
|
180 <a NAME="SvnPropListDialog.__readStderr" ID="SvnPropListDialog.__readStderr"></a> |
|
181 <h4>SvnPropListDialog.__readStderr</h4> |
|
182 <b>__readStderr</b>(<i></i>) |
|
183 |
|
184 <p> |
|
185 Private slot to handle the readyReadStandardError signal. |
|
186 </p> |
|
187 <p> |
|
188 It reads the error output of the process and inserts it into the |
|
189 error pane. |
|
190 </p> |
|
191 <a NAME="SvnPropListDialog.__readStdout" ID="SvnPropListDialog.__readStdout"></a> |
|
192 <h4>SvnPropListDialog.__readStdout</h4> |
|
193 <b>__readStdout</b>(<i></i>) |
|
194 |
|
195 <p> |
|
196 Private slot to handle the readyReadStandardOutput signal. |
|
197 </p> |
|
198 <p> |
|
199 It reads the output of the process, formats it and inserts it into |
|
200 the contents pane. |
|
201 </p> |
|
202 <a NAME="SvnPropListDialog.__resizeColumns" ID="SvnPropListDialog.__resizeColumns"></a> |
|
203 <h4>SvnPropListDialog.__resizeColumns</h4> |
|
204 <b>__resizeColumns</b>(<i></i>) |
|
205 |
|
206 <p> |
|
207 Private method to resize the list columns. |
|
208 </p> |
|
209 <a NAME="SvnPropListDialog.__resort" ID="SvnPropListDialog.__resort"></a> |
|
210 <h4>SvnPropListDialog.__resort</h4> |
|
211 <b>__resort</b>(<i></i>) |
|
212 |
|
213 <p> |
|
214 Private method to resort the tree. |
|
215 </p> |
|
216 <a NAME="SvnPropListDialog.closeEvent" ID="SvnPropListDialog.closeEvent"></a> |
|
217 <h4>SvnPropListDialog.closeEvent</h4> |
|
218 <b>closeEvent</b>(<i>e</i>) |
|
219 |
|
220 <p> |
|
221 Protected slot implementing a close event handler. |
|
222 </p> |
|
223 <dl> |
|
224 |
|
225 <dt><i>e</i></dt> |
|
226 <dd> |
|
227 close event (QCloseEvent) |
|
228 </dd> |
|
229 </dl> |
|
230 <a NAME="SvnPropListDialog.on_buttonBox_clicked" ID="SvnPropListDialog.on_buttonBox_clicked"></a> |
|
231 <h4>SvnPropListDialog.on_buttonBox_clicked</h4> |
|
232 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
233 |
|
234 <p> |
|
235 Private slot called by a button of the button box clicked. |
|
236 </p> |
|
237 <dl> |
|
238 |
|
239 <dt><i>button</i></dt> |
|
240 <dd> |
|
241 button that was clicked (QAbstractButton) |
|
242 </dd> |
|
243 </dl> |
|
244 <a NAME="SvnPropListDialog.on_refreshButton_clicked" ID="SvnPropListDialog.on_refreshButton_clicked"></a> |
|
245 <h4>SvnPropListDialog.on_refreshButton_clicked</h4> |
|
246 <b>on_refreshButton_clicked</b>(<i></i>) |
|
247 |
|
248 <p> |
|
249 Private slot to refresh the status display. |
|
250 </p> |
|
251 <a NAME="SvnPropListDialog.start" ID="SvnPropListDialog.start"></a> |
|
252 <h4>SvnPropListDialog.start</h4> |
|
253 <b>start</b>(<i>fn, recursive=False</i>) |
|
254 |
|
255 <p> |
|
256 Public slot to start the svn status command. |
|
257 </p> |
|
258 <dl> |
|
259 |
|
260 <dt><i>fn</i></dt> |
|
261 <dd> |
|
262 filename(s) (string or list of string) |
|
263 </dd> |
|
264 <dt><i>recursive</i></dt> |
|
265 <dd> |
|
266 flag indicating a recursive list is requested |
|
267 </dd> |
|
268 </dl> |
|
269 <div align="right"><a href="#top">Up</a></div> |
|
270 <hr /> |
|
271 </body></html> |