src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread.html

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread</h1>
10
11 <p> 10 <p>
12 Module implementing the VCS status monitor thread class for Git. 11 Module implementing the VCS status monitor thread class for Git.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#GitStatusMonitorThread">GitStatusMonitorThread</a></td> 22 <td><a href="#GitStatusMonitorThread">GitStatusMonitorThread</a></td>
25 <td>Class implementing the VCS status monitor thread class for Git.</td> 23 <td>Class implementing the VCS status monitor thread class for Git.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="GitStatusMonitorThread" ID="GitStatusMonitorThread"></a> 34 <a NAME="GitStatusMonitorThread" ID="GitStatusMonitorThread"></a>
36 <h2>GitStatusMonitorThread</h2> 35 <h2>GitStatusMonitorThread</h2>
37
38 <p> 36 <p>
39 Class implementing the VCS status monitor thread class for Git. 37 Class implementing the VCS status monitor thread class for Git.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 VcsStatusMonitorThread 41 VcsStatusMonitorThread
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <table>
46 <tr><td>ConflictStates</td></tr> 44 <tr><td>ConflictStates</td></tr>
47 </table> 45 </table>
46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49
50 <table> 48 <table>
51 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
52 </table> 50 </table>
51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54
55 <table> 53 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#GitStatusMonitorThread.__init__">GitStatusMonitorThread</a></td> 55 <td><a href="#GitStatusMonitorThread.__init__">GitStatusMonitorThread</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
69 <tr> 66 <tr>
70 <td><a href="#GitStatusMonitorThread._shutdown">_shutdown</a></td> 67 <td><a href="#GitStatusMonitorThread._shutdown">_shutdown</a></td>
71 <td>Protected method performing shutdown actions.</td> 68 <td>Protected method performing shutdown actions.</td>
72 </tr> 69 </tr>
73 </table> 70 </table>
71
74 <h3>Static Methods</h3> 72 <h3>Static Methods</h3>
75
76 <table> 73 <table>
77 <tr><td>None</td></tr> 74 <tr><td>None</td></tr>
78 </table> 75 </table>
79 76
77
80 <a NAME="GitStatusMonitorThread.__init__" ID="GitStatusMonitorThread.__init__"></a> 78 <a NAME="GitStatusMonitorThread.__init__" ID="GitStatusMonitorThread.__init__"></a>
81 <h4>GitStatusMonitorThread (Constructor)</h4> 79 <h4>GitStatusMonitorThread (Constructor)</h4>
82 <b>GitStatusMonitorThread</b>(<i>interval, project, vcs, parent=None</i>) 80 <b>GitStatusMonitorThread</b>(<i>interval, project, vcs, parent=None</i>)
83
84 <p> 81 <p>
85 Constructor 82 Constructor
86 </p> 83 </p>
84
87 <dl> 85 <dl>
88 86
89 <dt><i>interval</i> (int)</dt> 87 <dt><i>interval</i> (int)</dt>
90 <dd> 88 <dd>
91 new interval in seconds 89 new interval in seconds
104 </dd> 102 </dd>
105 </dl> 103 </dl>
106 <a NAME="GitStatusMonitorThread._getInfo" ID="GitStatusMonitorThread._getInfo"></a> 104 <a NAME="GitStatusMonitorThread._getInfo" ID="GitStatusMonitorThread._getInfo"></a>
107 <h4>GitStatusMonitorThread._getInfo</h4> 105 <h4>GitStatusMonitorThread._getInfo</h4>
108 <b>_getInfo</b>(<i></i>) 106 <b>_getInfo</b>(<i></i>)
109
110 <p> 107 <p>
111 Protected method implementing the real info action. 108 Protected method implementing the real info action.
112 </p> 109 </p>
113 <p> 110 <p>
114 This method should be overridden and create a short info message to be 111 This method should be overridden and create a short info message to be
115 shown in the main window status bar right next to the status indicator. 112 shown in the main window status bar right next to the status indicator.
116 </p> 113 </p>
114
117 <dl> 115 <dl>
118 <dt>Return:</dt> 116 <dt>Return:</dt>
119 <dd> 117 <dd>
120 short info message 118 short info message
121 </dd> 119 </dd>
127 </dd> 125 </dd>
128 </dl> 126 </dl>
129 <a NAME="GitStatusMonitorThread._performMonitor" ID="GitStatusMonitorThread._performMonitor"></a> 127 <a NAME="GitStatusMonitorThread._performMonitor" ID="GitStatusMonitorThread._performMonitor"></a>
130 <h4>GitStatusMonitorThread._performMonitor</h4> 128 <h4>GitStatusMonitorThread._performMonitor</h4>
131 <b>_performMonitor</b>(<i></i>) 129 <b>_performMonitor</b>(<i></i>)
132
133 <p> 130 <p>
134 Protected method implementing the monitoring action. 131 Protected method implementing the monitoring action.
135 </p> 132 </p>
136 <p> 133 <p>
137 This method populates the statusList member variable 134 This method populates the statusList member variable
148 <li>"?" path is not tracked</li> 145 <li>"?" path is not tracked</li>
149 <li>"!" path is missing</li> 146 <li>"!" path is missing</li>
150 <li>" " path is back at normal</li> 147 <li>" " path is back at normal</li>
151 </ul> 148 </ul>
152 </p> 149 </p>
150
153 <dl> 151 <dl>
154 <dt>Return:</dt> 152 <dt>Return:</dt>
155 <dd> 153 <dd>
156 tuple of flag indicating successful operation and a status message 154 tuple of flag indicating successful operation and a status message
157 in case of non successful operation 155 in case of non successful operation
164 </dd> 162 </dd>
165 </dl> 163 </dl>
166 <a NAME="GitStatusMonitorThread._shutdown" ID="GitStatusMonitorThread._shutdown"></a> 164 <a NAME="GitStatusMonitorThread._shutdown" ID="GitStatusMonitorThread._shutdown"></a>
167 <h4>GitStatusMonitorThread._shutdown</h4> 165 <h4>GitStatusMonitorThread._shutdown</h4>
168 <b>_shutdown</b>(<i></i>) 166 <b>_shutdown</b>(<i></i>)
169
170 <p> 167 <p>
171 Protected method performing shutdown actions. 168 Protected method performing shutdown actions.
172 </p> 169 </p>
170
173 <div align="right"><a href="#top">Up</a></div> 171 <div align="right"><a href="#top">Up</a></div>
174 <hr /> 172 <hr />
175 </body></html> 173 </body></html>

eric ide

mercurial