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 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10438
- 4cd7e5a8b3cf
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper</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.HgExtensionProjectHelper</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the project helper base for Mercurial extension interfaces. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#HgExtensionProjectHelper">HgExtensionProjectHelper</a></td> | |
| 25 <td>Class implementing the project helper base for Mercurial extension interfaces.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="HgExtensionProjectHelper" ID="HgExtensionProjectHelper"></a> | |
| 36 <h2>HgExtensionProjectHelper</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the project helper base for Mercurial extension | |
| 40 interfaces. | |
| 41 </p> | |
| 42 <p> | |
| 43 Note: The methods initActions(), initMenu(mainMenu) and menuTitle() have | |
| 44 to be reimplemented by derived classes. | |
| 45 </p> | |
| 46 <h3>Derived from</h3> | |
| 47 QObject | |
| 48 <h3>Class Attributes</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Methods</h3> | |
| 59 | |
| 60 <table> | |
| 61 | |
| 62 <tr> | |
| 63 <td><a href="#HgExtensionProjectHelper.__init__">HgExtensionProjectHelper</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#HgExtensionProjectHelper.getActions">getActions</a></td> | |
| 68 <td>Public method to get a list of all actions.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#HgExtensionProjectHelper.initActions">initActions</a></td> | |
| 72 <td>Public method to generate the action objects.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#HgExtensionProjectHelper.initMenu">initMenu</a></td> | |
| 76 <td>Public method to generate the extension menu.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#HgExtensionProjectHelper.menuTitle">menuTitle</a></td> | |
| 80 <td>Public method to get the menu title.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#HgExtensionProjectHelper.setObjects">setObjects</a></td> | |
| 84 <td>Public method to set references to the vcs and project objects.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#HgExtensionProjectHelper.shutdown">shutdown</a></td> | |
| 88 <td>Public method to perform shutdown actions.</td> | |
| 89 </tr> | |
| 90 </table> | |
| 91 <h3>Static Methods</h3> | |
| 92 | |
| 93 <table> | |
| 94 <tr><td>None</td></tr> | |
| 95 </table> | |
| 96 | |
| 97 <a NAME="HgExtensionProjectHelper.__init__" ID="HgExtensionProjectHelper.__init__"></a> | |
| 98 <h4>HgExtensionProjectHelper (Constructor)</h4> | |
| 99 <b>HgExtensionProjectHelper</b>(<i></i>) | |
| 100 | |
| 101 <p> | |
| 102 Constructor | |
| 103 </p> | |
| 104 <a NAME="HgExtensionProjectHelper.getActions" ID="HgExtensionProjectHelper.getActions"></a> | |
| 105 <h4>HgExtensionProjectHelper.getActions</h4> | |
| 106 <b>getActions</b>(<i></i>) | |
| 107 | |
| 108 <p> | |
| 109 Public method to get a list of all actions. | |
| 110 </p> | |
| 111 <dl> | |
| 112 <dt>Return:</dt> | |
| 113 <dd> | |
| 114 list of all actions (list of EricAction) | |
| 115 </dd> | |
| 116 </dl> | |
| 117 <a NAME="HgExtensionProjectHelper.initActions" ID="HgExtensionProjectHelper.initActions"></a> | |
| 118 <h4>HgExtensionProjectHelper.initActions</h4> | |
| 119 <b>initActions</b>(<i></i>) | |
| 120 | |
| 121 <p> | |
| 122 Public method to generate the action objects. | |
| 123 </p> | |
| 124 <p> | |
| 125 Note: Derived class must implement this method. | |
| 126 </p> | |
| 127 <dl> | |
| 128 | |
| 129 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 130 <dd> | |
| 131 raised if the class has not been | |
| 132 reimplemented | |
| 133 </dd> | |
| 134 </dl> | |
| 135 <a NAME="HgExtensionProjectHelper.initMenu" ID="HgExtensionProjectHelper.initMenu"></a> | |
| 136 <h4>HgExtensionProjectHelper.initMenu</h4> | |
| 137 <b>initMenu</b>(<i>mainMenu</i>) | |
| 138 | |
| 139 <p> | |
| 140 Public method to generate the extension menu. | |
| 141 </p> | |
| 142 <p> | |
| 143 Note: Derived class must implement this method. | |
| 144 </p> | |
| 145 <dl> | |
| 146 | |
| 147 <dt><i>mainMenu</i></dt> | |
| 148 <dd> | |
| 149 reference to the main menu (QMenu) | |
| 150 </dd> | |
| 151 </dl> | |
| 152 <dl> | |
| 153 <dt>Return:</dt> | |
| 154 <dd> | |
| 155 populated menu (QMenu) | |
| 156 </dd> | |
| 157 </dl> | |
| 158 <dl> | |
| 159 | |
| 160 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 161 <dd> | |
| 162 raised if the class has not been | |
| 163 reimplemented | |
| 164 </dd> | |
| 165 </dl> | |
| 166 <a NAME="HgExtensionProjectHelper.menuTitle" ID="HgExtensionProjectHelper.menuTitle"></a> | |
| 167 <h4>HgExtensionProjectHelper.menuTitle</h4> | |
| 168 <b>menuTitle</b>(<i></i>) | |
| 169 | |
| 170 <p> | |
| 171 Public method to get the menu title. | |
| 172 </p> | |
| 173 <p> | |
| 174 Note: Derived class must implement this method. | |
| 175 </p> | |
| 176 <dl> | |
| 177 <dt>Return:</dt> | |
| 178 <dd> | |
| 179 title of the menu (string) | |
| 180 </dd> | |
| 181 </dl> | |
| 182 <dl> | |
| 183 | |
| 184 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 185 <dd> | |
| 186 raised if the class has not been | |
| 187 reimplemented | |
| 188 </dd> | |
| 189 </dl> | |
| 190 <a NAME="HgExtensionProjectHelper.setObjects" ID="HgExtensionProjectHelper.setObjects"></a> | |
| 191 <h4>HgExtensionProjectHelper.setObjects</h4> | |
| 192 <b>setObjects</b>(<i>vcsObject, projectObject</i>) | |
| 193 | |
| 194 <p> | |
| 195 Public method to set references to the vcs and project objects. | |
| 196 </p> | |
| 197 <dl> | |
| 198 | |
| 199 <dt><i>vcsObject</i></dt> | |
| 200 <dd> | |
| 201 reference to the vcs object | |
| 202 </dd> | |
| 203 <dt><i>projectObject</i></dt> | |
| 204 <dd> | |
| 205 reference to the project object | |
| 206 </dd> | |
| 207 </dl> | |
| 208 <a NAME="HgExtensionProjectHelper.shutdown" ID="HgExtensionProjectHelper.shutdown"></a> | |
| 209 <h4>HgExtensionProjectHelper.shutdown</h4> | |
| 210 <b>shutdown</b>(<i></i>) | |
| 211 | |
| 212 <p> | |
| 213 Public method to perform shutdown actions. | |
| 214 </p> | |
| 215 <p> | |
| 216 Note: Derived class may implement this method if needed. | |
| 217 </p> | |
| 218 <div align="right"><a href="#top">Up</a></div> | |
| 219 <hr /> | |
| 220 </body></html> |
