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