Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectBrowserHelper.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectBrowserHelper.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.ProjectBrowserHelper</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.ProjectBrowserHelper</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the shelve extension project browser 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="#ShelveProjectBrowserHelper">ShelveProjectBrowserHelper</a></td> | |
| 25 <td>Class implementing the shelve extension project browser 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="ShelveProjectBrowserHelper" ID="ShelveProjectBrowserHelper"></a> | |
| 36 <h2>ShelveProjectBrowserHelper</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the shelve extension project browser helper. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 HgExtensionProjectBrowserHelper | |
| 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="#ShelveProjectBrowserHelper.__init__">ShelveProjectBrowserHelper</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#ShelveProjectBrowserHelper.__hgShelve">__hgShelve</a></td> | |
| 63 <td>Private slot used to shelve all current changes.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#ShelveProjectBrowserHelper.__reopenProject">__reopenProject</a></td> | |
| 67 <td>Private method to reopen the project if needed and wanted.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#ShelveProjectBrowserHelper.initMenus">initMenus</a></td> | |
| 71 <td>Public method to generate the extension menus.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#ShelveProjectBrowserHelper.menuTitle">menuTitle</a></td> | |
| 75 <td>Public method to get the menu title.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#ShelveProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td> | |
| 79 <td>Public method to prepare the extension menu for display.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <h3>Static Methods</h3> | |
| 83 | |
| 84 <table> | |
| 85 <tr><td>None</td></tr> | |
| 86 </table> | |
| 87 | |
| 88 <a NAME="ShelveProjectBrowserHelper.__init__" ID="ShelveProjectBrowserHelper.__init__"></a> | |
| 89 <h4>ShelveProjectBrowserHelper (Constructor)</h4> | |
| 90 <b>ShelveProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>) | |
| 91 | |
| 92 <p> | |
| 93 Constructor | |
| 94 </p> | |
| 95 <dl> | |
| 96 | |
| 97 <dt><i>vcsObject</i></dt> | |
| 98 <dd> | |
| 99 reference to the vcs object | |
| 100 </dd> | |
| 101 <dt><i>browserObject</i></dt> | |
| 102 <dd> | |
| 103 reference to the project browser object | |
| 104 </dd> | |
| 105 <dt><i>projectObject</i></dt> | |
| 106 <dd> | |
| 107 reference to the project object | |
| 108 </dd> | |
| 109 </dl> | |
| 110 <a NAME="ShelveProjectBrowserHelper.__hgShelve" ID="ShelveProjectBrowserHelper.__hgShelve"></a> | |
| 111 <h4>ShelveProjectBrowserHelper.__hgShelve</h4> | |
| 112 <b>__hgShelve</b>(<i></i>) | |
| 113 | |
| 114 <p> | |
| 115 Private slot used to shelve all current changes. | |
| 116 </p> | |
| 117 <a NAME="ShelveProjectBrowserHelper.__reopenProject" ID="ShelveProjectBrowserHelper.__reopenProject"></a> | |
| 118 <h4>ShelveProjectBrowserHelper.__reopenProject</h4> | |
| 119 <b>__reopenProject</b>(<i>shouldReopen, title</i>) | |
| 120 | |
| 121 <p> | |
| 122 Private method to reopen the project if needed and wanted. | |
| 123 </p> | |
| 124 <dl> | |
| 125 | |
| 126 <dt><i>shouldReopen</i></dt> | |
| 127 <dd> | |
| 128 flag indicating that the project should | |
| 129 be reopened (boolean) | |
| 130 </dd> | |
| 131 <dt><i>title</i></dt> | |
| 132 <dd> | |
| 133 title of the message box (string) | |
| 134 </dd> | |
| 135 </dl> | |
| 136 <a NAME="ShelveProjectBrowserHelper.initMenus" ID="ShelveProjectBrowserHelper.initMenus"></a> | |
| 137 <h4>ShelveProjectBrowserHelper.initMenus</h4> | |
| 138 <b>initMenus</b>(<i></i>) | |
| 139 | |
| 140 <p> | |
| 141 Public method to generate the extension menus. | |
| 142 </p> | |
| 143 <dl> | |
| 144 <dt>Return:</dt> | |
| 145 <dd> | |
| 146 dictionary of populated menu (dict of QMenu). The dict | |
| 147 must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' | |
| 148 and 'dirMultiMenu'. | |
| 149 </dd> | |
| 150 </dl> | |
| 151 <a NAME="ShelveProjectBrowserHelper.menuTitle" ID="ShelveProjectBrowserHelper.menuTitle"></a> | |
| 152 <h4>ShelveProjectBrowserHelper.menuTitle</h4> | |
| 153 <b>menuTitle</b>(<i></i>) | |
| 154 | |
| 155 <p> | |
| 156 Public method to get the menu title. | |
| 157 </p> | |
| 158 <dl> | |
| 159 <dt>Return:</dt> | |
| 160 <dd> | |
| 161 title of the menu (string) | |
| 162 </dd> | |
| 163 </dl> | |
| 164 <a NAME="ShelveProjectBrowserHelper.showExtensionMenu" ID="ShelveProjectBrowserHelper.showExtensionMenu"></a> | |
| 165 <h4>ShelveProjectBrowserHelper.showExtensionMenu</h4> | |
| 166 <b>showExtensionMenu</b>(<i>key, controlled</i>) | |
| 167 | |
| 168 <p> | |
| 169 Public method to prepare the extension menu for display. | |
| 170 </p> | |
| 171 <dl> | |
| 172 | |
| 173 <dt><i>key</i></dt> | |
| 174 <dd> | |
| 175 menu key (string, one of 'mainMenu', 'multiMenu', | |
| 176 'backMenu', 'dirMenu' or 'dirMultiMenu') | |
| 177 </dd> | |
| 178 <dt><i>controlled</i></dt> | |
| 179 <dd> | |
| 180 flag indicating to prepare the menu for a | |
| 181 version controlled entry or a non-version controlled entry | |
| 182 (boolean) | |
| 183 </dd> | |
| 184 </dl> | |
| 185 <div align="right"><a href="#top">Up</a></div> | |
| 186 <hr /> | |
| 187 </body></html> |
