Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.PluginVcsMercurial.html
Documentation/Source/eric5.Plugins.PluginVcsMercurial.html
- changeset 178
- dd9f0bca5e2f
- child 409
- 0ea528e80202
equal
deleted
inserted
replaced
| 177:c822ccc4d138 | 178:dd9f0bca5e2f |
|---|---|
| 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.PluginVcsMercurial</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Plugins.PluginVcsMercurial</h1> | |
| 24 <p> | |
| 25 Module implementing the Mercurial version control plugin. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>mercurialCfgPluginObject</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pluginType</td></tr><tr><td>pluginTypename</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#VcsMercurialPlugin">VcsMercurialPlugin</a></td> | |
| 35 <td>Class implementing the Mercurial version control plugin.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr> | |
| 41 <td><a href="#createConfigurationPage">createConfigurationPage</a></td> | |
| 42 <td>Module function to create the configuration page.</td> | |
| 43 </tr><tr> | |
| 44 <td><a href="#displayString">displayString</a></td> | |
| 45 <td>Public function to get the display string.</td> | |
| 46 </tr><tr> | |
| 47 <td><a href="#exeDisplayData">exeDisplayData</a></td> | |
| 48 <td>Public method to support the display of some executable info.</td> | |
| 49 </tr><tr> | |
| 50 <td><a href="#getConfigData">getConfigData</a></td> | |
| 51 <td>Module function returning data as required by the configuration dialog.</td> | |
| 52 </tr><tr> | |
| 53 <td><a href="#getVcsSystemIndicator">getVcsSystemIndicator</a></td> | |
| 54 <td>Public function to get the indicators for this version control system.</td> | |
| 55 </tr><tr> | |
| 56 <td><a href="#prepareUninstall">prepareUninstall</a></td> | |
| 57 <td>Module function to prepare for an uninstallation.</td> | |
| 58 </tr> | |
| 59 </table> | |
| 60 <hr /><hr /> | |
| 61 <a NAME="VcsMercurialPlugin" ID="VcsMercurialPlugin"></a> | |
| 62 <h2>VcsMercurialPlugin</h2> | |
| 63 <p> | |
| 64 Class implementing the Mercurial version control plugin. | |
| 65 </p> | |
| 66 <h3>Derived from</h3> | |
| 67 object | |
| 68 <h3>Class Attributes</h3> | |
| 69 <table> | |
| 70 <tr><td>None</td></tr> | |
| 71 </table> | |
| 72 <h3>Methods</h3> | |
| 73 <table> | |
| 74 <tr> | |
| 75 <td><a href="#VcsMercurialPlugin.__init__">VcsMercurialPlugin</a></td> | |
| 76 <td>Constructor</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#VcsMercurialPlugin.activate">activate</a></td> | |
| 79 <td>Public method to activate this plugin.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#VcsMercurialPlugin.deactivate">deactivate</a></td> | |
| 82 <td>Public method to deactivate this plugin.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#VcsMercurialPlugin.getConfigPath">getConfigPath</a></td> | |
| 85 <td>Public method to get the filename of the config file.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#VcsMercurialPlugin.getPreferences">getPreferences</a></td> | |
| 88 <td>Public method to retrieve the various settings.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#VcsMercurialPlugin.getProjectHelper">getProjectHelper</a></td> | |
| 91 <td>Public method to get a reference to the project helper object.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#VcsMercurialPlugin.prepareUninstall">prepareUninstall</a></td> | |
| 94 <td>Public method to prepare for an uninstallation.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#VcsMercurialPlugin.setPreferences">setPreferences</a></td> | |
| 97 <td>Public method to store the various settings.</td> | |
| 98 </tr> | |
| 99 </table> | |
| 100 <a NAME="VcsMercurialPlugin.__init__" ID="VcsMercurialPlugin.__init__"></a> | |
| 101 <h4>VcsMercurialPlugin (Constructor)</h4> | |
| 102 <b>VcsMercurialPlugin</b>(<i>ui</i>) | |
| 103 <p> | |
| 104 Constructor | |
| 105 </p><dl> | |
| 106 <dt><i>ui</i></dt> | |
| 107 <dd> | |
| 108 reference to the user interface object (UI.UserInterface) | |
| 109 </dd> | |
| 110 </dl><a NAME="VcsMercurialPlugin.activate" ID="VcsMercurialPlugin.activate"></a> | |
| 111 <h4>VcsMercurialPlugin.activate</h4> | |
| 112 <b>activate</b>(<i></i>) | |
| 113 <p> | |
| 114 Public method to activate this plugin. | |
| 115 </p><dl> | |
| 116 <dt>Returns:</dt> | |
| 117 <dd> | |
| 118 tuple of reference to instantiated viewmanager and | |
| 119 activation status (boolean) | |
| 120 </dd> | |
| 121 </dl><a NAME="VcsMercurialPlugin.deactivate" ID="VcsMercurialPlugin.deactivate"></a> | |
| 122 <h4>VcsMercurialPlugin.deactivate</h4> | |
| 123 <b>deactivate</b>(<i></i>) | |
| 124 <p> | |
| 125 Public method to deactivate this plugin. | |
| 126 </p><a NAME="VcsMercurialPlugin.getConfigPath" ID="VcsMercurialPlugin.getConfigPath"></a> | |
| 127 <h4>VcsMercurialPlugin.getConfigPath</h4> | |
| 128 <b>getConfigPath</b>(<i></i>) | |
| 129 <p> | |
| 130 Public method to get the filename of the config file. | |
| 131 </p><dl> | |
| 132 <dt>Returns:</dt> | |
| 133 <dd> | |
| 134 filename of the config file (string) | |
| 135 </dd> | |
| 136 </dl><a NAME="VcsMercurialPlugin.getPreferences" ID="VcsMercurialPlugin.getPreferences"></a> | |
| 137 <h4>VcsMercurialPlugin.getPreferences</h4> | |
| 138 <b>getPreferences</b>(<i>key</i>) | |
| 139 <p> | |
| 140 Public method to retrieve the various settings. | |
| 141 </p><dl> | |
| 142 <dt><i>key</i></dt> | |
| 143 <dd> | |
| 144 the key of the value to get | |
| 145 </dd> | |
| 146 </dl><dl> | |
| 147 <dt>Returns:</dt> | |
| 148 <dd> | |
| 149 the requested setting | |
| 150 </dd> | |
| 151 </dl><a NAME="VcsMercurialPlugin.getProjectHelper" ID="VcsMercurialPlugin.getProjectHelper"></a> | |
| 152 <h4>VcsMercurialPlugin.getProjectHelper</h4> | |
| 153 <b>getProjectHelper</b>(<i></i>) | |
| 154 <p> | |
| 155 Public method to get a reference to the project helper object. | |
| 156 </p><dl> | |
| 157 <dt>Returns:</dt> | |
| 158 <dd> | |
| 159 reference to the project helper object | |
| 160 </dd> | |
| 161 </dl><a NAME="VcsMercurialPlugin.prepareUninstall" ID="VcsMercurialPlugin.prepareUninstall"></a> | |
| 162 <h4>VcsMercurialPlugin.prepareUninstall</h4> | |
| 163 <b>prepareUninstall</b>(<i></i>) | |
| 164 <p> | |
| 165 Public method to prepare for an uninstallation. | |
| 166 </p><a NAME="VcsMercurialPlugin.setPreferences" ID="VcsMercurialPlugin.setPreferences"></a> | |
| 167 <h4>VcsMercurialPlugin.setPreferences</h4> | |
| 168 <b>setPreferences</b>(<i>key, value</i>) | |
| 169 <p> | |
| 170 Public method to store the various settings. | |
| 171 </p><dl> | |
| 172 <dt><i>key</i></dt> | |
| 173 <dd> | |
| 174 the key of the setting to be set | |
| 175 </dd><dt><i>value</i></dt> | |
| 176 <dd> | |
| 177 the value to be set | |
| 178 </dd> | |
| 179 </dl> | |
| 180 <div align="right"><a href="#top">Up</a></div> | |
| 181 <hr /><hr /> | |
| 182 <a NAME="createConfigurationPage" ID="createConfigurationPage"></a> | |
| 183 <h2>createConfigurationPage</h2> | |
| 184 <b>createConfigurationPage</b>(<i>configDlg</i>) | |
| 185 <p> | |
| 186 Module function to create the configuration page. | |
| 187 </p><dl> | |
| 188 <dt>Returns:</dt> | |
| 189 <dd> | |
| 190 reference to the configuration page | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <div align="right"><a href="#top">Up</a></div> | |
| 194 <hr /><hr /> | |
| 195 <a NAME="displayString" ID="displayString"></a> | |
| 196 <h2>displayString</h2> | |
| 197 <b>displayString</b>(<i></i>) | |
| 198 <p> | |
| 199 Public function to get the display string. | |
| 200 </p><dl> | |
| 201 <dt>Returns:</dt> | |
| 202 <dd> | |
| 203 display string (string) | |
| 204 </dd> | |
| 205 </dl> | |
| 206 <div align="right"><a href="#top">Up</a></div> | |
| 207 <hr /><hr /> | |
| 208 <a NAME="exeDisplayData" ID="exeDisplayData"></a> | |
| 209 <h2>exeDisplayData</h2> | |
| 210 <b>exeDisplayData</b>(<i></i>) | |
| 211 <p> | |
| 212 Public method to support the display of some executable info. | |
| 213 </p><dl> | |
| 214 <dt>Returns:</dt> | |
| 215 <dd> | |
| 216 dictionary containing the data to query the presence of | |
| 217 the executable | |
| 218 </dd> | |
| 219 </dl> | |
| 220 <div align="right"><a href="#top">Up</a></div> | |
| 221 <hr /><hr /> | |
| 222 <a NAME="getConfigData" ID="getConfigData"></a> | |
| 223 <h2>getConfigData</h2> | |
| 224 <b>getConfigData</b>(<i></i>) | |
| 225 <p> | |
| 226 Module function returning data as required by the configuration dialog. | |
| 227 </p><dl> | |
| 228 <dt>Returns:</dt> | |
| 229 <dd> | |
| 230 dictionary with key "zzz_mercurialPage" containing the relevant data | |
| 231 </dd> | |
| 232 </dl> | |
| 233 <div align="right"><a href="#top">Up</a></div> | |
| 234 <hr /><hr /> | |
| 235 <a NAME="getVcsSystemIndicator" ID="getVcsSystemIndicator"></a> | |
| 236 <h2>getVcsSystemIndicator</h2> | |
| 237 <b>getVcsSystemIndicator</b>(<i></i>) | |
| 238 <p> | |
| 239 Public function to get the indicators for this version control system. | |
| 240 </p><dl> | |
| 241 <dt>Returns:</dt> | |
| 242 <dd> | |
| 243 dictionary with indicator as key and a tuple with the vcs name (string) | |
| 244 and vcs display string (string) | |
| 245 </dd> | |
| 246 </dl> | |
| 247 <div align="right"><a href="#top">Up</a></div> | |
| 248 <hr /><hr /> | |
| 249 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | |
| 250 <h2>prepareUninstall</h2> | |
| 251 <b>prepareUninstall</b>(<i></i>) | |
| 252 <p> | |
| 253 Module function to prepare for an uninstallation. | |
| 254 </p> | |
| 255 <div align="right"><a href="#top">Up</a></div> | |
| 256 <hr /> | |
| 257 </body></html> |
