Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper.html
Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper.html
- changeset 1087
- fb8cd56819a9
- child 1228
- 7afaf2fca55b
equal
deleted
inserted
replaced
| 1086:b48ce064b224 | 1087:fb8cd56819a9 |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectHelper</h1> | |
| 24 <p> | |
| 25 Module implementing the project helper base for Mercurial extension interfaces. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#HgExtensionProjectHelper">HgExtensionProjectHelper</a></td> | |
| 35 <td>Class implementing the project helper base for Mercurial extension interfaces.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="HgExtensionProjectHelper" ID="HgExtensionProjectHelper"></a> | |
| 44 <h2>HgExtensionProjectHelper</h2> | |
| 45 <p> | |
| 46 Class implementing the project helper base for Mercurial extension interfaces. | |
| 47 </p><p> | |
| 48 Note: The methods initActions(), initMenu(mainMenu) and menuTitle() have to be | |
| 49 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>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#HgExtensionProjectHelper.__init__">HgExtensionProjectHelper</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#HgExtensionProjectHelper.getActions">getActions</a></td> | |
| 64 <td>Public method to get a list of all actions.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#HgExtensionProjectHelper.initActions">initActions</a></td> | |
| 67 <td>Public method to generate the action objects.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#HgExtensionProjectHelper.initMenu">initMenu</a></td> | |
| 70 <td>Public method to generate the extension menu.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#HgExtensionProjectHelper.menuTitle">menuTitle</a></td> | |
| 73 <td>Public method to get the menu title.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#HgExtensionProjectHelper.setObjects">setObjects</a></td> | |
| 76 <td>Public method to set references to the vcs and project objects.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 <a NAME="HgExtensionProjectHelper.__init__" ID="HgExtensionProjectHelper.__init__"></a> | |
| 80 <h4>HgExtensionProjectHelper (Constructor)</h4> | |
| 81 <b>HgExtensionProjectHelper</b>(<i></i>) | |
| 82 <p> | |
| 83 Constructor | |
| 84 </p><a NAME="HgExtensionProjectHelper.getActions" ID="HgExtensionProjectHelper.getActions"></a> | |
| 85 <h4>HgExtensionProjectHelper.getActions</h4> | |
| 86 <b>getActions</b>(<i></i>) | |
| 87 <p> | |
| 88 Public method to get a list of all actions. | |
| 89 </p><dl> | |
| 90 <dt>Returns:</dt> | |
| 91 <dd> | |
| 92 list of all actions (list of E5Action) | |
| 93 </dd> | |
| 94 </dl><a NAME="HgExtensionProjectHelper.initActions" ID="HgExtensionProjectHelper.initActions"></a> | |
| 95 <h4>HgExtensionProjectHelper.initActions</h4> | |
| 96 <b>initActions</b>(<i></i>) | |
| 97 <p> | |
| 98 Public method to generate the action objects. | |
| 99 </p><p> | |
| 100 Note: Derived class must implement this method. | |
| 101 </p><dl> | |
| 102 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 103 <dd> | |
| 104 raised if the class has not been reimplemente | |
| 105 </dd> | |
| 106 </dl><a NAME="HgExtensionProjectHelper.initMenu" ID="HgExtensionProjectHelper.initMenu"></a> | |
| 107 <h4>HgExtensionProjectHelper.initMenu</h4> | |
| 108 <b>initMenu</b>(<i>mainMenu</i>) | |
| 109 <p> | |
| 110 Public method to generate the extension menu. | |
| 111 </p><p> | |
| 112 Note: Derived class must implement this method. | |
| 113 </p><dl> | |
| 114 <dt><i>mainMenu</i></dt> | |
| 115 <dd> | |
| 116 reference to the main menu (QMenu) | |
| 117 </dd> | |
| 118 </dl><dl> | |
| 119 <dt>Returns:</dt> | |
| 120 <dd> | |
| 121 populated menu (QMenu) | |
| 122 </dd> | |
| 123 </dl><dl> | |
| 124 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 125 <dd> | |
| 126 raised if the class has not been reimplemente | |
| 127 </dd> | |
| 128 </dl><a NAME="HgExtensionProjectHelper.menuTitle" ID="HgExtensionProjectHelper.menuTitle"></a> | |
| 129 <h4>HgExtensionProjectHelper.menuTitle</h4> | |
| 130 <b>menuTitle</b>(<i></i>) | |
| 131 <p> | |
| 132 Public method to get the menu title. | |
| 133 </p><p> | |
| 134 Note: Derived class must implement this method. | |
| 135 </p><dl> | |
| 136 <dt>Returns:</dt> | |
| 137 <dd> | |
| 138 title of the menu (string) | |
| 139 </dd> | |
| 140 </dl><dl> | |
| 141 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 142 <dd> | |
| 143 raised if the class has not been reimplemente | |
| 144 </dd> | |
| 145 </dl><a NAME="HgExtensionProjectHelper.setObjects" ID="HgExtensionProjectHelper.setObjects"></a> | |
| 146 <h4>HgExtensionProjectHelper.setObjects</h4> | |
| 147 <b>setObjects</b>(<i>vcsObject, projectObject</i>) | |
| 148 <p> | |
| 149 Public method to set references to the vcs and project objects. | |
| 150 </p><dl> | |
| 151 <dt><i>vcsObject</i></dt> | |
| 152 <dd> | |
| 153 reference to the vcs object | |
| 154 </dd><dt><i>projectObject</i></dt> | |
| 155 <dd> | |
| 156 reference to the project object | |
| 157 </dd> | |
| 158 </dl> | |
| 159 <div align="right"><a href="#top">Up</a></div> | |
| 160 <hr /> | |
| 161 </body></html> |
