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