Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper.html
eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper.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.HgExtensionProjectHelper</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.HgExtensionProjectHelper</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing the project helper base for Mercurial extension interfaces. | |
| 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="#HgExtensionProjectHelper">HgExtensionProjectHelper</a></td> | |
| 39 <td>Class implementing the project helper base for Mercurial extension interfaces.</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="HgExtensionProjectHelper" ID="HgExtensionProjectHelper"></a> | |
| 50 <h2>HgExtensionProjectHelper</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing the project helper base for Mercurial extension | |
| 54 interfaces. | |
| 55 </p> | |
| 56 <p> | |
| 57 Note: The methods initActions(), initMenu(mainMenu) and menuTitle() have | |
| 58 to be reimplemented by derived classes. | |
| 59 </p> | |
| 60 <h3>Derived from</h3> | |
| 61 QObject | |
| 62 <h3>Class Attributes</h3> | |
| 63 | |
| 64 <table> | |
| 65 <tr><td>None</td></tr> | |
| 66 </table> | |
| 67 <h3>Class Methods</h3> | |
| 68 | |
| 69 <table> | |
| 70 <tr><td>None</td></tr> | |
| 71 </table> | |
| 72 <h3>Methods</h3> | |
| 73 | |
| 74 <table> | |
| 75 | |
| 76 <tr> | |
| 77 <td><a href="#HgExtensionProjectHelper.__init__">HgExtensionProjectHelper</a></td> | |
| 78 <td>Constructor</td> | |
| 79 </tr> | |
| 80 <tr> | |
| 81 <td><a href="#HgExtensionProjectHelper.getActions">getActions</a></td> | |
| 82 <td>Public method to get a list of all actions.</td> | |
| 83 </tr> | |
| 84 <tr> | |
| 85 <td><a href="#HgExtensionProjectHelper.initActions">initActions</a></td> | |
| 86 <td>Public method to generate the action objects.</td> | |
| 87 </tr> | |
| 88 <tr> | |
| 89 <td><a href="#HgExtensionProjectHelper.initMenu">initMenu</a></td> | |
| 90 <td>Public method to generate the extension menu.</td> | |
| 91 </tr> | |
| 92 <tr> | |
| 93 <td><a href="#HgExtensionProjectHelper.menuTitle">menuTitle</a></td> | |
| 94 <td>Public method to get the menu title.</td> | |
| 95 </tr> | |
| 96 <tr> | |
| 97 <td><a href="#HgExtensionProjectHelper.setObjects">setObjects</a></td> | |
| 98 <td>Public method to set references to the vcs and project objects.</td> | |
| 99 </tr> | |
| 100 <tr> | |
| 101 <td><a href="#HgExtensionProjectHelper.shutdown">shutdown</a></td> | |
| 102 <td>Public method to perform shutdown actions.</td> | |
| 103 </tr> | |
| 104 </table> | |
| 105 <h3>Static Methods</h3> | |
| 106 | |
| 107 <table> | |
| 108 <tr><td>None</td></tr> | |
| 109 </table> | |
| 110 | |
| 111 <a NAME="HgExtensionProjectHelper.__init__" ID="HgExtensionProjectHelper.__init__"></a> | |
| 112 <h4>HgExtensionProjectHelper (Constructor)</h4> | |
| 113 <b>HgExtensionProjectHelper</b>(<i></i>) | |
| 114 | |
| 115 <p> | |
| 116 Constructor | |
| 117 </p> | |
| 118 <a NAME="HgExtensionProjectHelper.getActions" ID="HgExtensionProjectHelper.getActions"></a> | |
| 119 <h4>HgExtensionProjectHelper.getActions</h4> | |
| 120 <b>getActions</b>(<i></i>) | |
| 121 | |
| 122 <p> | |
| 123 Public method to get a list of all actions. | |
| 124 </p> | |
| 125 <dl> | |
| 126 <dt>Return:</dt> | |
| 127 <dd> | |
| 128 list of all actions (list of EricAction) | |
| 129 </dd> | |
| 130 </dl> | |
| 131 <a NAME="HgExtensionProjectHelper.initActions" ID="HgExtensionProjectHelper.initActions"></a> | |
| 132 <h4>HgExtensionProjectHelper.initActions</h4> | |
| 133 <b>initActions</b>(<i></i>) | |
| 134 | |
| 135 <p> | |
| 136 Public method to generate the action objects. | |
| 137 </p> | |
| 138 <p> | |
| 139 Note: Derived class must implement this method. | |
| 140 </p> | |
| 141 <dl> | |
| 142 | |
| 143 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 144 <dd> | |
| 145 raised if the class has not been | |
| 146 reimplemented | |
| 147 </dd> | |
| 148 </dl> | |
| 149 <a NAME="HgExtensionProjectHelper.initMenu" ID="HgExtensionProjectHelper.initMenu"></a> | |
| 150 <h4>HgExtensionProjectHelper.initMenu</h4> | |
| 151 <b>initMenu</b>(<i>mainMenu</i>) | |
| 152 | |
| 153 <p> | |
| 154 Public method to generate the extension menu. | |
| 155 </p> | |
| 156 <p> | |
| 157 Note: Derived class must implement this method. | |
| 158 </p> | |
| 159 <dl> | |
| 160 | |
| 161 <dt><i>mainMenu</i></dt> | |
| 162 <dd> | |
| 163 reference to the main menu (QMenu) | |
| 164 </dd> | |
| 165 </dl> | |
| 166 <dl> | |
| 167 <dt>Return:</dt> | |
| 168 <dd> | |
| 169 populated menu (QMenu) | |
| 170 </dd> | |
| 171 </dl> | |
| 172 <dl> | |
| 173 | |
| 174 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 175 <dd> | |
| 176 raised if the class has not been | |
| 177 reimplemented | |
| 178 </dd> | |
| 179 </dl> | |
| 180 <a NAME="HgExtensionProjectHelper.menuTitle" ID="HgExtensionProjectHelper.menuTitle"></a> | |
| 181 <h4>HgExtensionProjectHelper.menuTitle</h4> | |
| 182 <b>menuTitle</b>(<i></i>) | |
| 183 | |
| 184 <p> | |
| 185 Public method to get the menu title. | |
| 186 </p> | |
| 187 <p> | |
| 188 Note: Derived class must implement this method. | |
| 189 </p> | |
| 190 <dl> | |
| 191 <dt>Return:</dt> | |
| 192 <dd> | |
| 193 title of the menu (string) | |
| 194 </dd> | |
| 195 </dl> | |
| 196 <dl> | |
| 197 | |
| 198 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 199 <dd> | |
| 200 raised if the class has not been | |
| 201 reimplemented | |
| 202 </dd> | |
| 203 </dl> | |
| 204 <a NAME="HgExtensionProjectHelper.setObjects" ID="HgExtensionProjectHelper.setObjects"></a> | |
| 205 <h4>HgExtensionProjectHelper.setObjects</h4> | |
| 206 <b>setObjects</b>(<i>vcsObject, projectObject</i>) | |
| 207 | |
| 208 <p> | |
| 209 Public method to set references to the vcs and project objects. | |
| 210 </p> | |
| 211 <dl> | |
| 212 | |
| 213 <dt><i>vcsObject</i></dt> | |
| 214 <dd> | |
| 215 reference to the vcs object | |
| 216 </dd> | |
| 217 <dt><i>projectObject</i></dt> | |
| 218 <dd> | |
| 219 reference to the project object | |
| 220 </dd> | |
| 221 </dl> | |
| 222 <a NAME="HgExtensionProjectHelper.shutdown" ID="HgExtensionProjectHelper.shutdown"></a> | |
| 223 <h4>HgExtensionProjectHelper.shutdown</h4> | |
| 224 <b>shutdown</b>(<i></i>) | |
| 225 | |
| 226 <p> | |
| 227 Public method to perform shutdown actions. | |
| 228 </p> | |
| 229 <p> | |
| 230 Note: Derived class may implement this method if needed. | |
| 231 </p> | |
| 232 <div align="right"><a href="#top">Up</a></div> | |
| 233 <hr /> | |
| 234 </body></html> |
