Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectHelper.html
Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectHelper.html
- changeset 3297
- 7b7e8124fb51
- child 3316
- aaa864fa5c1e
equal
deleted
inserted
replaced
| 3294:3aabaf28817b | 3297:7b7e8124fb51 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric5.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectHelper</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>eric5.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectHelper</h1> | |
| 23 <p> | |
| 24 Module implementing the shelve extension project helper. | |
| 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="#ShelveProjectHelper">ShelveProjectHelper</a></td> | |
| 34 <td>Class implementing the queues extension project helper.</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="ShelveProjectHelper" ID="ShelveProjectHelper"></a> | |
| 43 <h2>ShelveProjectHelper</h2> | |
| 44 <p> | |
| 45 Class implementing the queues extension project helper. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 HgExtensionProjectHelper | |
| 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="#ShelveProjectHelper.__init__">ShelveProjectHelper</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ShelveProjectHelper.__hgCleanupShelves">__hgCleanupShelves</a></td> | |
| 64 <td>Private slot to delete all shelves.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#ShelveProjectHelper.__hgDeleteShelves">__hgDeleteShelves</a></td> | |
| 67 <td>Private slot to delete selected shelves.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#ShelveProjectHelper.__hgShelve">__hgShelve</a></td> | |
| 70 <td>Private slot used to shelve all current changes.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#ShelveProjectHelper.__hgShelveBrowser">__hgShelveBrowser</a></td> | |
| 73 <td>Private slot to show the shelve browser dialog.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#ShelveProjectHelper.__hgUnshelve">__hgUnshelve</a></td> | |
| 76 <td>Private slot used to restore a shelved change.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#ShelveProjectHelper.__hgUnshelveAbort">__hgUnshelveAbort</a></td> | |
| 79 <td>Private slot used to abort an ongoing restore operation.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#ShelveProjectHelper.__hgUnshelveContinue">__hgUnshelveContinue</a></td> | |
| 82 <td>Private slot used to continue an ongoing restore operation.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#ShelveProjectHelper.__reopenProject">__reopenProject</a></td> | |
| 85 <td>Private method to reopen the project if needed and wanted.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#ShelveProjectHelper.initActions">initActions</a></td> | |
| 88 <td>Public method to generate the action objects.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#ShelveProjectHelper.initMenu">initMenu</a></td> | |
| 91 <td>Public method to generate the extension menu.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#ShelveProjectHelper.menuTitle">menuTitle</a></td> | |
| 94 <td>Public method to get the menu title.</td> | |
| 95 </tr> | |
| 96 </table> | |
| 97 <h3>Static Methods</h3> | |
| 98 <table> | |
| 99 <tr><td>None</td></tr> | |
| 100 </table> | |
| 101 <a NAME="ShelveProjectHelper.__init__" ID="ShelveProjectHelper.__init__"></a> | |
| 102 <h4>ShelveProjectHelper (Constructor)</h4> | |
| 103 <b>ShelveProjectHelper</b>(<i></i>) | |
| 104 <p> | |
| 105 Constructor | |
| 106 </p><a NAME="ShelveProjectHelper.__hgCleanupShelves" ID="ShelveProjectHelper.__hgCleanupShelves"></a> | |
| 107 <h4>ShelveProjectHelper.__hgCleanupShelves</h4> | |
| 108 <b>__hgCleanupShelves</b>(<i></i>) | |
| 109 <p> | |
| 110 Private slot to delete all shelves. | |
| 111 </p><a NAME="ShelveProjectHelper.__hgDeleteShelves" ID="ShelveProjectHelper.__hgDeleteShelves"></a> | |
| 112 <h4>ShelveProjectHelper.__hgDeleteShelves</h4> | |
| 113 <b>__hgDeleteShelves</b>(<i></i>) | |
| 114 <p> | |
| 115 Private slot to delete selected shelves. | |
| 116 </p><a NAME="ShelveProjectHelper.__hgShelve" ID="ShelveProjectHelper.__hgShelve"></a> | |
| 117 <h4>ShelveProjectHelper.__hgShelve</h4> | |
| 118 <b>__hgShelve</b>(<i></i>) | |
| 119 <p> | |
| 120 Private slot used to shelve all current changes. | |
| 121 </p><a NAME="ShelveProjectHelper.__hgShelveBrowser" ID="ShelveProjectHelper.__hgShelveBrowser"></a> | |
| 122 <h4>ShelveProjectHelper.__hgShelveBrowser</h4> | |
| 123 <b>__hgShelveBrowser</b>(<i></i>) | |
| 124 <p> | |
| 125 Private slot to show the shelve browser dialog. | |
| 126 </p><a NAME="ShelveProjectHelper.__hgUnshelve" ID="ShelveProjectHelper.__hgUnshelve"></a> | |
| 127 <h4>ShelveProjectHelper.__hgUnshelve</h4> | |
| 128 <b>__hgUnshelve</b>(<i></i>) | |
| 129 <p> | |
| 130 Private slot used to restore a shelved change. | |
| 131 </p><a NAME="ShelveProjectHelper.__hgUnshelveAbort" ID="ShelveProjectHelper.__hgUnshelveAbort"></a> | |
| 132 <h4>ShelveProjectHelper.__hgUnshelveAbort</h4> | |
| 133 <b>__hgUnshelveAbort</b>(<i></i>) | |
| 134 <p> | |
| 135 Private slot used to abort an ongoing restore operation. | |
| 136 </p><a NAME="ShelveProjectHelper.__hgUnshelveContinue" ID="ShelveProjectHelper.__hgUnshelveContinue"></a> | |
| 137 <h4>ShelveProjectHelper.__hgUnshelveContinue</h4> | |
| 138 <b>__hgUnshelveContinue</b>(<i></i>) | |
| 139 <p> | |
| 140 Private slot used to continue an ongoing restore operation. | |
| 141 </p><a NAME="ShelveProjectHelper.__reopenProject" ID="ShelveProjectHelper.__reopenProject"></a> | |
| 142 <h4>ShelveProjectHelper.__reopenProject</h4> | |
| 143 <b>__reopenProject</b>(<i>shouldReopen, title</i>) | |
| 144 <p> | |
| 145 Private method to reopen the project if needed and wanted. | |
| 146 </p><dl> | |
| 147 <dt><i>shouldReopen</i></dt> | |
| 148 <dd> | |
| 149 flag indicating that the project should | |
| 150 be reopened (boolean) | |
| 151 </dd><dt><i>title</i></dt> | |
| 152 <dd> | |
| 153 title of the message box (string) | |
| 154 </dd> | |
| 155 </dl><a NAME="ShelveProjectHelper.initActions" ID="ShelveProjectHelper.initActions"></a> | |
| 156 <h4>ShelveProjectHelper.initActions</h4> | |
| 157 <b>initActions</b>(<i></i>) | |
| 158 <p> | |
| 159 Public method to generate the action objects. | |
| 160 </p><a NAME="ShelveProjectHelper.initMenu" ID="ShelveProjectHelper.initMenu"></a> | |
| 161 <h4>ShelveProjectHelper.initMenu</h4> | |
| 162 <b>initMenu</b>(<i>mainMenu</i>) | |
| 163 <p> | |
| 164 Public method to generate the extension menu. | |
| 165 </p><dl> | |
| 166 <dt><i>mainMenu</i></dt> | |
| 167 <dd> | |
| 168 reference to the main menu (QMenu) | |
| 169 </dd> | |
| 170 </dl><dl> | |
| 171 <dt>Returns:</dt> | |
| 172 <dd> | |
| 173 populated menu (QMenu) | |
| 174 </dd> | |
| 175 </dl><a NAME="ShelveProjectHelper.menuTitle" ID="ShelveProjectHelper.menuTitle"></a> | |
| 176 <h4>ShelveProjectHelper.menuTitle</h4> | |
| 177 <b>menuTitle</b>(<i></i>) | |
| 178 <p> | |
| 179 Public method to get the menu title. | |
| 180 </p><dl> | |
| 181 <dt>Returns:</dt> | |
| 182 <dd> | |
| 183 title of the menu (string) | |
| 184 </dd> | |
| 185 </dl> | |
| 186 <div align="right"><a href="#top">Up</a></div> | |
| 187 <hr /> | |
| 188 </body></html> |
