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