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 6942
- 2602857055c5
- parent 6529
- 1c2968f124b7
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitStatusMonitorThread</h1> | |
| 23 <p> | |
| 24 Module implementing the VCS status monitor thread class for Git. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#GitStatusMonitorThread">GitStatusMonitorThread</a></td> | |
| 34 <td>Class implementing the VCS status monitor thread class for Git.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="GitStatusMonitorThread" ID="GitStatusMonitorThread"></a> | |
| 43 <h2>GitStatusMonitorThread</h2> | |
| 44 <p> | |
| 45 Class implementing the VCS status monitor thread class for Git. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 VcsStatusMonitorThread | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>ConflictStates</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#GitStatusMonitorThread.__init__">GitStatusMonitorThread</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#GitStatusMonitorThread._getInfo">_getInfo</a></td> | |
| 64 <td>Protected method implementing the real info action.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#GitStatusMonitorThread._performMonitor">_performMonitor</a></td> | |
| 67 <td>Protected method implementing the monitoring action.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#GitStatusMonitorThread._shutdown">_shutdown</a></td> | |
| 70 <td>Protected method performing shutdown actions.</td> | |
| 71 </tr> | |
| 72 </table> | |
| 73 <h3>Static Methods</h3> | |
| 74 <table> | |
| 75 <tr><td>None</td></tr> | |
| 76 </table> | |
| 77 <a NAME="GitStatusMonitorThread.__init__" ID="GitStatusMonitorThread.__init__"></a> | |
| 78 <h4>GitStatusMonitorThread (Constructor)</h4> | |
| 79 <b>GitStatusMonitorThread</b>(<i>interval, project, vcs, parent=None</i>) | |
| 80 <p> | |
| 81 Constructor | |
| 82 </p><dl> | |
| 83 <dt><i>interval</i></dt> | |
| 84 <dd> | |
| 85 new interval in seconds (integer) | |
| 86 </dd><dt><i>project</i></dt> | |
| 87 <dd> | |
| 88 reference to the project object (Project) | |
| 89 </dd><dt><i>vcs</i></dt> | |
| 90 <dd> | |
| 91 reference to the version control object | |
| 92 </dd><dt><i>parent</i></dt> | |
| 93 <dd> | |
| 94 reference to the parent object (QObject) | |
| 95 </dd> | |
| 96 </dl><a NAME="GitStatusMonitorThread._getInfo" ID="GitStatusMonitorThread._getInfo"></a> | |
| 97 <h4>GitStatusMonitorThread._getInfo</h4> | |
| 98 <b>_getInfo</b>(<i></i>) | |
| 99 <p> | |
| 100 Protected method implementing the real info action. | |
| 101 </p><p> | |
| 102 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. | |
| 104 </p><dl> | |
| 105 <dt>Returns:</dt> | |
| 106 <dd> | |
| 107 short info message | |
| 108 </dd> | |
| 109 </dl><dl> | |
| 110 <dt>Return Type:</dt> | |
| 111 <dd> | |
| 112 str | |
| 113 </dd> | |
| 114 </dl><a NAME="GitStatusMonitorThread._performMonitor" ID="GitStatusMonitorThread._performMonitor"></a> | |
| 115 <h4>GitStatusMonitorThread._performMonitor</h4> | |
| 116 <b>_performMonitor</b>(<i></i>) | |
| 117 <p> | |
| 118 Protected method implementing the monitoring action. | |
| 119 </p><p> | |
| 120 This method populates the statusList member variable | |
| 121 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. | |
| 123 The allowed status flags are: | |
| 124 <ul> | |
| 125 <li>"A" path was added but not yet comitted</li> | |
| 126 <li>"M" path has local changes</li> | |
| 127 <li>"O" path was removed</li> | |
| 128 <li>"R" path was deleted and then re-added</li> | |
| 129 <li>"U" path needs an update</li> | |
| 130 <li>"Z" path contains a conflict</li> | |
| 131 <li>" " path is back at normal</li> | |
| 132 </ul> | |
| 133 </p><dl> | |
| 134 <dt>Returns:</dt> | |
| 135 <dd> | |
| 136 tuple of flag indicating successful operation (boolean) and | |
| 137 a status message in case of non successful operation (string) | |
| 138 </dd> | |
| 139 </dl><a NAME="GitStatusMonitorThread._shutdown" ID="GitStatusMonitorThread._shutdown"></a> | |
| 140 <h4>GitStatusMonitorThread._shutdown</h4> | |
| 141 <b>_shutdown</b>(<i></i>) | |
| 142 <p> | |
| 143 Protected method performing shutdown actions. | |
| 144 </p> | |
| 145 <div align="right"><a href="#top">Up</a></div> | |
| 146 <hr /> | |
| 147 </body></html> |
