Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10438
- 4cd7e5a8b3cf
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper</h1> | 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the project helper base for Mercurial extension interfaces. | 11 Module implementing the project helper base for Mercurial extension interfaces. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | 15 <table> |
| 16 <table> | 16 <tr><td>None</td></tr> |
| 17 <tr><td>None</td></tr> | 17 </table> |
| 18 </table> | 18 |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#HgExtensionProjectHelper">HgExtensionProjectHelper</a></td> | 22 <td><a href="#HgExtensionProjectHelper">HgExtensionProjectHelper</a></td> |
| 25 <td>Class implementing the project helper base for Mercurial extension interfaces.</td> | 23 <td>Class implementing the project helper base for Mercurial extension interfaces.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | 28 <table> |
| 30 <table> | 29 <tr><td>None</td></tr> |
| 31 <tr><td>None</td></tr> | 30 </table> |
| 32 </table> | 31 |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="HgExtensionProjectHelper" ID="HgExtensionProjectHelper"></a> | 34 <a NAME="HgExtensionProjectHelper" ID="HgExtensionProjectHelper"></a> |
| 36 <h2>HgExtensionProjectHelper</h2> | 35 <h2>HgExtensionProjectHelper</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing the project helper base for Mercurial extension | 37 Class implementing the project helper base for Mercurial extension |
| 40 interfaces. | 38 interfaces. |
| 41 </p> | 39 </p> |
| 42 <p> | 40 <p> |
| 43 Note: The methods initActions(), initMenu(mainMenu) and menuTitle() have | 41 Note: The methods initActions(), initMenu(mainMenu) and menuTitle() have |
| 44 to be reimplemented by derived classes. | 42 to be reimplemented by derived classes. |
| 45 </p> | 43 </p> |
| 44 | |
| 46 <h3>Derived from</h3> | 45 <h3>Derived from</h3> |
| 47 QObject | 46 QObject |
| 48 <h3>Class Attributes</h3> | 47 <h3>Class Attributes</h3> |
| 49 | 48 <table> |
| 50 <table> | 49 <tr><td>None</td></tr> |
| 51 <tr><td>None</td></tr> | 50 </table> |
| 52 </table> | 51 |
| 53 <h3>Class Methods</h3> | 52 <h3>Class Methods</h3> |
| 54 | 53 <table> |
| 55 <table> | 54 <tr><td>None</td></tr> |
| 56 <tr><td>None</td></tr> | 55 </table> |
| 57 </table> | 56 |
| 58 <h3>Methods</h3> | 57 <h3>Methods</h3> |
| 59 | 58 <table> |
| 60 <table> | |
| 61 | |
| 62 <tr> | 59 <tr> |
| 63 <td><a href="#HgExtensionProjectHelper.__init__">HgExtensionProjectHelper</a></td> | 60 <td><a href="#HgExtensionProjectHelper.__init__">HgExtensionProjectHelper</a></td> |
| 64 <td>Constructor</td> | 61 <td>Constructor</td> |
| 65 </tr> | 62 </tr> |
| 66 <tr> | 63 <tr> |
| 86 <tr> | 83 <tr> |
| 87 <td><a href="#HgExtensionProjectHelper.shutdown">shutdown</a></td> | 84 <td><a href="#HgExtensionProjectHelper.shutdown">shutdown</a></td> |
| 88 <td>Public method to perform shutdown actions.</td> | 85 <td>Public method to perform shutdown actions.</td> |
| 89 </tr> | 86 </tr> |
| 90 </table> | 87 </table> |
| 88 | |
| 91 <h3>Static Methods</h3> | 89 <h3>Static Methods</h3> |
| 92 | 90 <table> |
| 93 <table> | 91 <tr><td>None</td></tr> |
| 94 <tr><td>None</td></tr> | 92 </table> |
| 95 </table> | 93 |
| 96 | 94 |
| 97 <a NAME="HgExtensionProjectHelper.__init__" ID="HgExtensionProjectHelper.__init__"></a> | 95 <a NAME="HgExtensionProjectHelper.__init__" ID="HgExtensionProjectHelper.__init__"></a> |
| 98 <h4>HgExtensionProjectHelper (Constructor)</h4> | 96 <h4>HgExtensionProjectHelper (Constructor)</h4> |
| 99 <b>HgExtensionProjectHelper</b>(<i></i>) | 97 <b>HgExtensionProjectHelper</b>(<i></i>) |
| 100 | |
| 101 <p> | 98 <p> |
| 102 Constructor | 99 Constructor |
| 103 </p> | 100 </p> |
| 101 | |
| 104 <a NAME="HgExtensionProjectHelper.getActions" ID="HgExtensionProjectHelper.getActions"></a> | 102 <a NAME="HgExtensionProjectHelper.getActions" ID="HgExtensionProjectHelper.getActions"></a> |
| 105 <h4>HgExtensionProjectHelper.getActions</h4> | 103 <h4>HgExtensionProjectHelper.getActions</h4> |
| 106 <b>getActions</b>(<i></i>) | 104 <b>getActions</b>(<i></i>) |
| 107 | |
| 108 <p> | 105 <p> |
| 109 Public method to get a list of all actions. | 106 Public method to get a list of all actions. |
| 110 </p> | 107 </p> |
| 108 | |
| 111 <dl> | 109 <dl> |
| 112 <dt>Return:</dt> | 110 <dt>Return:</dt> |
| 113 <dd> | 111 <dd> |
| 114 list of all actions | 112 list of all actions |
| 115 </dd> | 113 </dd> |
| 121 </dd> | 119 </dd> |
| 122 </dl> | 120 </dl> |
| 123 <a NAME="HgExtensionProjectHelper.initActions" ID="HgExtensionProjectHelper.initActions"></a> | 121 <a NAME="HgExtensionProjectHelper.initActions" ID="HgExtensionProjectHelper.initActions"></a> |
| 124 <h4>HgExtensionProjectHelper.initActions</h4> | 122 <h4>HgExtensionProjectHelper.initActions</h4> |
| 125 <b>initActions</b>(<i></i>) | 123 <b>initActions</b>(<i></i>) |
| 126 | |
| 127 <p> | 124 <p> |
| 128 Public method to generate the action objects. | 125 Public method to generate the action objects. |
| 129 </p> | 126 </p> |
| 130 <p> | 127 <p> |
| 131 Note: Derived class must implement this method. | 128 Note: Derived class must implement this method. |
| 132 </p> | 129 </p> |
| 130 | |
| 133 <dl> | 131 <dl> |
| 134 | 132 |
| 135 <dt>Raises <b>NotImplementedError</b>:</dt> | 133 <dt>Raises <b>NotImplementedError</b>:</dt> |
| 136 <dd> | 134 <dd> |
| 137 raised if the class has not been | 135 raised if the class has not been |
| 139 </dd> | 137 </dd> |
| 140 </dl> | 138 </dl> |
| 141 <a NAME="HgExtensionProjectHelper.initMenu" ID="HgExtensionProjectHelper.initMenu"></a> | 139 <a NAME="HgExtensionProjectHelper.initMenu" ID="HgExtensionProjectHelper.initMenu"></a> |
| 142 <h4>HgExtensionProjectHelper.initMenu</h4> | 140 <h4>HgExtensionProjectHelper.initMenu</h4> |
| 143 <b>initMenu</b>(<i>mainMenu</i>) | 141 <b>initMenu</b>(<i>mainMenu</i>) |
| 144 | |
| 145 <p> | 142 <p> |
| 146 Public method to generate the extension menu. | 143 Public method to generate the extension menu. |
| 147 </p> | 144 </p> |
| 148 <p> | 145 <p> |
| 149 Note: Derived class must implement this method. | 146 Note: Derived class must implement this method. |
| 150 </p> | 147 </p> |
| 148 | |
| 151 <dl> | 149 <dl> |
| 152 | 150 |
| 153 <dt><i>mainMenu</i> (QMenu)</dt> | 151 <dt><i>mainMenu</i> (QMenu)</dt> |
| 154 <dd> | 152 <dd> |
| 155 reference to the main menu | 153 reference to the main menu |
| 176 </dd> | 174 </dd> |
| 177 </dl> | 175 </dl> |
| 178 <a NAME="HgExtensionProjectHelper.menuTitle" ID="HgExtensionProjectHelper.menuTitle"></a> | 176 <a NAME="HgExtensionProjectHelper.menuTitle" ID="HgExtensionProjectHelper.menuTitle"></a> |
| 179 <h4>HgExtensionProjectHelper.menuTitle</h4> | 177 <h4>HgExtensionProjectHelper.menuTitle</h4> |
| 180 <b>menuTitle</b>(<i></i>) | 178 <b>menuTitle</b>(<i></i>) |
| 181 | |
| 182 <p> | 179 <p> |
| 183 Public method to get the menu title. | 180 Public method to get the menu title. |
| 184 </p> | 181 </p> |
| 185 <p> | 182 <p> |
| 186 Note: Derived class must implement this method. | 183 Note: Derived class must implement this method. |
| 187 </p> | 184 </p> |
| 185 | |
| 188 <dl> | 186 <dl> |
| 189 <dt>Return:</dt> | 187 <dt>Return:</dt> |
| 190 <dd> | 188 <dd> |
| 191 title of the menu | 189 title of the menu |
| 192 </dd> | 190 </dd> |
| 206 </dd> | 204 </dd> |
| 207 </dl> | 205 </dl> |
| 208 <a NAME="HgExtensionProjectHelper.setObjects" ID="HgExtensionProjectHelper.setObjects"></a> | 206 <a NAME="HgExtensionProjectHelper.setObjects" ID="HgExtensionProjectHelper.setObjects"></a> |
| 209 <h4>HgExtensionProjectHelper.setObjects</h4> | 207 <h4>HgExtensionProjectHelper.setObjects</h4> |
| 210 <b>setObjects</b>(<i>vcsObject, projectObject</i>) | 208 <b>setObjects</b>(<i>vcsObject, projectObject</i>) |
| 211 | |
| 212 <p> | 209 <p> |
| 213 Public method to set references to the vcs and project objects. | 210 Public method to set references to the vcs and project objects. |
| 214 </p> | 211 </p> |
| 212 | |
| 215 <dl> | 213 <dl> |
| 216 | 214 |
| 217 <dt><i>vcsObject</i> (Hg)</dt> | 215 <dt><i>vcsObject</i> (Hg)</dt> |
| 218 <dd> | 216 <dd> |
| 219 reference to the vcs object | 217 reference to the vcs object |
| 224 </dd> | 222 </dd> |
| 225 </dl> | 223 </dl> |
| 226 <a NAME="HgExtensionProjectHelper.shutdown" ID="HgExtensionProjectHelper.shutdown"></a> | 224 <a NAME="HgExtensionProjectHelper.shutdown" ID="HgExtensionProjectHelper.shutdown"></a> |
| 227 <h4>HgExtensionProjectHelper.shutdown</h4> | 225 <h4>HgExtensionProjectHelper.shutdown</h4> |
| 228 <b>shutdown</b>(<i></i>) | 226 <b>shutdown</b>(<i></i>) |
| 229 | |
| 230 <p> | 227 <p> |
| 231 Public method to perform shutdown actions. | 228 Public method to perform shutdown actions. |
| 232 </p> | 229 </p> |
| 233 <p> | 230 <p> |
| 234 Note: Derived class may implement this method if needed. | 231 Note: Derived class may implement this method if needed. |
| 235 </p> | 232 </p> |
| 233 | |
| 236 <div align="right"><a href="#top">Up</a></div> | 234 <div align="right"><a href="#top">Up</a></div> |
| 237 <hr /> | 235 <hr /> |
| 238 </body></html> | 236 </body></html> |
