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