|
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.vcsSubversion.SvnPropListDialog</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Plugins.VcsPlugins.vcsSubversion.SvnPropListDialog</h1> |
|
12 <p> |
|
13 Module implementing a dialog to show the output of the svn proplist command process. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#SvnPropListDialog">SvnPropListDialog</a></td> |
|
23 <td>Class implementing a dialog to show the output of the svn proplist command process.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="SvnPropListDialog" ID="SvnPropListDialog"></a> |
|
32 <h2>SvnPropListDialog</h2> |
|
33 <p> |
|
34 Class implementing a dialog to show the output of the svn proplist command process. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 QWidget, Ui_SvnPropListDialog |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#SvnPropListDialog.__init__">SvnPropListDialog</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#SvnPropListDialog.__finish">__finish</a></td> |
|
49 <td>Private slot called when the process finished or the user pressed the button.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#SvnPropListDialog.__generateItem">__generateItem</a></td> |
|
52 <td>Private method to generate a properties item in the properties list.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#SvnPropListDialog.__procFinished">__procFinished</a></td> |
|
55 <td>Private slot connected to the finished signal.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#SvnPropListDialog.__readStderr">__readStderr</a></td> |
|
58 <td>Private slot to handle the readyReadStandardError signal.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#SvnPropListDialog.__readStdout">__readStdout</a></td> |
|
61 <td>Private slot to handle the readyReadStandardOutput signal.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#SvnPropListDialog.__resizeColumns">__resizeColumns</a></td> |
|
64 <td>Private method to resize the list columns.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#SvnPropListDialog.__resort">__resort</a></td> |
|
67 <td>Private method to resort the tree.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#SvnPropListDialog.closeEvent">closeEvent</a></td> |
|
70 <td>Private slot implementing a close event handler.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#SvnPropListDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
73 <td>Private slot called by a button of the button box clicked.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#SvnPropListDialog.start">start</a></td> |
|
76 <td>Public slot to start the svn status command.</td> |
|
77 </tr> |
|
78 </table> |
|
79 <a NAME="SvnPropListDialog.__init__" ID="SvnPropListDialog.__init__"></a> |
|
80 <h4>SvnPropListDialog (Constructor)</h4> |
|
81 <b>SvnPropListDialog</b>(<i>vcs, parent = None</i>) |
|
82 <p> |
|
83 Constructor |
|
84 </p><dl> |
|
85 <dt><i>vcs</i></dt> |
|
86 <dd> |
|
87 reference to the vcs object |
|
88 </dd><dt><i>parent</i></dt> |
|
89 <dd> |
|
90 parent widget (QWidget) |
|
91 </dd> |
|
92 </dl><a NAME="SvnPropListDialog.__finish" ID="SvnPropListDialog.__finish"></a> |
|
93 <h4>SvnPropListDialog.__finish</h4> |
|
94 <b>__finish</b>(<i></i>) |
|
95 <p> |
|
96 Private slot called when the process finished or the user pressed the button. |
|
97 </p><a NAME="SvnPropListDialog.__generateItem" ID="SvnPropListDialog.__generateItem"></a> |
|
98 <h4>SvnPropListDialog.__generateItem</h4> |
|
99 <b>__generateItem</b>(<i>path, propName, propValue</i>) |
|
100 <p> |
|
101 Private method to generate a properties item in the properties list. |
|
102 </p><dl> |
|
103 <dt><i>path</i></dt> |
|
104 <dd> |
|
105 file/directory name the property applies to (string or QString) |
|
106 </dd><dt><i>propName</i></dt> |
|
107 <dd> |
|
108 name of the property (string or QString) |
|
109 </dd><dt><i>propValue</i></dt> |
|
110 <dd> |
|
111 value of the property (string or QString) |
|
112 </dd> |
|
113 </dl><a NAME="SvnPropListDialog.__procFinished" ID="SvnPropListDialog.__procFinished"></a> |
|
114 <h4>SvnPropListDialog.__procFinished</h4> |
|
115 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) |
|
116 <p> |
|
117 Private slot connected to the finished signal. |
|
118 </p><dl> |
|
119 <dt><i>exitCode</i></dt> |
|
120 <dd> |
|
121 exit code of the process (integer) |
|
122 </dd><dt><i>exitStatus</i></dt> |
|
123 <dd> |
|
124 exit status of the process (QProcess.ExitStatus) |
|
125 </dd> |
|
126 </dl><a NAME="SvnPropListDialog.__readStderr" ID="SvnPropListDialog.__readStderr"></a> |
|
127 <h4>SvnPropListDialog.__readStderr</h4> |
|
128 <b>__readStderr</b>(<i></i>) |
|
129 <p> |
|
130 Private slot to handle the readyReadStandardError signal. |
|
131 </p><p> |
|
132 It reads the error output of the process and inserts it into the |
|
133 error pane. |
|
134 </p><a NAME="SvnPropListDialog.__readStdout" ID="SvnPropListDialog.__readStdout"></a> |
|
135 <h4>SvnPropListDialog.__readStdout</h4> |
|
136 <b>__readStdout</b>(<i></i>) |
|
137 <p> |
|
138 Private slot to handle the readyReadStandardOutput signal. |
|
139 </p><p> |
|
140 It reads the output of the process, formats it and inserts it into |
|
141 the contents pane. |
|
142 </p><a NAME="SvnPropListDialog.__resizeColumns" ID="SvnPropListDialog.__resizeColumns"></a> |
|
143 <h4>SvnPropListDialog.__resizeColumns</h4> |
|
144 <b>__resizeColumns</b>(<i></i>) |
|
145 <p> |
|
146 Private method to resize the list columns. |
|
147 </p><a NAME="SvnPropListDialog.__resort" ID="SvnPropListDialog.__resort"></a> |
|
148 <h4>SvnPropListDialog.__resort</h4> |
|
149 <b>__resort</b>(<i></i>) |
|
150 <p> |
|
151 Private method to resort the tree. |
|
152 </p><a NAME="SvnPropListDialog.closeEvent" ID="SvnPropListDialog.closeEvent"></a> |
|
153 <h4>SvnPropListDialog.closeEvent</h4> |
|
154 <b>closeEvent</b>(<i>e</i>) |
|
155 <p> |
|
156 Private slot implementing a close event handler. |
|
157 </p><dl> |
|
158 <dt><i>e</i></dt> |
|
159 <dd> |
|
160 close event (QCloseEvent) |
|
161 </dd> |
|
162 </dl><a NAME="SvnPropListDialog.on_buttonBox_clicked" ID="SvnPropListDialog.on_buttonBox_clicked"></a> |
|
163 <h4>SvnPropListDialog.on_buttonBox_clicked</h4> |
|
164 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
165 <p> |
|
166 Private slot called by a button of the button box clicked. |
|
167 </p><dl> |
|
168 <dt><i>button</i></dt> |
|
169 <dd> |
|
170 button that was clicked (QAbstractButton) |
|
171 </dd> |
|
172 </dl><a NAME="SvnPropListDialog.start" ID="SvnPropListDialog.start"></a> |
|
173 <h4>SvnPropListDialog.start</h4> |
|
174 <b>start</b>(<i>fn, recursive = False</i>) |
|
175 <p> |
|
176 Public slot to start the svn status command. |
|
177 </p><dl> |
|
178 <dt><i>fn</i></dt> |
|
179 <dd> |
|
180 filename(s) (string or list of string) |
|
181 </dd><dt><i>recursive</i></dt> |
|
182 <dd> |
|
183 flag indicating a recursive list is requested |
|
184 </dd> |
|
185 </dl> |
|
186 <div align="right"><a href="#top">Up</a></div> |
|
187 <hr /> |
|
188 </body></html> |