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