Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread.html
eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread</h1> | 23 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the VCS status monitor thread class for Git. | 26 Module implementing the VCS status monitor thread class for Git. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#GitStatusMonitorThread">GitStatusMonitorThread</a></td> | 38 <td><a href="#GitStatusMonitorThread">GitStatusMonitorThread</a></td> |
| 34 <td>Class implementing the VCS status monitor thread class for Git.</td> | 39 <td>Class implementing the VCS status monitor thread class for Git.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 43 | |
| 38 <table> | 44 <table> |
| 39 <tr><td>None</td></tr> | 45 <tr><td>None</td></tr> |
| 40 </table> | 46 </table> |
| 41 <hr /><hr /> | 47 <hr /> |
| 48 <hr /> | |
| 42 <a NAME="GitStatusMonitorThread" ID="GitStatusMonitorThread"></a> | 49 <a NAME="GitStatusMonitorThread" ID="GitStatusMonitorThread"></a> |
| 43 <h2>GitStatusMonitorThread</h2> | 50 <h2>GitStatusMonitorThread</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the VCS status monitor thread class for Git. | 53 Class implementing the VCS status monitor thread class for Git. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 VcsStatusMonitorThread | 56 VcsStatusMonitorThread |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>ConflictStates</td></tr> | 60 <tr><td>ConflictStates</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 68 | |
| 58 <table> | 69 <table> |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#GitStatusMonitorThread.__init__">GitStatusMonitorThread</a></td> | 72 <td><a href="#GitStatusMonitorThread.__init__">GitStatusMonitorThread</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#GitStatusMonitorThread._getInfo">_getInfo</a></td> | 76 <td><a href="#GitStatusMonitorThread._getInfo">_getInfo</a></td> |
| 64 <td>Protected method implementing the real info action.</td> | 77 <td>Protected method implementing the real info action.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#GitStatusMonitorThread._performMonitor">_performMonitor</a></td> | 80 <td><a href="#GitStatusMonitorThread._performMonitor">_performMonitor</a></td> |
| 67 <td>Protected method implementing the monitoring action.</td> | 81 <td>Protected method implementing the monitoring action.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#GitStatusMonitorThread._shutdown">_shutdown</a></td> | 84 <td><a href="#GitStatusMonitorThread._shutdown">_shutdown</a></td> |
| 70 <td>Protected method performing shutdown actions.</td> | 85 <td>Protected method performing shutdown actions.</td> |
| 71 </tr> | 86 </tr> |
| 72 </table> | 87 </table> |
| 73 <h3>Static Methods</h3> | 88 <h3>Static Methods</h3> |
| 89 | |
| 74 <table> | 90 <table> |
| 75 <tr><td>None</td></tr> | 91 <tr><td>None</td></tr> |
| 76 </table> | 92 </table> |
| 93 | |
| 77 <a NAME="GitStatusMonitorThread.__init__" ID="GitStatusMonitorThread.__init__"></a> | 94 <a NAME="GitStatusMonitorThread.__init__" ID="GitStatusMonitorThread.__init__"></a> |
| 78 <h4>GitStatusMonitorThread (Constructor)</h4> | 95 <h4>GitStatusMonitorThread (Constructor)</h4> |
| 79 <b>GitStatusMonitorThread</b>(<i>interval, project, vcs, parent=None</i>) | 96 <b>GitStatusMonitorThread</b>(<i>interval, project, vcs, parent=None</i>) |
| 97 | |
| 80 <p> | 98 <p> |
| 81 Constructor | 99 Constructor |
| 82 </p><dl> | 100 </p> |
| 101 <dl> | |
| 102 | |
| 83 <dt><i>interval</i></dt> | 103 <dt><i>interval</i></dt> |
| 84 <dd> | 104 <dd> |
| 85 new interval in seconds (integer) | 105 new interval in seconds (integer) |
| 86 </dd><dt><i>project</i></dt> | 106 </dd> |
| 107 <dt><i>project</i></dt> | |
| 87 <dd> | 108 <dd> |
| 88 reference to the project object (Project) | 109 reference to the project object (Project) |
| 89 </dd><dt><i>vcs</i></dt> | 110 </dd> |
| 111 <dt><i>vcs</i></dt> | |
| 90 <dd> | 112 <dd> |
| 91 reference to the version control object | 113 reference to the version control object |
| 92 </dd><dt><i>parent</i></dt> | 114 </dd> |
| 115 <dt><i>parent</i></dt> | |
| 93 <dd> | 116 <dd> |
| 94 reference to the parent object (QObject) | 117 reference to the parent object (QObject) |
| 95 </dd> | 118 </dd> |
| 96 </dl><a NAME="GitStatusMonitorThread._getInfo" ID="GitStatusMonitorThread._getInfo"></a> | 119 </dl> |
| 120 <a NAME="GitStatusMonitorThread._getInfo" ID="GitStatusMonitorThread._getInfo"></a> | |
| 97 <h4>GitStatusMonitorThread._getInfo</h4> | 121 <h4>GitStatusMonitorThread._getInfo</h4> |
| 98 <b>_getInfo</b>(<i></i>) | 122 <b>_getInfo</b>(<i></i>) |
| 123 | |
| 99 <p> | 124 <p> |
| 100 Protected method implementing the real info action. | 125 Protected method implementing the real info action. |
| 101 </p><p> | 126 </p> |
| 127 <p> | |
| 102 This method should be overridden and create a short info message to be | 128 This method should be overridden and create a short info message to be |
| 103 shown in the main window status bar right next to the status indicator. | 129 shown in the main window status bar right next to the status indicator. |
| 104 </p><dl> | 130 </p> |
| 131 <dl> | |
| 105 <dt>Returns:</dt> | 132 <dt>Returns:</dt> |
| 106 <dd> | 133 <dd> |
| 107 short info message | 134 short info message |
| 108 </dd> | 135 </dd> |
| 109 </dl><dl> | 136 </dl> |
| 137 <dl> | |
| 110 <dt>Return Type:</dt> | 138 <dt>Return Type:</dt> |
| 111 <dd> | 139 <dd> |
| 112 str | 140 str |
| 113 </dd> | 141 </dd> |
| 114 </dl><a NAME="GitStatusMonitorThread._performMonitor" ID="GitStatusMonitorThread._performMonitor"></a> | 142 </dl> |
| 143 <a NAME="GitStatusMonitorThread._performMonitor" ID="GitStatusMonitorThread._performMonitor"></a> | |
| 115 <h4>GitStatusMonitorThread._performMonitor</h4> | 144 <h4>GitStatusMonitorThread._performMonitor</h4> |
| 116 <b>_performMonitor</b>(<i></i>) | 145 <b>_performMonitor</b>(<i></i>) |
| 146 | |
| 117 <p> | 147 <p> |
| 118 Protected method implementing the monitoring action. | 148 Protected method implementing the monitoring action. |
| 119 </p><p> | 149 </p> |
| 150 <p> | |
| 120 This method populates the statusList member variable | 151 This method populates the statusList member variable |
| 121 with a list of strings giving the status in the first column and the | 152 with a list of strings giving the status in the first column and the |
| 122 path relative to the project directory starting with the third column. | 153 path relative to the project directory starting with the third column. |
| 123 The allowed status flags are: | 154 The allowed status flags are: |
| 124 <ul> | 155 <ul> |
| 128 <li>"R" path was deleted and then re-added</li> | 159 <li>"R" path was deleted and then re-added</li> |
| 129 <li>"U" path needs an update</li> | 160 <li>"U" path needs an update</li> |
| 130 <li>"Z" path contains a conflict</li> | 161 <li>"Z" path contains a conflict</li> |
| 131 <li>" " path is back at normal</li> | 162 <li>" " path is back at normal</li> |
| 132 </ul> | 163 </ul> |
| 133 </p><dl> | 164 </p> |
| 165 <dl> | |
| 134 <dt>Returns:</dt> | 166 <dt>Returns:</dt> |
| 135 <dd> | 167 <dd> |
| 136 tuple of flag indicating successful operation (boolean) and | 168 tuple of flag indicating successful operation (boolean) and |
| 137 a status message in case of non successful operation (string) | 169 a status message in case of non successful operation (string) |
| 138 </dd> | 170 </dd> |
| 139 </dl><a NAME="GitStatusMonitorThread._shutdown" ID="GitStatusMonitorThread._shutdown"></a> | 171 </dl> |
| 172 <a NAME="GitStatusMonitorThread._shutdown" ID="GitStatusMonitorThread._shutdown"></a> | |
| 140 <h4>GitStatusMonitorThread._shutdown</h4> | 173 <h4>GitStatusMonitorThread._shutdown</h4> |
| 141 <b>_shutdown</b>(<i></i>) | 174 <b>_shutdown</b>(<i></i>) |
| 175 | |
| 142 <p> | 176 <p> |
| 143 Protected method performing shutdown actions. | 177 Protected method performing shutdown actions. |
| 144 </p> | 178 </p> |
| 145 <div align="right"><a href="#top">Up</a></div> | 179 <div align="right"><a href="#top">Up</a></div> |
| 146 <hr /> | 180 <hr /> |
