Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.PluginVcsMercurial.html
src/eric7/Documentation/Source/eric7.Plugins.PluginVcsMercurial.html
- branch
- eric7
- changeset 10437
- 2f70ca07f0af
- parent 10259
- b51dfacef37f
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10436:f6881d10e995 | 10437:2f70ca07f0af |
|---|---|
| 140 <p> | 140 <p> |
| 141 Class method to retrieve the various settings. | 141 Class method to retrieve the various settings. |
| 142 </p> | 142 </p> |
| 143 <dl> | 143 <dl> |
| 144 | 144 |
| 145 <dt><i>key</i></dt> | 145 <dt><i>key</i> (str)</dt> |
| 146 <dd> | 146 <dd> |
| 147 the key of the value to get | 147 the key of the value to get |
| 148 </dd> | 148 </dd> |
| 149 </dl> | 149 </dl> |
| 150 <dl> | 150 <dl> |
| 151 <dt>Return:</dt> | 151 <dt>Return:</dt> |
| 152 <dd> | 152 <dd> |
| 153 the requested setting | 153 the requested setting |
| 154 </dd> | |
| 155 </dl> | |
| 156 <dl> | |
| 157 <dt>Return Type:</dt> | |
| 158 <dd> | |
| 159 Any | |
| 154 </dd> | 160 </dd> |
| 155 </dl> | 161 </dl> |
| 156 <a NAME="VcsMercurialPlugin.setPreferences" ID="VcsMercurialPlugin.setPreferences"></a> | 162 <a NAME="VcsMercurialPlugin.setPreferences" ID="VcsMercurialPlugin.setPreferences"></a> |
| 157 <h4>VcsMercurialPlugin.setPreferences (class method)</h4> | 163 <h4>VcsMercurialPlugin.setPreferences (class method)</h4> |
| 158 <b>setPreferences</b>(<i>key, value</i>) | 164 <b>setPreferences</b>(<i>key, value</i>) |
| 160 <p> | 166 <p> |
| 161 Class method to store the various settings. | 167 Class method to store the various settings. |
| 162 </p> | 168 </p> |
| 163 <dl> | 169 <dl> |
| 164 | 170 |
| 165 <dt><i>key</i></dt> | 171 <dt><i>key</i> (str)</dt> |
| 166 <dd> | 172 <dd> |
| 167 the key of the setting to be set | 173 the key of the setting to be set |
| 168 </dd> | 174 </dd> |
| 169 <dt><i>value</i></dt> | 175 <dt><i>value</i> (Any)</dt> |
| 170 <dd> | 176 <dd> |
| 171 the value to be set | 177 the value to be set |
| 172 </dd> | 178 </dd> |
| 173 </dl> | 179 </dl> |
| 174 <a NAME="VcsMercurialPlugin.__init__" ID="VcsMercurialPlugin.__init__"></a> | 180 <a NAME="VcsMercurialPlugin.__init__" ID="VcsMercurialPlugin.__init__"></a> |
| 178 <p> | 184 <p> |
| 179 Constructor | 185 Constructor |
| 180 </p> | 186 </p> |
| 181 <dl> | 187 <dl> |
| 182 | 188 |
| 183 <dt><i>ui</i></dt> | 189 <dt><i>ui</i> (UserInterface)</dt> |
| 184 <dd> | 190 <dd> |
| 185 reference to the user interface object (UI.UserInterface) | 191 reference to the user interface object |
| 186 </dd> | 192 </dd> |
| 187 </dl> | 193 </dl> |
| 188 <a NAME="VcsMercurialPlugin.activate" ID="VcsMercurialPlugin.activate"></a> | 194 <a NAME="VcsMercurialPlugin.activate" ID="VcsMercurialPlugin.activate"></a> |
| 189 <h4>VcsMercurialPlugin.activate</h4> | 195 <h4>VcsMercurialPlugin.activate</h4> |
| 190 <b>activate</b>(<i></i>) | 196 <b>activate</b>(<i></i>) |
| 194 </p> | 200 </p> |
| 195 <dl> | 201 <dl> |
| 196 <dt>Return:</dt> | 202 <dt>Return:</dt> |
| 197 <dd> | 203 <dd> |
| 198 tuple of reference to instantiated viewmanager and | 204 tuple of reference to instantiated viewmanager and |
| 199 activation status (boolean) | 205 activation status |
| 206 </dd> | |
| 207 </dl> | |
| 208 <dl> | |
| 209 <dt>Return Type:</dt> | |
| 210 <dd> | |
| 211 tuple of (Hg, bool) | |
| 200 </dd> | 212 </dd> |
| 201 </dl> | 213 </dl> |
| 202 <a NAME="VcsMercurialPlugin.deactivate" ID="VcsMercurialPlugin.deactivate"></a> | 214 <a NAME="VcsMercurialPlugin.deactivate" ID="VcsMercurialPlugin.deactivate"></a> |
| 203 <h4>VcsMercurialPlugin.deactivate</h4> | 215 <h4>VcsMercurialPlugin.deactivate</h4> |
| 204 <b>deactivate</b>(<i></i>) | 216 <b>deactivate</b>(<i></i>) |
| 214 Public method to get the filename of the config file. | 226 Public method to get the filename of the config file. |
| 215 </p> | 227 </p> |
| 216 <dl> | 228 <dl> |
| 217 <dt>Return:</dt> | 229 <dt>Return:</dt> |
| 218 <dd> | 230 <dd> |
| 219 filename of the config file (string) | 231 filename of the config file |
| 232 </dd> | |
| 233 </dl> | |
| 234 <dl> | |
| 235 <dt>Return Type:</dt> | |
| 236 <dd> | |
| 237 str | |
| 220 </dd> | 238 </dd> |
| 221 </dl> | 239 </dl> |
| 222 <a NAME="VcsMercurialPlugin.getGlobalOptions" ID="VcsMercurialPlugin.getGlobalOptions"></a> | 240 <a NAME="VcsMercurialPlugin.getGlobalOptions" ID="VcsMercurialPlugin.getGlobalOptions"></a> |
| 223 <h4>VcsMercurialPlugin.getGlobalOptions</h4> | 241 <h4>VcsMercurialPlugin.getGlobalOptions</h4> |
| 224 <b>getGlobalOptions</b>(<i></i>) | 242 <b>getGlobalOptions</b>(<i></i>) |
| 227 Public method to build a list of global options. | 245 Public method to build a list of global options. |
| 228 </p> | 246 </p> |
| 229 <dl> | 247 <dl> |
| 230 <dt>Return:</dt> | 248 <dt>Return:</dt> |
| 231 <dd> | 249 <dd> |
| 232 list of global options (list of string) | 250 list of global options |
| 251 </dd> | |
| 252 </dl> | |
| 253 <dl> | |
| 254 <dt>Return Type:</dt> | |
| 255 <dd> | |
| 256 list of str | |
| 233 </dd> | 257 </dd> |
| 234 </dl> | 258 </dl> |
| 235 <a NAME="VcsMercurialPlugin.getProjectHelper" ID="VcsMercurialPlugin.getProjectHelper"></a> | 259 <a NAME="VcsMercurialPlugin.getProjectHelper" ID="VcsMercurialPlugin.getProjectHelper"></a> |
| 236 <h4>VcsMercurialPlugin.getProjectHelper</h4> | 260 <h4>VcsMercurialPlugin.getProjectHelper</h4> |
| 237 <b>getProjectHelper</b>(<i></i>) | 261 <b>getProjectHelper</b>(<i></i>) |
| 243 <dt>Return:</dt> | 267 <dt>Return:</dt> |
| 244 <dd> | 268 <dd> |
| 245 reference to the project helper object | 269 reference to the project helper object |
| 246 </dd> | 270 </dd> |
| 247 </dl> | 271 </dl> |
| 272 <dl> | |
| 273 <dt>Return Type:</dt> | |
| 274 <dd> | |
| 275 HgProjectHelper | |
| 276 </dd> | |
| 277 </dl> | |
| 248 <a NAME="VcsMercurialPlugin.initToolbar" ID="VcsMercurialPlugin.initToolbar"></a> | 278 <a NAME="VcsMercurialPlugin.initToolbar" ID="VcsMercurialPlugin.initToolbar"></a> |
| 249 <h4>VcsMercurialPlugin.initToolbar</h4> | 279 <h4>VcsMercurialPlugin.initToolbar</h4> |
| 250 <b>initToolbar</b>(<i>ui, toolbarManager</i>) | 280 <b>initToolbar</b>(<i>ui, toolbarManager</i>) |
| 251 | 281 |
| 252 <p> | 282 <p> |
| 253 Public slot to initialize the VCS toolbar. | 283 Public slot to initialize the VCS toolbar. |
| 254 </p> | 284 </p> |
| 255 <dl> | 285 <dl> |
| 256 | 286 |
| 257 <dt><i>ui</i></dt> | 287 <dt><i>ui</i> (UserInterface)</dt> |
| 258 <dd> | 288 <dd> |
| 259 reference to the main window (UserInterface) | 289 reference to the main window |
| 260 </dd> | 290 </dd> |
| 261 <dt><i>toolbarManager</i></dt> | 291 <dt><i>toolbarManager</i> (EricToolBarManager)</dt> |
| 262 <dd> | 292 <dd> |
| 263 reference to a toolbar manager object | 293 reference to a toolbar manager object |
| 264 (EricToolBarManager) | |
| 265 </dd> | 294 </dd> |
| 266 </dl> | 295 </dl> |
| 267 <a NAME="VcsMercurialPlugin.prepareUninstall" ID="VcsMercurialPlugin.prepareUninstall"></a> | 296 <a NAME="VcsMercurialPlugin.prepareUninstall" ID="VcsMercurialPlugin.prepareUninstall"></a> |
| 268 <h4>VcsMercurialPlugin.prepareUninstall</h4> | 297 <h4>VcsMercurialPlugin.prepareUninstall</h4> |
| 269 <b>prepareUninstall</b>(<i></i>) | 298 <b>prepareUninstall</b>(<i></i>) |
| 298 <p> | 327 <p> |
| 299 Module function to create the configuration page. | 328 Module function to create the configuration page. |
| 300 </p> | 329 </p> |
| 301 <dl> | 330 <dl> |
| 302 | 331 |
| 303 <dt><i>configDlg</i></dt> | 332 <dt><i>configDlg</i> (QDialog)</dt> |
| 304 <dd> | 333 <dd> |
| 305 reference to the configuration dialog (QDialog) | 334 reference to the configuration dialog |
| 306 </dd> | 335 </dd> |
| 307 </dl> | 336 </dl> |
| 308 <dl> | 337 <dl> |
| 309 <dt>Return:</dt> | 338 <dt>Return:</dt> |
| 310 <dd> | 339 <dd> |
| 311 reference to the configuration page | 340 reference to the configuration page |
| 341 </dd> | |
| 342 </dl> | |
| 343 <dl> | |
| 344 <dt>Return Type:</dt> | |
| 345 <dd> | |
| 346 MercurialPage | |
| 312 </dd> | 347 </dd> |
| 313 </dl> | 348 </dl> |
| 314 <div align="right"><a href="#top">Up</a></div> | 349 <div align="right"><a href="#top">Up</a></div> |
| 315 <hr /> | 350 <hr /> |
| 316 <hr /> | 351 <hr /> |
| 322 Public function to get the display string. | 357 Public function to get the display string. |
| 323 </p> | 358 </p> |
| 324 <dl> | 359 <dl> |
| 325 <dt>Return:</dt> | 360 <dt>Return:</dt> |
| 326 <dd> | 361 <dd> |
| 327 display string (string) | 362 display string |
| 363 </dd> | |
| 364 </dl> | |
| 365 <dl> | |
| 366 <dt>Return Type:</dt> | |
| 367 <dd> | |
| 368 str | |
| 328 </dd> | 369 </dd> |
| 329 </dl> | 370 </dl> |
| 330 <div align="right"><a href="#top">Up</a></div> | 371 <div align="right"><a href="#top">Up</a></div> |
| 331 <hr /> | 372 <hr /> |
| 332 <hr /> | 373 <hr /> |
| 342 <dd> | 383 <dd> |
| 343 dictionary containing the data to query the presence of | 384 dictionary containing the data to query the presence of |
| 344 the executable | 385 the executable |
| 345 </dd> | 386 </dd> |
| 346 </dl> | 387 </dl> |
| 388 <dl> | |
| 389 <dt>Return Type:</dt> | |
| 390 <dd> | |
| 391 dict | |
| 392 </dd> | |
| 393 </dl> | |
| 347 <div align="right"><a href="#top">Up</a></div> | 394 <div align="right"><a href="#top">Up</a></div> |
| 348 <hr /> | 395 <hr /> |
| 349 <hr /> | 396 <hr /> |
| 350 <a NAME="getConfigData" ID="getConfigData"></a> | 397 <a NAME="getConfigData" ID="getConfigData"></a> |
| 351 <h2>getConfigData</h2> | 398 <h2>getConfigData</h2> |
| 355 Module function returning data as required by the configuration dialog. | 402 Module function returning data as required by the configuration dialog. |
| 356 </p> | 403 </p> |
| 357 <dl> | 404 <dl> |
| 358 <dt>Return:</dt> | 405 <dt>Return:</dt> |
| 359 <dd> | 406 <dd> |
| 360 dictionary with key "zzz_mercurialPage" containing the relevant | 407 dictionary with key "zzz_mercurialPage" containing the relevant data |
| 361 data | 408 </dd> |
| 409 </dl> | |
| 410 <dl> | |
| 411 <dt>Return Type:</dt> | |
| 412 <dd> | |
| 413 dict | |
| 362 </dd> | 414 </dd> |
| 363 </dl> | 415 </dl> |
| 364 <div align="right"><a href="#top">Up</a></div> | 416 <div align="right"><a href="#top">Up</a></div> |
| 365 <hr /> | 417 <hr /> |
| 366 <hr /> | 418 <hr /> |
| 373 </p> | 425 </p> |
| 374 <dl> | 426 <dl> |
| 375 <dt>Return:</dt> | 427 <dt>Return:</dt> |
| 376 <dd> | 428 <dd> |
| 377 dictionary with indicator as key and a tuple with the vcs name | 429 dictionary with indicator as key and a tuple with the vcs name |
| 378 (string) and vcs display string (string) | 430 and vcs display string |
| 431 </dd> | |
| 432 </dl> | |
| 433 <dl> | |
| 434 <dt>Return Type:</dt> | |
| 435 <dd> | |
| 436 dict | |
| 379 </dd> | 437 </dd> |
| 380 </dl> | 438 </dl> |
| 381 <div align="right"><a href="#top">Up</a></div> | 439 <div align="right"><a href="#top">Up</a></div> |
| 382 <hr /> | 440 <hr /> |
| 383 <hr /> | 441 <hr /> |
