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