Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper.html
eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper.html
- changeset 6942
- 2602857055c5
- parent 3673
- e26d7d0c1088
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper</h1> | |
| 23 <p> | |
| 24 Module implementing the project helper base for Mercurial extension interfaces. | |
| 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="#HgExtensionProjectHelper">HgExtensionProjectHelper</a></td> | |
| 34 <td>Class implementing the project helper base for Mercurial extension interfaces.</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="HgExtensionProjectHelper" ID="HgExtensionProjectHelper"></a> | |
| 43 <h2>HgExtensionProjectHelper</h2> | |
| 44 <p> | |
| 45 Class implementing the project helper base for Mercurial extension | |
| 46 interfaces. | |
| 47 </p><p> | |
| 48 Note: The methods initActions(), initMenu(mainMenu) and menuTitle() have | |
| 49 to be reimplemented by derived classes. | |
| 50 </p> | |
| 51 <h3>Derived from</h3> | |
| 52 QObject | |
| 53 <h3>Class Attributes</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Class Methods</h3> | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 <table> | |
| 63 <tr> | |
| 64 <td><a href="#HgExtensionProjectHelper.__init__">HgExtensionProjectHelper</a></td> | |
| 65 <td>Constructor</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#HgExtensionProjectHelper.getActions">getActions</a></td> | |
| 68 <td>Public method to get a list of all actions.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#HgExtensionProjectHelper.initActions">initActions</a></td> | |
| 71 <td>Public method to generate the action objects.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#HgExtensionProjectHelper.initMenu">initMenu</a></td> | |
| 74 <td>Public method to generate the extension menu.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#HgExtensionProjectHelper.menuTitle">menuTitle</a></td> | |
| 77 <td>Public method to get the menu title.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#HgExtensionProjectHelper.setObjects">setObjects</a></td> | |
| 80 <td>Public method to set references to the vcs and project objects.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#HgExtensionProjectHelper.shutdown">shutdown</a></td> | |
| 83 <td>Public method to perform shutdown actions.</td> | |
| 84 </tr> | |
| 85 </table> | |
| 86 <h3>Static Methods</h3> | |
| 87 <table> | |
| 88 <tr><td>None</td></tr> | |
| 89 </table> | |
| 90 <a NAME="HgExtensionProjectHelper.__init__" ID="HgExtensionProjectHelper.__init__"></a> | |
| 91 <h4>HgExtensionProjectHelper (Constructor)</h4> | |
| 92 <b>HgExtensionProjectHelper</b>(<i></i>) | |
| 93 <p> | |
| 94 Constructor | |
| 95 </p><a NAME="HgExtensionProjectHelper.getActions" ID="HgExtensionProjectHelper.getActions"></a> | |
| 96 <h4>HgExtensionProjectHelper.getActions</h4> | |
| 97 <b>getActions</b>(<i></i>) | |
| 98 <p> | |
| 99 Public method to get a list of all actions. | |
| 100 </p><dl> | |
| 101 <dt>Returns:</dt> | |
| 102 <dd> | |
| 103 list of all actions (list of E5Action) | |
| 104 </dd> | |
| 105 </dl><a NAME="HgExtensionProjectHelper.initActions" ID="HgExtensionProjectHelper.initActions"></a> | |
| 106 <h4>HgExtensionProjectHelper.initActions</h4> | |
| 107 <b>initActions</b>(<i></i>) | |
| 108 <p> | |
| 109 Public method to generate the action objects. | |
| 110 </p><p> | |
| 111 Note: Derived class must implement this method. | |
| 112 </p><dl> | |
| 113 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 114 <dd> | |
| 115 raised if the class has not been | |
| 116 reimplemented | |
| 117 </dd> | |
| 118 </dl><a NAME="HgExtensionProjectHelper.initMenu" ID="HgExtensionProjectHelper.initMenu"></a> | |
| 119 <h4>HgExtensionProjectHelper.initMenu</h4> | |
| 120 <b>initMenu</b>(<i>mainMenu</i>) | |
| 121 <p> | |
| 122 Public method to generate the extension menu. | |
| 123 </p><p> | |
| 124 Note: Derived class must implement this method. | |
| 125 </p><dl> | |
| 126 <dt><i>mainMenu</i></dt> | |
| 127 <dd> | |
| 128 reference to the main menu (QMenu) | |
| 129 </dd> | |
| 130 </dl><dl> | |
| 131 <dt>Returns:</dt> | |
| 132 <dd> | |
| 133 populated menu (QMenu) | |
| 134 </dd> | |
| 135 </dl><dl> | |
| 136 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 137 <dd> | |
| 138 raised if the class has not been | |
| 139 reimplemented | |
| 140 </dd> | |
| 141 </dl><a NAME="HgExtensionProjectHelper.menuTitle" ID="HgExtensionProjectHelper.menuTitle"></a> | |
| 142 <h4>HgExtensionProjectHelper.menuTitle</h4> | |
| 143 <b>menuTitle</b>(<i></i>) | |
| 144 <p> | |
| 145 Public method to get the menu title. | |
| 146 </p><p> | |
| 147 Note: Derived class must implement this method. | |
| 148 </p><dl> | |
| 149 <dt>Returns:</dt> | |
| 150 <dd> | |
| 151 title of the menu (string) | |
| 152 </dd> | |
| 153 </dl><dl> | |
| 154 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 155 <dd> | |
| 156 raised if the class has not been | |
| 157 reimplemented | |
| 158 </dd> | |
| 159 </dl><a NAME="HgExtensionProjectHelper.setObjects" ID="HgExtensionProjectHelper.setObjects"></a> | |
| 160 <h4>HgExtensionProjectHelper.setObjects</h4> | |
| 161 <b>setObjects</b>(<i>vcsObject, projectObject</i>) | |
| 162 <p> | |
| 163 Public method to set references to the vcs and project objects. | |
| 164 </p><dl> | |
| 165 <dt><i>vcsObject</i></dt> | |
| 166 <dd> | |
| 167 reference to the vcs object | |
| 168 </dd><dt><i>projectObject</i></dt> | |
| 169 <dd> | |
| 170 reference to the project object | |
| 171 </dd> | |
| 172 </dl><a NAME="HgExtensionProjectHelper.shutdown" ID="HgExtensionProjectHelper.shutdown"></a> | |
| 173 <h4>HgExtensionProjectHelper.shutdown</h4> | |
| 174 <b>shutdown</b>(<i></i>) | |
| 175 <p> | |
| 176 Public method to perform shutdown actions. | |
| 177 </p><p> | |
| 178 Note: Derived class may implement this method if needed. | |
| 179 </p> | |
| 180 <div align="right"><a href="#top">Up</a></div> | |
| 181 <hr /> | |
| 182 </body></html> |
