Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectBrowserHelper.html
eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectBrowserHelper.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.HgExtensionProjectBrowserHelper</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.HgExtensionProjectBrowserHelper</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing the project browser helper base for Mercurial extension | |
| 27 interfaces. | |
| 28 </p> | |
| 29 <h3>Global Attributes</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <h3>Classes</h3> | |
| 35 | |
| 36 <table> | |
| 37 | |
| 38 <tr> | |
| 39 <td><a href="#HgExtensionProjectBrowserHelper">HgExtensionProjectBrowserHelper</a></td> | |
| 40 <td>Class implementing the project browser helper base for Mercurial extension interfaces.</td> | |
| 41 </tr> | |
| 42 </table> | |
| 43 <h3>Functions</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <hr /> | |
| 49 <hr /> | |
| 50 <a NAME="HgExtensionProjectBrowserHelper" ID="HgExtensionProjectBrowserHelper"></a> | |
| 51 <h2>HgExtensionProjectBrowserHelper</h2> | |
| 52 | |
| 53 <p> | |
| 54 Class implementing the project browser helper base for Mercurial extension | |
| 55 interfaces. | |
| 56 </p> | |
| 57 <p> | |
| 58 Note: The methods initMenus() and menuTitle() have to be reimplemented by | |
| 59 derived classes. | |
| 60 </p> | |
| 61 <h3>Derived from</h3> | |
| 62 QObject | |
| 63 <h3>Class Attributes</h3> | |
| 64 | |
| 65 <table> | |
| 66 <tr><td>None</td></tr> | |
| 67 </table> | |
| 68 <h3>Class Methods</h3> | |
| 69 | |
| 70 <table> | |
| 71 <tr><td>None</td></tr> | |
| 72 </table> | |
| 73 <h3>Methods</h3> | |
| 74 | |
| 75 <table> | |
| 76 | |
| 77 <tr> | |
| 78 <td><a href="#HgExtensionProjectBrowserHelper.__init__">HgExtensionProjectBrowserHelper</a></td> | |
| 79 <td>Constructor</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#HgExtensionProjectBrowserHelper._updateVCSStatus">_updateVCSStatus</a></td> | |
| 83 <td>Protected method to update the VCS status of an item.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#HgExtensionProjectBrowserHelper.initMenus">initMenus</a></td> | |
| 87 <td>Public method to generate the extension menus.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#HgExtensionProjectBrowserHelper.menuTitle">menuTitle</a></td> | |
| 91 <td>Public method to get the menu title.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#HgExtensionProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td> | |
| 95 <td>Public method to prepare the extension menu for display.</td> | |
| 96 </tr> | |
| 97 </table> | |
| 98 <h3>Static Methods</h3> | |
| 99 | |
| 100 <table> | |
| 101 <tr><td>None</td></tr> | |
| 102 </table> | |
| 103 | |
| 104 <a NAME="HgExtensionProjectBrowserHelper.__init__" ID="HgExtensionProjectBrowserHelper.__init__"></a> | |
| 105 <h4>HgExtensionProjectBrowserHelper (Constructor)</h4> | |
| 106 <b>HgExtensionProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>) | |
| 107 | |
| 108 <p> | |
| 109 Constructor | |
| 110 </p> | |
| 111 <dl> | |
| 112 | |
| 113 <dt><i>vcsObject</i></dt> | |
| 114 <dd> | |
| 115 reference to the vcs object | |
| 116 </dd> | |
| 117 <dt><i>browserObject</i></dt> | |
| 118 <dd> | |
| 119 reference to the project browser object | |
| 120 </dd> | |
| 121 <dt><i>projectObject</i></dt> | |
| 122 <dd> | |
| 123 reference to the project object | |
| 124 </dd> | |
| 125 </dl> | |
| 126 <a NAME="HgExtensionProjectBrowserHelper._updateVCSStatus" ID="HgExtensionProjectBrowserHelper._updateVCSStatus"></a> | |
| 127 <h4>HgExtensionProjectBrowserHelper._updateVCSStatus</h4> | |
| 128 <b>_updateVCSStatus</b>(<i>name</i>) | |
| 129 | |
| 130 <p> | |
| 131 Protected method to update the VCS status of an item. | |
| 132 </p> | |
| 133 <dl> | |
| 134 | |
| 135 <dt><i>name</i></dt> | |
| 136 <dd> | |
| 137 filename or directoryname of the item to be updated | |
| 138 (string) | |
| 139 </dd> | |
| 140 </dl> | |
| 141 <a NAME="HgExtensionProjectBrowserHelper.initMenus" ID="HgExtensionProjectBrowserHelper.initMenus"></a> | |
| 142 <h4>HgExtensionProjectBrowserHelper.initMenus</h4> | |
| 143 <b>initMenus</b>(<i></i>) | |
| 144 | |
| 145 <p> | |
| 146 Public method to generate the extension menus. | |
| 147 </p> | |
| 148 <p> | |
| 149 Note: Derived class must implement this method. | |
| 150 </p> | |
| 151 <dl> | |
| 152 <dt>Return:</dt> | |
| 153 <dd> | |
| 154 dictionary of populated menu (dict of QMenu). The dict | |
| 155 must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' | |
| 156 and 'dirMultiMenu'. | |
| 157 </dd> | |
| 158 </dl> | |
| 159 <dl> | |
| 160 | |
| 161 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 162 <dd> | |
| 163 raised if the class has not been | |
| 164 reimplemented | |
| 165 </dd> | |
| 166 </dl> | |
| 167 <a NAME="HgExtensionProjectBrowserHelper.menuTitle" ID="HgExtensionProjectBrowserHelper.menuTitle"></a> | |
| 168 <h4>HgExtensionProjectBrowserHelper.menuTitle</h4> | |
| 169 <b>menuTitle</b>(<i></i>) | |
| 170 | |
| 171 <p> | |
| 172 Public method to get the menu title. | |
| 173 </p> | |
| 174 <p> | |
| 175 Note: Derived class must implement this method. | |
| 176 </p> | |
| 177 <dl> | |
| 178 <dt>Return:</dt> | |
| 179 <dd> | |
| 180 title of the menu (string) | |
| 181 </dd> | |
| 182 </dl> | |
| 183 <dl> | |
| 184 | |
| 185 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 186 <dd> | |
| 187 raised if the class has not been | |
| 188 reimplemented | |
| 189 </dd> | |
| 190 </dl> | |
| 191 <a NAME="HgExtensionProjectBrowserHelper.showExtensionMenu" ID="HgExtensionProjectBrowserHelper.showExtensionMenu"></a> | |
| 192 <h4>HgExtensionProjectBrowserHelper.showExtensionMenu</h4> | |
| 193 <b>showExtensionMenu</b>(<i>key, controlled</i>) | |
| 194 | |
| 195 <p> | |
| 196 Public method to prepare the extension menu for display. | |
| 197 </p> | |
| 198 <p> | |
| 199 Note: Derived class must implement this method to adjust the | |
| 200 enabled states of its menus. | |
| 201 </p> | |
| 202 <dl> | |
| 203 | |
| 204 <dt><i>key</i></dt> | |
| 205 <dd> | |
| 206 menu key (string, one of 'mainMenu', 'multiMenu', | |
| 207 'backMenu', 'dirMenu' or 'dirMultiMenu') | |
| 208 </dd> | |
| 209 <dt><i>controlled</i></dt> | |
| 210 <dd> | |
| 211 flag indicating to prepare the menu for a | |
| 212 version controlled entry or a non-version controlled entry | |
| 213 (boolean) | |
| 214 </dd> | |
| 215 </dl> | |
| 216 <dl> | |
| 217 | |
| 218 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 219 <dd> | |
| 220 raised if the class has not been | |
| 221 reimplemented | |
| 222 </dd> | |
| 223 </dl> | |
| 224 <div align="right"><a href="#top">Up</a></div> | |
| 225 <hr /> | |
| 226 </body></html> |
