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