Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveBuiltin.ProjectHelper.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveBuiltin.ProjectHelper.html
- branch
- eric7
- changeset 11068
- 15f0385e0471
equal
deleted
inserted
replaced
| 11067:67b92e2cb719 | 11068:15f0385e0471 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.ShelveBuiltin.ProjectHelper</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.ShelveBuiltin.ProjectHelper</h1> | |
| 10 <p> | |
| 11 Module implementing the shelve extension project helper. | |
| 12 </p> | |
| 13 | |
| 14 <h3>Global Attributes</h3> | |
| 15 <table> | |
| 16 <tr><td>None</td></tr> | |
| 17 </table> | |
| 18 | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#ShelveProjectHelper">ShelveProjectHelper</a></td> | |
| 23 <td>Class implementing the shelve extension project helper.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 | |
| 27 <h3>Functions</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 | |
| 32 <hr /> | |
| 33 <hr /> | |
| 34 <a NAME="ShelveProjectHelper" ID="ShelveProjectHelper"></a> | |
| 35 <h2>ShelveProjectHelper</h2> | |
| 36 <p> | |
| 37 Class implementing the shelve extension project helper. | |
| 38 </p> | |
| 39 | |
| 40 <h3>Derived from</h3> | |
| 41 HgExtensionProjectHelper | |
| 42 <h3>Class Attributes</h3> | |
| 43 <table> | |
| 44 <tr><td>None</td></tr> | |
| 45 </table> | |
| 46 | |
| 47 <h3>Class Methods</h3> | |
| 48 <table> | |
| 49 <tr><td>None</td></tr> | |
| 50 </table> | |
| 51 | |
| 52 <h3>Methods</h3> | |
| 53 <table> | |
| 54 <tr> | |
| 55 <td><a href="#ShelveProjectHelper.__init__">ShelveProjectHelper</a></td> | |
| 56 <td>Constructor</td> | |
| 57 </tr> | |
| 58 <tr> | |
| 59 <td><a href="#ShelveProjectHelper.__hgCleanupShelves">__hgCleanupShelves</a></td> | |
| 60 <td>Private slot to delete all shelves.</td> | |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#ShelveProjectHelper.__hgDeleteShelves">__hgDeleteShelves</a></td> | |
| 64 <td>Private slot to delete selected shelves.</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#ShelveProjectHelper.__hgShelve">__hgShelve</a></td> | |
| 68 <td>Private slot used to shelve all current changes.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#ShelveProjectHelper.__hgShelveBrowser">__hgShelveBrowser</a></td> | |
| 72 <td>Private slot to show the shelve browser dialog.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#ShelveProjectHelper.__hgUnshelve">__hgUnshelve</a></td> | |
| 76 <td>Private slot used to restore a shelved change.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#ShelveProjectHelper.__hgUnshelveAbort">__hgUnshelveAbort</a></td> | |
| 80 <td>Private slot used to abort an ongoing restore operation.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#ShelveProjectHelper.__hgUnshelveContinue">__hgUnshelveContinue</a></td> | |
| 84 <td>Private slot used to continue an ongoing restore operation.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#ShelveProjectHelper.__reopenProject">__reopenProject</a></td> | |
| 88 <td>Private method to reopen the project if needed and wanted.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#ShelveProjectHelper.initActions">initActions</a></td> | |
| 92 <td>Public method to generate the action objects.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#ShelveProjectHelper.initMenu">initMenu</a></td> | |
| 96 <td>Public method to generate the extension menu.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#ShelveProjectHelper.menuTitle">menuTitle</a></td> | |
| 100 <td>Public method to get the menu title.</td> | |
| 101 </tr> | |
| 102 </table> | |
| 103 | |
| 104 <h3>Static Methods</h3> | |
| 105 <table> | |
| 106 <tr><td>None</td></tr> | |
| 107 </table> | |
| 108 | |
| 109 | |
| 110 <a NAME="ShelveProjectHelper.__init__" ID="ShelveProjectHelper.__init__"></a> | |
| 111 <h4>ShelveProjectHelper (Constructor)</h4> | |
| 112 <b>ShelveProjectHelper</b>(<i></i>) | |
| 113 <p> | |
| 114 Constructor | |
| 115 </p> | |
| 116 | |
| 117 <a NAME="ShelveProjectHelper.__hgCleanupShelves" ID="ShelveProjectHelper.__hgCleanupShelves"></a> | |
| 118 <h4>ShelveProjectHelper.__hgCleanupShelves</h4> | |
| 119 <b>__hgCleanupShelves</b>(<i></i>) | |
| 120 <p> | |
| 121 Private slot to delete all shelves. | |
| 122 </p> | |
| 123 | |
| 124 <a NAME="ShelveProjectHelper.__hgDeleteShelves" ID="ShelveProjectHelper.__hgDeleteShelves"></a> | |
| 125 <h4>ShelveProjectHelper.__hgDeleteShelves</h4> | |
| 126 <b>__hgDeleteShelves</b>(<i></i>) | |
| 127 <p> | |
| 128 Private slot to delete selected shelves. | |
| 129 </p> | |
| 130 | |
| 131 <a NAME="ShelveProjectHelper.__hgShelve" ID="ShelveProjectHelper.__hgShelve"></a> | |
| 132 <h4>ShelveProjectHelper.__hgShelve</h4> | |
| 133 <b>__hgShelve</b>(<i></i>) | |
| 134 <p> | |
| 135 Private slot used to shelve all current changes. | |
| 136 </p> | |
| 137 | |
| 138 <a NAME="ShelveProjectHelper.__hgShelveBrowser" ID="ShelveProjectHelper.__hgShelveBrowser"></a> | |
| 139 <h4>ShelveProjectHelper.__hgShelveBrowser</h4> | |
| 140 <b>__hgShelveBrowser</b>(<i></i>) | |
| 141 <p> | |
| 142 Private slot to show the shelve browser dialog. | |
| 143 </p> | |
| 144 | |
| 145 <a NAME="ShelveProjectHelper.__hgUnshelve" ID="ShelveProjectHelper.__hgUnshelve"></a> | |
| 146 <h4>ShelveProjectHelper.__hgUnshelve</h4> | |
| 147 <b>__hgUnshelve</b>(<i></i>) | |
| 148 <p> | |
| 149 Private slot used to restore a shelved change. | |
| 150 </p> | |
| 151 | |
| 152 <a NAME="ShelveProjectHelper.__hgUnshelveAbort" ID="ShelveProjectHelper.__hgUnshelveAbort"></a> | |
| 153 <h4>ShelveProjectHelper.__hgUnshelveAbort</h4> | |
| 154 <b>__hgUnshelveAbort</b>(<i></i>) | |
| 155 <p> | |
| 156 Private slot used to abort an ongoing restore operation. | |
| 157 </p> | |
| 158 | |
| 159 <a NAME="ShelveProjectHelper.__hgUnshelveContinue" ID="ShelveProjectHelper.__hgUnshelveContinue"></a> | |
| 160 <h4>ShelveProjectHelper.__hgUnshelveContinue</h4> | |
| 161 <b>__hgUnshelveContinue</b>(<i></i>) | |
| 162 <p> | |
| 163 Private slot used to continue an ongoing restore operation. | |
| 164 </p> | |
| 165 | |
| 166 <a NAME="ShelveProjectHelper.__reopenProject" ID="ShelveProjectHelper.__reopenProject"></a> | |
| 167 <h4>ShelveProjectHelper.__reopenProject</h4> | |
| 168 <b>__reopenProject</b>(<i>shouldReopen, title</i>) | |
| 169 <p> | |
| 170 Private method to reopen the project if needed and wanted. | |
| 171 </p> | |
| 172 | |
| 173 <dl> | |
| 174 | |
| 175 <dt><i>shouldReopen</i> (bool)</dt> | |
| 176 <dd> | |
| 177 flag indicating that the project should | |
| 178 be reopened | |
| 179 </dd> | |
| 180 <dt><i>title</i> (str)</dt> | |
| 181 <dd> | |
| 182 title of the message box | |
| 183 </dd> | |
| 184 </dl> | |
| 185 <a NAME="ShelveProjectHelper.initActions" ID="ShelveProjectHelper.initActions"></a> | |
| 186 <h4>ShelveProjectHelper.initActions</h4> | |
| 187 <b>initActions</b>(<i></i>) | |
| 188 <p> | |
| 189 Public method to generate the action objects. | |
| 190 </p> | |
| 191 | |
| 192 <a NAME="ShelveProjectHelper.initMenu" ID="ShelveProjectHelper.initMenu"></a> | |
| 193 <h4>ShelveProjectHelper.initMenu</h4> | |
| 194 <b>initMenu</b>(<i>mainMenu</i>) | |
| 195 <p> | |
| 196 Public method to generate the extension menu. | |
| 197 </p> | |
| 198 | |
| 199 <dl> | |
| 200 | |
| 201 <dt><i>mainMenu</i> (QMenu)</dt> | |
| 202 <dd> | |
| 203 reference to the main menu | |
| 204 </dd> | |
| 205 </dl> | |
| 206 <dl> | |
| 207 <dt>Return:</dt> | |
| 208 <dd> | |
| 209 populated menu | |
| 210 </dd> | |
| 211 </dl> | |
| 212 <dl> | |
| 213 <dt>Return Type:</dt> | |
| 214 <dd> | |
| 215 QMenu | |
| 216 </dd> | |
| 217 </dl> | |
| 218 <a NAME="ShelveProjectHelper.menuTitle" ID="ShelveProjectHelper.menuTitle"></a> | |
| 219 <h4>ShelveProjectHelper.menuTitle</h4> | |
| 220 <b>menuTitle</b>(<i></i>) | |
| 221 <p> | |
| 222 Public method to get the menu title. | |
| 223 </p> | |
| 224 | |
| 225 <dl> | |
| 226 <dt>Return:</dt> | |
| 227 <dd> | |
| 228 title of the menu | |
| 229 </dd> | |
| 230 </dl> | |
| 231 <dl> | |
| 232 <dt>Return Type:</dt> | |
| 233 <dd> | |
| 234 str | |
| 235 </dd> | |
| 236 </dl> | |
| 237 <div align="right"><a href="#top">Up</a></div> | |
| 238 <hr /> | |
| 239 </body></html> |
