Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8623
- fced5aa98d41
- child 10438
- 4cd7e5a8b3cf
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the VCS status monitor thread class for Git. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#GitStatusMonitorThread">GitStatusMonitorThread</a></td> | |
| 25 <td>Class implementing the VCS status monitor thread class for Git.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="GitStatusMonitorThread" ID="GitStatusMonitorThread"></a> | |
| 36 <h2>GitStatusMonitorThread</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the VCS status monitor thread class for Git. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 VcsStatusMonitorThread | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>ConflictStates</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#GitStatusMonitorThread.__init__">GitStatusMonitorThread</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#GitStatusMonitorThread._getInfo">_getInfo</a></td> | |
| 63 <td>Protected method implementing the real info action.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#GitStatusMonitorThread._performMonitor">_performMonitor</a></td> | |
| 67 <td>Protected method implementing the monitoring action.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#GitStatusMonitorThread._shutdown">_shutdown</a></td> | |
| 71 <td>Protected method performing shutdown actions.</td> | |
| 72 </tr> | |
| 73 </table> | |
| 74 <h3>Static Methods</h3> | |
| 75 | |
| 76 <table> | |
| 77 <tr><td>None</td></tr> | |
| 78 </table> | |
| 79 | |
| 80 <a NAME="GitStatusMonitorThread.__init__" ID="GitStatusMonitorThread.__init__"></a> | |
| 81 <h4>GitStatusMonitorThread (Constructor)</h4> | |
| 82 <b>GitStatusMonitorThread</b>(<i>interval, project, vcs, parent=None</i>) | |
| 83 | |
| 84 <p> | |
| 85 Constructor | |
| 86 </p> | |
| 87 <dl> | |
| 88 | |
| 89 <dt><i>interval</i></dt> | |
| 90 <dd> | |
| 91 new interval in seconds (integer) | |
| 92 </dd> | |
| 93 <dt><i>project</i></dt> | |
| 94 <dd> | |
| 95 reference to the project object (Project) | |
| 96 </dd> | |
| 97 <dt><i>vcs</i></dt> | |
| 98 <dd> | |
| 99 reference to the version control object | |
| 100 </dd> | |
| 101 <dt><i>parent</i></dt> | |
| 102 <dd> | |
| 103 reference to the parent object (QObject) | |
| 104 </dd> | |
| 105 </dl> | |
| 106 <a NAME="GitStatusMonitorThread._getInfo" ID="GitStatusMonitorThread._getInfo"></a> | |
| 107 <h4>GitStatusMonitorThread._getInfo</h4> | |
| 108 <b>_getInfo</b>(<i></i>) | |
| 109 | |
| 110 <p> | |
| 111 Protected method implementing the real info action. | |
| 112 </p> | |
| 113 <p> | |
| 114 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. | |
| 116 </p> | |
| 117 <dl> | |
| 118 <dt>Return:</dt> | |
| 119 <dd> | |
| 120 short info message | |
| 121 </dd> | |
| 122 </dl> | |
| 123 <dl> | |
| 124 <dt>Return Type:</dt> | |
| 125 <dd> | |
| 126 str | |
| 127 </dd> | |
| 128 </dl> | |
| 129 <a NAME="GitStatusMonitorThread._performMonitor" ID="GitStatusMonitorThread._performMonitor"></a> | |
| 130 <h4>GitStatusMonitorThread._performMonitor</h4> | |
| 131 <b>_performMonitor</b>(<i></i>) | |
| 132 | |
| 133 <p> | |
| 134 Protected method implementing the monitoring action. | |
| 135 </p> | |
| 136 <p> | |
| 137 This method populates the statusList member variable | |
| 138 with a list of strings giving the status in the first column and the | |
| 139 path relative to the project directory starting with the third column. | |
| 140 The allowed status flags are: | |
| 141 <ul> | |
| 142 <li>"A" path was added but not yet committed</li> | |
| 143 <li>"M" path has local changes</li> | |
| 144 <li>"O" path was removed</li> | |
| 145 <li>"R" path was deleted and then re-added</li> | |
| 146 <li>"U" path needs an update</li> | |
| 147 <li>"Z" path contains a conflict</li> | |
| 148 <li>"?" path is not tracked</li> | |
| 149 <li>"!" path is missing</li> | |
| 150 <li>" " path is back at normal</li> | |
| 151 </ul> | |
| 152 </p> | |
| 153 <dl> | |
| 154 <dt>Return:</dt> | |
| 155 <dd> | |
| 156 tuple of flag indicating successful operation (boolean) and | |
| 157 a status message in case of non successful operation (string) | |
| 158 </dd> | |
| 159 </dl> | |
| 160 <a NAME="GitStatusMonitorThread._shutdown" ID="GitStatusMonitorThread._shutdown"></a> | |
| 161 <h4>GitStatusMonitorThread._shutdown</h4> | |
| 162 <b>_shutdown</b>(<i></i>) | |
| 163 | |
| 164 <p> | |
| 165 Protected method performing shutdown actions. | |
| 166 </p> | |
| 167 <div align="right"><a href="#top">Up</a></div> | |
| 168 <hr /> | |
| 169 </body></html> |
