Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectBrowserHelper.html
Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectBrowserHelper.html
- changeset 3673
- e26d7d0c1088
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgExtensionProjectBrowserHelper</h1> | |
| 23 <p> | |
| 24 Module implementing the project browser helper base for Mercurial extension | |
| 25 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="#HgExtensionProjectBrowserHelper">HgExtensionProjectBrowserHelper</a></td> | |
| 35 <td>Class implementing the project browser 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="HgExtensionProjectBrowserHelper" ID="HgExtensionProjectBrowserHelper"></a> | |
| 44 <h2>HgExtensionProjectBrowserHelper</h2> | |
| 45 <p> | |
| 46 Class implementing the project browser helper base for Mercurial extension | |
| 47 interfaces. | |
| 48 </p><p> | |
| 49 Note: The methods initMenus() and menuTitle() have to be reimplemented by | |
| 50 derived classes. | |
| 51 </p> | |
| 52 <h3>Derived from</h3> | |
| 53 QObject | |
| 54 <h3>Class Attributes</h3> | |
| 55 <table> | |
| 56 <tr><td>None</td></tr> | |
| 57 </table> | |
| 58 <h3>Class Methods</h3> | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Methods</h3> | |
| 63 <table> | |
| 64 <tr> | |
| 65 <td><a href="#HgExtensionProjectBrowserHelper.__init__">HgExtensionProjectBrowserHelper</a></td> | |
| 66 <td>Constructor</td> | |
| 67 </tr><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><tr> | |
| 71 <td><a href="#HgExtensionProjectBrowserHelper.initMenus">initMenus</a></td> | |
| 72 <td>Public method to generate the extension menus.</td> | |
| 73 </tr><tr> | |
| 74 <td><a href="#HgExtensionProjectBrowserHelper.menuTitle">menuTitle</a></td> | |
| 75 <td>Public method to get the menu title.</td> | |
| 76 </tr><tr> | |
| 77 <td><a href="#HgExtensionProjectBrowserHelper.showExtensionMenu">showExtensionMenu</a></td> | |
| 78 <td>Public method to prepare the extension menu for display.</td> | |
| 79 </tr> | |
| 80 </table> | |
| 81 <h3>Static Methods</h3> | |
| 82 <table> | |
| 83 <tr><td>None</td></tr> | |
| 84 </table> | |
| 85 <a NAME="HgExtensionProjectBrowserHelper.__init__" ID="HgExtensionProjectBrowserHelper.__init__"></a> | |
| 86 <h4>HgExtensionProjectBrowserHelper (Constructor)</h4> | |
| 87 <b>HgExtensionProjectBrowserHelper</b>(<i>vcsObject, browserObject, projectObject</i>) | |
| 88 <p> | |
| 89 Constructor | |
| 90 </p><dl> | |
| 91 <dt><i>vcsObject</i></dt> | |
| 92 <dd> | |
| 93 reference to the vcs object | |
| 94 </dd><dt><i>browserObject</i></dt> | |
| 95 <dd> | |
| 96 reference to the project browser object | |
| 97 </dd><dt><i>projectObject</i></dt> | |
| 98 <dd> | |
| 99 reference to the project object | |
| 100 </dd> | |
| 101 </dl><a NAME="HgExtensionProjectBrowserHelper._updateVCSStatus" ID="HgExtensionProjectBrowserHelper._updateVCSStatus"></a> | |
| 102 <h4>HgExtensionProjectBrowserHelper._updateVCSStatus</h4> | |
| 103 <b>_updateVCSStatus</b>(<i>name</i>) | |
| 104 <p> | |
| 105 Protected method to update the VCS status of an item. | |
| 106 </p><dl> | |
| 107 <dt><i>name</i></dt> | |
| 108 <dd> | |
| 109 filename or directoryname of the item to be updated | |
| 110 (string) | |
| 111 </dd> | |
| 112 </dl><a NAME="HgExtensionProjectBrowserHelper.initMenus" ID="HgExtensionProjectBrowserHelper.initMenus"></a> | |
| 113 <h4>HgExtensionProjectBrowserHelper.initMenus</h4> | |
| 114 <b>initMenus</b>(<i></i>) | |
| 115 <p> | |
| 116 Public method to generate the extension menus. | |
| 117 </p><p> | |
| 118 Note: Derived class must implement this method. | |
| 119 </p><dl> | |
| 120 <dt>Returns:</dt> | |
| 121 <dd> | |
| 122 dictionary of populated menu (dict of QMenu). The dict | |
| 123 must have the keys 'mainMenu', 'multiMenu', 'backMenu', 'dirMenu' | |
| 124 and 'dirMultiMenu'. | |
| 125 </dd> | |
| 126 </dl><dl> | |
| 127 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 128 <dd> | |
| 129 raised if the class has not been | |
| 130 reimplemented | |
| 131 </dd> | |
| 132 </dl><a NAME="HgExtensionProjectBrowserHelper.menuTitle" ID="HgExtensionProjectBrowserHelper.menuTitle"></a> | |
| 133 <h4>HgExtensionProjectBrowserHelper.menuTitle</h4> | |
| 134 <b>menuTitle</b>(<i></i>) | |
| 135 <p> | |
| 136 Public method to get the menu title. | |
| 137 </p><p> | |
| 138 Note: Derived class must implement this method. | |
| 139 </p><dl> | |
| 140 <dt>Returns:</dt> | |
| 141 <dd> | |
| 142 title of the menu (string) | |
| 143 </dd> | |
| 144 </dl><dl> | |
| 145 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 146 <dd> | |
| 147 raised if the class has not been | |
| 148 reimplemented | |
| 149 </dd> | |
| 150 </dl><a NAME="HgExtensionProjectBrowserHelper.showExtensionMenu" ID="HgExtensionProjectBrowserHelper.showExtensionMenu"></a> | |
| 151 <h4>HgExtensionProjectBrowserHelper.showExtensionMenu</h4> | |
| 152 <b>showExtensionMenu</b>(<i>key, controlled</i>) | |
| 153 <p> | |
| 154 Public method to prepare the extension menu for display. | |
| 155 </p><p> | |
| 156 Note: Derived class must implement this method to adjust the | |
| 157 enabled states of its menus. | |
| 158 </p><dl> | |
| 159 <dt><i>key</i></dt> | |
| 160 <dd> | |
| 161 menu key (string, one of 'mainMenu', 'multiMenu', | |
| 162 'backMenu', 'dirMenu' or 'dirMultiMenu') | |
| 163 </dd><dt><i>controlled</i></dt> | |
| 164 <dd> | |
| 165 flag indicating to prepare the menu for a | |
| 166 version controlled entry or a non-version controlled entry | |
| 167 (boolean) | |
| 168 </dd> | |
| 169 </dl><dl> | |
| 170 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 171 <dd> | |
| 172 raised if the class has not been | |
| 173 reimplemented | |
| 174 </dd> | |
| 175 </dl> | |
| 176 <div align="right"><a href="#top">Up</a></div> | |
| 177 <hr /> | |
| 178 </body></html> |
