Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.histedit.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.histedit.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.HisteditExtension.histedit</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.vcsMercurial.HisteditExtension.histedit</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the histedit extension interface. | |
| 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="#Histedit">Histedit</a></td> | |
| 25 <td>Class implementing the histedit extension interface.</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="Histedit" ID="Histedit"></a> | |
| 36 <h2>Histedit</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the histedit extension interface. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 HgExtension | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</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="#Histedit.__init__">Histedit</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#Histedit.hgHisteditAbort">hgHisteditAbort</a></td> | |
| 63 <td>Public method to abort an interrupted histedit session.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#Histedit.hgHisteditContinue">hgHisteditContinue</a></td> | |
| 67 <td>Public method to continue an interrupted histedit session.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#Histedit.hgHisteditEditPlan">hgHisteditEditPlan</a></td> | |
| 71 <td>Public method to edit the remaining actions list of an interrupted histedit session.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#Histedit.hgHisteditStart">hgHisteditStart</a></td> | |
| 75 <td>Public method to start a histedit session.</td> | |
| 76 </tr> | |
| 77 </table> | |
| 78 <h3>Static Methods</h3> | |
| 79 | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 | |
| 84 <a NAME="Histedit.__init__" ID="Histedit.__init__"></a> | |
| 85 <h4>Histedit (Constructor)</h4> | |
| 86 <b>Histedit</b>(<i>vcs</i>) | |
| 87 | |
| 88 <p> | |
| 89 Constructor | |
| 90 </p> | |
| 91 <dl> | |
| 92 | |
| 93 <dt><i>vcs</i> (Hg)</dt> | |
| 94 <dd> | |
| 95 reference to the Mercurial vcs object | |
| 96 </dd> | |
| 97 </dl> | |
| 98 <a NAME="Histedit.hgHisteditAbort" ID="Histedit.hgHisteditAbort"></a> | |
| 99 <h4>Histedit.hgHisteditAbort</h4> | |
| 100 <b>hgHisteditAbort</b>(<i>name</i>) | |
| 101 | |
| 102 <p> | |
| 103 Public method to abort an interrupted histedit session. | |
| 104 </p> | |
| 105 <dl> | |
| 106 | |
| 107 <dt><i>name</i> (str)</dt> | |
| 108 <dd> | |
| 109 file/directory name | |
| 110 </dd> | |
| 111 </dl> | |
| 112 <dl> | |
| 113 <dt>Return:</dt> | |
| 114 <dd> | |
| 115 flag indicating that the project should be reread | |
| 116 </dd> | |
| 117 </dl> | |
| 118 <dl> | |
| 119 <dt>Return Type:</dt> | |
| 120 <dd> | |
| 121 bool | |
| 122 </dd> | |
| 123 </dl> | |
| 124 <a NAME="Histedit.hgHisteditContinue" ID="Histedit.hgHisteditContinue"></a> | |
| 125 <h4>Histedit.hgHisteditContinue</h4> | |
| 126 <b>hgHisteditContinue</b>(<i></i>) | |
| 127 | |
| 128 <p> | |
| 129 Public method to continue an interrupted histedit session. | |
| 130 </p> | |
| 131 <dl> | |
| 132 <dt>Return:</dt> | |
| 133 <dd> | |
| 134 flag indicating that the project should be reread | |
| 135 </dd> | |
| 136 </dl> | |
| 137 <dl> | |
| 138 <dt>Return Type:</dt> | |
| 139 <dd> | |
| 140 bool | |
| 141 </dd> | |
| 142 </dl> | |
| 143 <a NAME="Histedit.hgHisteditEditPlan" ID="Histedit.hgHisteditEditPlan"></a> | |
| 144 <h4>Histedit.hgHisteditEditPlan</h4> | |
| 145 <b>hgHisteditEditPlan</b>(<i></i>) | |
| 146 | |
| 147 <p> | |
| 148 Public method to edit the remaining actions list of an interrupted | |
| 149 histedit session. | |
| 150 </p> | |
| 151 <dl> | |
| 152 <dt>Return:</dt> | |
| 153 <dd> | |
| 154 flag indicating that the project should be reread | |
| 155 </dd> | |
| 156 </dl> | |
| 157 <dl> | |
| 158 <dt>Return Type:</dt> | |
| 159 <dd> | |
| 160 bool | |
| 161 </dd> | |
| 162 </dl> | |
| 163 <a NAME="Histedit.hgHisteditStart" ID="Histedit.hgHisteditStart"></a> | |
| 164 <h4>Histedit.hgHisteditStart</h4> | |
| 165 <b>hgHisteditStart</b>(<i>rev=""</i>) | |
| 166 | |
| 167 <p> | |
| 168 Public method to start a histedit session. | |
| 169 </p> | |
| 170 <dl> | |
| 171 | |
| 172 <dt><i>rev</i> (str)</dt> | |
| 173 <dd> | |
| 174 revision to start histedit at | |
| 175 </dd> | |
| 176 </dl> | |
| 177 <dl> | |
| 178 <dt>Return:</dt> | |
| 179 <dd> | |
| 180 flag indicating that the project should be reread | |
| 181 </dd> | |
| 182 </dl> | |
| 183 <dl> | |
| 184 <dt>Return Type:</dt> | |
| 185 <dd> | |
| 186 bool | |
| 187 </dd> | |
| 188 </dl> | |
| 189 <div align="right"><a href="#top">Up</a></div> | |
| 190 <hr /> | |
| 191 </body></html> |
