Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectBrowserHelper.html
Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectBrowserHelper.html
- changeset 3673
- e26d7d0c1088
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.ShelveExtension.ProjectBrowserHelper</h1> | |
| 23 <p> | |
| 24 Module implementing the shelve extension project browser 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="#ShelveProjectBrowserHelper">ShelveProjectBrowserHelper</a></td> | |
| 34 <td>Class implementing the shelve extension project browser 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="ShelveProjectBrowserHelper" ID="ShelveProjectBrowserHelper"></a> | |
| 43 <h2>ShelveProjectBrowserHelper</h2> | |
| 44 <p> | |
| 45 Class implementing the shelve extension project browser helper. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 HgExtensionProjectBrowserHelper | |
| 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="#ShelveProjectBrowserHelper.__init__">ShelveProjectBrowserHelper</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ShelveProjectBrowserHelper.__hgShelve">__hgShelve</a></td> | |
| 64 <td>Private slot used to shelve all current changes.</td> | |
| 65 </tr><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><tr> | |
| 69 <td><a href="#ShelveProjectBrowserHelper.initMenus">initMenus</a></td> | |
| 70 <td>Public method to generate the extension menus.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#ShelveProjectBrowserHelper.menuTitle">menuTitle</a></td> | |
| 73 <td>Public method to get the menu title.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#ShelveProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td> | |
| 76 <td>Public method to prepare the extension menu for display.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 <h3>Static Methods</h3> | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 <a NAME="ShelveProjectBrowserHelper.__init__" ID="ShelveProjectBrowserHelper.__init__"></a> | |
| 84 <h4>ShelveProjectBrowserHelper (Constructor)</h4> | |
| 85 <b>ShelveProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>) | |
| 86 <p> | |
| 87 Constructor | |
| 88 </p><dl> | |
| 89 <dt><i>vcsObject</i></dt> | |
| 90 <dd> | |
| 91 reference to the vcs object | |
| 92 </dd><dt><i>browserObject</i></dt> | |
| 93 <dd> | |
| 94 reference to the project browser object | |
| 95 </dd><dt><i>projectObject</i></dt> | |
| 96 <dd> | |
| 97 reference to the project object | |
| 98 </dd> | |
| 99 </dl><a NAME="ShelveProjectBrowserHelper.__hgShelve" ID="ShelveProjectBrowserHelper.__hgShelve"></a> | |
| 100 <h4>ShelveProjectBrowserHelper.__hgShelve</h4> | |
| 101 <b>__hgShelve</b>(<i></i>) | |
| 102 <p> | |
| 103 Private slot used to shelve all current changes. | |
| 104 </p><a NAME="ShelveProjectBrowserHelper.__reopenProject" ID="ShelveProjectBrowserHelper.__reopenProject"></a> | |
| 105 <h4>ShelveProjectBrowserHelper.__reopenProject</h4> | |
| 106 <b>__reopenProject</b>(<i>shouldReopen, title</i>) | |
| 107 <p> | |
| 108 Private method to reopen the project if needed and wanted. | |
| 109 </p><dl> | |
| 110 <dt><i>shouldReopen</i></dt> | |
| 111 <dd> | |
| 112 flag indicating that the project should | |
| 113 be reopened (boolean) | |
| 114 </dd><dt><i>title</i></dt> | |
| 115 <dd> | |
| 116 title of the message box (string) | |
| 117 </dd> | |
| 118 </dl><a NAME="ShelveProjectBrowserHelper.initMenus" ID="ShelveProjectBrowserHelper.initMenus"></a> | |
| 119 <h4>ShelveProjectBrowserHelper.initMenus</h4> | |
| 120 <b>initMenus</b>(<i></i>) | |
| 121 <p> | |
| 122 Public method to generate the extension menus. | |
| 123 </p><dl> | |
| 124 <dt>Returns:</dt> | |
| 125 <dd> | |
| 126 dictionary of populated menu (dict of QMenu). The dict | |
| 127 must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' | |
| 128 and 'dirMultiMenu'. | |
| 129 </dd> | |
| 130 </dl><a NAME="ShelveProjectBrowserHelper.menuTitle" ID="ShelveProjectBrowserHelper.menuTitle"></a> | |
| 131 <h4>ShelveProjectBrowserHelper.menuTitle</h4> | |
| 132 <b>menuTitle</b>(<i></i>) | |
| 133 <p> | |
| 134 Public method to get the menu title. | |
| 135 </p><dl> | |
| 136 <dt>Returns:</dt> | |
| 137 <dd> | |
| 138 title of the menu (string) | |
| 139 </dd> | |
| 140 </dl><a NAME="ShelveProjectBrowserHelper.showExtensionMenu" ID="ShelveProjectBrowserHelper.showExtensionMenu"></a> | |
| 141 <h4>ShelveProjectBrowserHelper.showExtensionMenu</h4> | |
| 142 <b>showExtensionMenu</b>(<i>key, controlled</i>) | |
| 143 <p> | |
| 144 Public method to prepare the extension menu for display. | |
| 145 </p><dl> | |
| 146 <dt><i>key</i></dt> | |
| 147 <dd> | |
| 148 menu key (string, one of 'mainMenu', 'multiMenu', | |
| 149 'backMenu', 'dirMenu' or 'dirMultiMenu') | |
| 150 </dd><dt><i>controlled</i></dt> | |
| 151 <dd> | |
| 152 flag indicating to prepare the menu for a | |
| 153 version controlled entry or a non-version controlled entry | |
| 154 (boolean) | |
| 155 </dd> | |
| 156 </dl> | |
| 157 <div align="right"><a href="#top">Up</a></div> | |
| 158 <hr /> | |
| 159 </body></html> |
