|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.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><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.Plugins.VcsPlugins.vcsSubversion.SvnPropListDialog</h1> |
|
23 <p> |
|
24 Module implementing a dialog to show the output of the svn proplist command |
|
25 process. |
|
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="#SvnPropListDialog">SvnPropListDialog</a></td> |
|
35 <td>Class implementing a dialog to show the output of the svn proplist command process.</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="SvnPropListDialog" ID="SvnPropListDialog"></a> |
|
44 <h2>SvnPropListDialog</h2> |
|
45 <p> |
|
46 Class implementing a dialog to show the output of the svn proplist command |
|
47 process. |
|
48 </p> |
|
49 <h3>Derived from</h3> |
|
50 QWidget, Ui_SvnPropListDialog |
|
51 <h3>Class Attributes</h3> |
|
52 <table> |
|
53 <tr><td>None</td></tr> |
|
54 </table> |
|
55 <h3>Class Methods</h3> |
|
56 <table> |
|
57 <tr><td>None</td></tr> |
|
58 </table> |
|
59 <h3>Methods</h3> |
|
60 <table> |
|
61 <tr> |
|
62 <td><a href="#SvnPropListDialog.__init__">SvnPropListDialog</a></td> |
|
63 <td>Constructor</td> |
|
64 </tr><tr> |
|
65 <td><a href="#SvnPropListDialog.__finish">__finish</a></td> |
|
66 <td>Private slot called when the process finished or the user pressed the button.</td> |
|
67 </tr><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><tr> |
|
71 <td><a href="#SvnPropListDialog.__procFinished">__procFinished</a></td> |
|
72 <td>Private slot connected to the finished signal.</td> |
|
73 </tr><tr> |
|
74 <td><a href="#SvnPropListDialog.__readStderr">__readStderr</a></td> |
|
75 <td>Private slot to handle the readyReadStandardError signal.</td> |
|
76 </tr><tr> |
|
77 <td><a href="#SvnPropListDialog.__readStdout">__readStdout</a></td> |
|
78 <td>Private slot to handle the readyReadStandardOutput signal.</td> |
|
79 </tr><tr> |
|
80 <td><a href="#SvnPropListDialog.__resizeColumns">__resizeColumns</a></td> |
|
81 <td>Private method to resize the list columns.</td> |
|
82 </tr><tr> |
|
83 <td><a href="#SvnPropListDialog.__resort">__resort</a></td> |
|
84 <td>Private method to resort the tree.</td> |
|
85 </tr><tr> |
|
86 <td><a href="#SvnPropListDialog.closeEvent">closeEvent</a></td> |
|
87 <td>Protected slot implementing a close event handler.</td> |
|
88 </tr><tr> |
|
89 <td><a href="#SvnPropListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
90 <td>Private slot called by a button of the button box clicked.</td> |
|
91 </tr><tr> |
|
92 <td><a href="#SvnPropListDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td> |
|
93 <td>Private slot to refresh the status display.</td> |
|
94 </tr><tr> |
|
95 <td><a href="#SvnPropListDialog.start">start</a></td> |
|
96 <td>Public slot to start the svn status command.</td> |
|
97 </tr> |
|
98 </table> |
|
99 <h3>Static Methods</h3> |
|
100 <table> |
|
101 <tr><td>None</td></tr> |
|
102 </table> |
|
103 <a NAME="SvnPropListDialog.__init__" ID="SvnPropListDialog.__init__"></a> |
|
104 <h4>SvnPropListDialog (Constructor)</h4> |
|
105 <b>SvnPropListDialog</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="SvnPropListDialog.__finish" ID="SvnPropListDialog.__finish"></a> |
|
117 <h4>SvnPropListDialog.__finish</h4> |
|
118 <b>__finish</b>(<i></i>) |
|
119 <p> |
|
120 Private slot called when the process finished or the user pressed the |
|
121 button. |
|
122 </p><a NAME="SvnPropListDialog.__generateItem" ID="SvnPropListDialog.__generateItem"></a> |
|
123 <h4>SvnPropListDialog.__generateItem</h4> |
|
124 <b>__generateItem</b>(<i>path, propName, propValue</i>) |
|
125 <p> |
|
126 Private method to generate a properties item in the properties list. |
|
127 </p><dl> |
|
128 <dt><i>path</i></dt> |
|
129 <dd> |
|
130 file/directory name the property applies to (string) |
|
131 </dd><dt><i>propName</i></dt> |
|
132 <dd> |
|
133 name of the property (string) |
|
134 </dd><dt><i>propValue</i></dt> |
|
135 <dd> |
|
136 value of the property (string) |
|
137 </dd> |
|
138 </dl><a NAME="SvnPropListDialog.__procFinished" ID="SvnPropListDialog.__procFinished"></a> |
|
139 <h4>SvnPropListDialog.__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="SvnPropListDialog.__readStderr" ID="SvnPropListDialog.__readStderr"></a> |
|
152 <h4>SvnPropListDialog.__readStderr</h4> |
|
153 <b>__readStderr</b>(<i></i>) |
|
154 <p> |
|
155 Private slot to handle the readyReadStandardError 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="SvnPropListDialog.__readStdout" ID="SvnPropListDialog.__readStdout"></a> |
|
160 <h4>SvnPropListDialog.__readStdout</h4> |
|
161 <b>__readStdout</b>(<i></i>) |
|
162 <p> |
|
163 Private slot to handle the readyReadStandardOutput 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="SvnPropListDialog.__resizeColumns" ID="SvnPropListDialog.__resizeColumns"></a> |
|
168 <h4>SvnPropListDialog.__resizeColumns</h4> |
|
169 <b>__resizeColumns</b>(<i></i>) |
|
170 <p> |
|
171 Private method to resize the list columns. |
|
172 </p><a NAME="SvnPropListDialog.__resort" ID="SvnPropListDialog.__resort"></a> |
|
173 <h4>SvnPropListDialog.__resort</h4> |
|
174 <b>__resort</b>(<i></i>) |
|
175 <p> |
|
176 Private method to resort the tree. |
|
177 </p><a NAME="SvnPropListDialog.closeEvent" ID="SvnPropListDialog.closeEvent"></a> |
|
178 <h4>SvnPropListDialog.closeEvent</h4> |
|
179 <b>closeEvent</b>(<i>e</i>) |
|
180 <p> |
|
181 Protected 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="SvnPropListDialog.on_buttonBox_clicked" ID="SvnPropListDialog.on_buttonBox_clicked"></a> |
|
188 <h4>SvnPropListDialog.on_buttonBox_clicked</h4> |
|
189 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
190 <p> |
|
191 Private slot called by a button of the button box clicked. |
|
192 </p><dl> |
|
193 <dt><i>button</i></dt> |
|
194 <dd> |
|
195 button that was clicked (QAbstractButton) |
|
196 </dd> |
|
197 </dl><a NAME="SvnPropListDialog.on_refreshButton_clicked" ID="SvnPropListDialog.on_refreshButton_clicked"></a> |
|
198 <h4>SvnPropListDialog.on_refreshButton_clicked</h4> |
|
199 <b>on_refreshButton_clicked</b>(<i></i>) |
|
200 <p> |
|
201 Private slot to refresh the status display. |
|
202 </p><a NAME="SvnPropListDialog.start" ID="SvnPropListDialog.start"></a> |
|
203 <h4>SvnPropListDialog.start</h4> |
|
204 <b>start</b>(<i>fn, recursive=False</i>) |
|
205 <p> |
|
206 Public slot to start the svn status command. |
|
207 </p><dl> |
|
208 <dt><i>fn</i></dt> |
|
209 <dd> |
|
210 filename(s) (string or list of string) |
|
211 </dd><dt><i>recursive</i></dt> |
|
212 <dd> |
|
213 flag indicating a recursive list is requested |
|
214 </dd> |
|
215 </dl> |
|
216 <div align="right"><a href="#top">Up</a></div> |
|
217 <hr /> |
|
218 </body></html> |