Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html
eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html
- changeset 6942
- 2602857055c5
- parent 6062
- 926d2ad79e6d
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Plugins.VcsPlugins.vcsMercurial.HgUtilities</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.HgUtilities</h1> | |
| 23 <p> | |
| 24 Module implementing some common utility functions for the Mercurial package. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <h3>Functions</h3> | |
| 35 <table> | |
| 36 <tr> | |
| 37 <td><a href="#getConfigPath">getConfigPath</a></td> | |
| 38 <td>Public function to get the filename of the config file.</td> | |
| 39 </tr><tr> | |
| 40 <td><a href="#hgVersion">hgVersion</a></td> | |
| 41 <td>Public method to determine the Mercurial version.</td> | |
| 42 </tr><tr> | |
| 43 <td><a href="#prepareProcess">prepareProcess</a></td> | |
| 44 <td>Public function to prepare the given process.</td> | |
| 45 </tr> | |
| 46 </table> | |
| 47 <hr /><hr /> | |
| 48 <a NAME="getConfigPath" ID="getConfigPath"></a> | |
| 49 <h2>getConfigPath</h2> | |
| 50 <b>getConfigPath</b>(<i></i>) | |
| 51 <p> | |
| 52 Public function to get the filename of the config file. | |
| 53 </p><dl> | |
| 54 <dt>Returns:</dt> | |
| 55 <dd> | |
| 56 filename of the config file (string) | |
| 57 </dd> | |
| 58 </dl> | |
| 59 <div align="right"><a href="#top">Up</a></div> | |
| 60 <hr /><hr /> | |
| 61 <a NAME="hgVersion" ID="hgVersion"></a> | |
| 62 <h2>hgVersion</h2> | |
| 63 <b>hgVersion</b>(<i>plugin</i>) | |
| 64 <p> | |
| 65 Public method to determine the Mercurial version. | |
| 66 </p><dl> | |
| 67 <dt><i>plugin</i> (VcsMercurialPlugin)</dt> | |
| 68 <dd> | |
| 69 reference to the plugin object | |
| 70 </dd> | |
| 71 </dl><dl> | |
| 72 <dt>Returns:</dt> | |
| 73 <dd> | |
| 74 tuple containing the Mercurial version as a string and as a tuple | |
| 75 and an error message. | |
| 76 </dd> | |
| 77 </dl><dl> | |
| 78 <dt>Return Type:</dt> | |
| 79 <dd> | |
| 80 tuple of str, tuple of int and str | |
| 81 </dd> | |
| 82 </dl> | |
| 83 <div align="right"><a href="#top">Up</a></div> | |
| 84 <hr /><hr /> | |
| 85 <a NAME="prepareProcess" ID="prepareProcess"></a> | |
| 86 <h2>prepareProcess</h2> | |
| 87 <b>prepareProcess</b>(<i>proc, encoding="", language=""</i>) | |
| 88 <p> | |
| 89 Public function to prepare the given process. | |
| 90 </p><dl> | |
| 91 <dt><i>proc</i></dt> | |
| 92 <dd> | |
| 93 reference to the process to be prepared (QProcess) | |
| 94 </dd><dt><i>encoding</i></dt> | |
| 95 <dd> | |
| 96 encoding to be used by the process (string) | |
| 97 </dd><dt><i>language</i></dt> | |
| 98 <dd> | |
| 99 language to be set (string) | |
| 100 </dd> | |
| 101 </dl> | |
| 102 <div align="right"><a href="#top">Up</a></div> | |
| 103 <hr /> | |
| 104 </body></html> |
