Sat, 26 Jan 2013 12:44:46 +0100
Regenerated the source docu with the HTML5 generator.
2374
f78ee0e8f96c
Regenerated the source docu with the HTML5 generator.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
1689
diff
changeset
|
1 | <!DOCTYPE html> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <html><head> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | <title>eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusMonitorThread</title> |
2374
f78ee0e8f96c
Regenerated the source docu with the HTML5 generator.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
1689
diff
changeset
|
4 | <meta charset="UTF-8"> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
5 | <style> |
21
b88a0e6268bd
Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
6 | body { |
440
69ace3e2dcf6
Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
409
diff
changeset
|
7 | background: #EDECE6; |
21
b88a0e6268bd
Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
8 | margin: 0em 1em 10em 1em; |
b88a0e6268bd
Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
9 | color: black; |
b88a0e6268bd
Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
10 | } |
b88a0e6268bd
Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
11 | |
409
0ea528e80202
Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
249
diff
changeset
|
12 | h1 { color: white; background: #85774A; } |
0ea528e80202
Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
249
diff
changeset
|
13 | h2 { color: white; background: #85774A; } |
440
69ace3e2dcf6
Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
409
diff
changeset
|
14 | h3 { color: white; background: #9D936E; } |
69ace3e2dcf6
Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
409
diff
changeset
|
15 | h4 { color: white; background: #9D936E; } |
21
b88a0e6268bd
Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
16 | |
440
69ace3e2dcf6
Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
409
diff
changeset
|
17 | a { color: #BA6D36; } |
21
b88a0e6268bd
Fixed a bug in eric5-doc.py and regenerated docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
17
diff
changeset
|
18 | |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | </style> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | </head> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | <body><a NAME="top" ID="top"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | <h1>eric5.Plugins.VcsPlugins.vcsSubversion.SvnStatusMonitorThread</h1> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
24 | Module implementing the VCS status monitor thread class for Subversion. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | </p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | <h3>Global Attributes</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | <tr><td>None</td></tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | <h3>Classes</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | <tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | <td><a href="#SvnStatusMonitorThread">SvnStatusMonitorThread</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
34 | <td>Class implementing the VCS status monitor thread class for Subversion.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
35 | </tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | <h3>Functions</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | <tr><td>None</td></tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | </table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | <hr /><hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | <a NAME="SvnStatusMonitorThread" ID="SvnStatusMonitorThread"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | <h2>SvnStatusMonitorThread</h2> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
44 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
45 | Class implementing the VCS status monitor thread class for Subversion. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
46 | </p> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
47 | <h3>Derived from</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
48 | VcsStatusMonitorThread |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
49 | <h3>Class Attributes</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
50 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
51 | <tr><td>None</td></tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
52 | </table> |
1228
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
945
diff
changeset
|
53 | <h3>Class Methods</h3> |
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
945
diff
changeset
|
54 | <table> |
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
945
diff
changeset
|
55 | <tr><td>None</td></tr> |
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
945
diff
changeset
|
56 | </table> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
57 | <h3>Methods</h3> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58 | <table> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
59 | <tr> |
1229
a8207dc73672
Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
1228
diff
changeset
|
60 | <td><a href="#SvnStatusMonitorThread.__init__">SvnStatusMonitorThread</a></td> |
a8207dc73672
Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
1228
diff
changeset
|
61 | <td>Constructor</td> |
a8207dc73672
Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
1228
diff
changeset
|
62 | </tr><tr> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
63 | <td><a href="#SvnStatusMonitorThread._performMonitor">_performMonitor</a></td> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
64 | <td>Protected method implementing the monitoring action.</td> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | </tr> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | </table> |
1228
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
945
diff
changeset
|
67 | <h3>Static Methods</h3> |
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
945
diff
changeset
|
68 | <table> |
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
945
diff
changeset
|
69 | <tr><td>None</td></tr> |
7afaf2fca55b
Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
945
diff
changeset
|
70 | </table> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
71 | <a NAME="SvnStatusMonitorThread.__init__" ID="SvnStatusMonitorThread.__init__"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
72 | <h4>SvnStatusMonitorThread (Constructor)</h4> |
945
8cd4d08fa9f6
Made code mostly PEP 8 compliant (except all whitespace and line length).
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
440
diff
changeset
|
73 | <b>SvnStatusMonitorThread</b>(<i>interval, project, vcs, parent=None</i>) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
74 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
75 | Constructor |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
76 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
77 | <dt><i>interval</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
78 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
79 | new interval in seconds (integer) |
249
52df4455a035
Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
110
diff
changeset
|
80 | </dd><dt><i>project</i></dt> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
81 | <dd> |
249
52df4455a035
Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
110
diff
changeset
|
82 | reference to the project object (Project) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
83 | </dd><dt><i>vcs</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
84 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
85 | reference to the version control object |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
86 | </dd><dt><i>parent</i></dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
87 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
88 | reference to the parent object (QObject) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
89 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
90 | </dl><a NAME="SvnStatusMonitorThread._performMonitor" ID="SvnStatusMonitorThread._performMonitor"></a> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
91 | <h4>SvnStatusMonitorThread._performMonitor</h4> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
92 | <b>_performMonitor</b>(<i></i>) |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
93 | <p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
94 | Protected method implementing the monitoring action. |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
95 | </p><p> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
96 | This method populates the statusList member variable |
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
97 | with a list of strings giving the status in the first column and the |
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
98 | path relative to the project directory starting with the third column. |
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
99 | The allowed status flags are: |
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
100 | <ul> |
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
101 | <li>"A" path was added but not yet comitted</li> |
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
102 | <li>"M" path has local changes</li> |
1689
2d007a789078
Updated source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
1229
diff
changeset
|
103 | <li>"O" path was removed</li> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
104 | <li>"R" path was deleted and then re-added</li> |
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
105 | <li>"U" path needs an update</li> |
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
106 | <li>"Z" path contains a conflict</li> |
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
107 | <li>" " path is back at normal</li> |
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
108 | </ul> |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
109 | </p><dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
110 | <dt>Returns:</dt> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
111 | <dd> |
58
37f0444c3479
Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
21
diff
changeset
|
112 | tuple of flag indicating successful operation (boolean) and |
110
c9a969db1469
Fixed doc string still containing QString and QStringList.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
58
diff
changeset
|
113 | a status message in case of non successful operation (string) |
17
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
114 | </dd> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
115 | </dl> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
116 | <div align="right"><a href="#top">Up</a></div> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
117 | <hr /> |
edde1fe80b3e
Updated documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
118 | </body></html> |