5 <link rel="stylesheet" href="styles.css"> |
5 <link rel="stylesheet" href="styles.css"> |
6 </head> |
6 </head> |
7 <body> |
7 <body> |
8 <a NAME="top" ID="top"></a> |
8 <a NAME="top" ID="top"></a> |
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgUtilities</h1> |
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgUtilities</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing some common utility functions for the Mercurial package. |
11 Module implementing some common utility functions for the Mercurial package. |
13 </p> |
12 </p> |
|
13 |
14 <h3>Global Attributes</h3> |
14 <h3>Global Attributes</h3> |
15 |
|
16 <table> |
15 <table> |
17 <tr><td>None</td></tr> |
16 <tr><td>None</td></tr> |
18 </table> |
17 </table> |
|
18 |
19 <h3>Classes</h3> |
19 <h3>Classes</h3> |
20 |
|
21 <table> |
20 <table> |
22 <tr><td>None</td></tr> |
21 <tr><td>None</td></tr> |
23 </table> |
22 </table> |
|
23 |
24 <h3>Functions</h3> |
24 <h3>Functions</h3> |
25 |
|
26 <table> |
25 <table> |
27 |
|
28 <tr> |
26 <tr> |
29 <td><a href="#getConfigPath">getConfigPath</a></td> |
27 <td><a href="#getConfigPath">getConfigPath</a></td> |
30 <td>Function to get the filename of the config file.</td> |
28 <td>Function to get the filename of the config file.</td> |
31 </tr> |
29 </tr> |
32 <tr> |
30 <tr> |
40 <tr> |
38 <tr> |
41 <td><a href="#prepareProcess">prepareProcess</a></td> |
39 <td><a href="#prepareProcess">prepareProcess</a></td> |
42 <td>Function to prepare the given process.</td> |
40 <td>Function to prepare the given process.</td> |
43 </tr> |
41 </tr> |
44 </table> |
42 </table> |
|
43 |
45 <hr /> |
44 <hr /> |
46 <hr /> |
45 <hr /> |
47 <a NAME="getConfigPath" ID="getConfigPath"></a> |
46 <a NAME="getConfigPath" ID="getConfigPath"></a> |
48 <h2>getConfigPath</h2> |
47 <h2>getConfigPath</h2> |
49 <b>getConfigPath</b>(<i></i>) |
48 <b>getConfigPath</b>(<i></i>) |
50 |
|
51 <p> |
49 <p> |
52 Function to get the filename of the config file. |
50 Function to get the filename of the config file. |
53 </p> |
51 </p> |
|
52 |
54 <dl> |
53 <dl> |
55 <dt>Return:</dt> |
54 <dt>Return:</dt> |
56 <dd> |
55 <dd> |
57 filename of the config file |
56 filename of the config file |
58 </dd> |
57 </dd> |
67 <hr /> |
66 <hr /> |
68 <hr /> |
67 <hr /> |
69 <a NAME="getHgExecutable" ID="getHgExecutable"></a> |
68 <a NAME="getHgExecutable" ID="getHgExecutable"></a> |
70 <h2>getHgExecutable</h2> |
69 <h2>getHgExecutable</h2> |
71 <b>getHgExecutable</b>(<i></i>) |
70 <b>getHgExecutable</b>(<i></i>) |
72 |
|
73 <p> |
71 <p> |
74 Function to get the full path of the Mercurial executable. |
72 Function to get the full path of the Mercurial executable. |
75 </p> |
73 </p> |
|
74 |
76 <dl> |
75 <dl> |
77 <dt>Return:</dt> |
76 <dt>Return:</dt> |
78 <dd> |
77 <dd> |
79 path of the Mercurial executable |
78 path of the Mercurial executable |
80 </dd> |
79 </dd> |
89 <hr /> |
88 <hr /> |
90 <hr /> |
89 <hr /> |
91 <a NAME="hgVersion" ID="hgVersion"></a> |
90 <a NAME="hgVersion" ID="hgVersion"></a> |
92 <h2>hgVersion</h2> |
91 <h2>hgVersion</h2> |
93 <b>hgVersion</b>(<i>plugin</i>) |
92 <b>hgVersion</b>(<i>plugin</i>) |
94 |
|
95 <p> |
93 <p> |
96 Public method to determine the Mercurial version. |
94 Public method to determine the Mercurial version. |
97 </p> |
95 </p> |
|
96 |
98 <dl> |
97 <dl> |
99 |
98 |
100 <dt><i>plugin</i> (VcsMercurialPlugin)</dt> |
99 <dt><i>plugin</i> (VcsMercurialPlugin)</dt> |
101 <dd> |
100 <dd> |
102 reference to the plugin object |
101 reference to the plugin object |
119 <hr /> |
118 <hr /> |
120 <hr /> |
119 <hr /> |
121 <a NAME="prepareProcess" ID="prepareProcess"></a> |
120 <a NAME="prepareProcess" ID="prepareProcess"></a> |
122 <h2>prepareProcess</h2> |
121 <h2>prepareProcess</h2> |
123 <b>prepareProcess</b>(<i>proc, encoding="", language=""</i>) |
122 <b>prepareProcess</b>(<i>proc, encoding="", language=""</i>) |
124 |
|
125 <p> |
123 <p> |
126 Function to prepare the given process. |
124 Function to prepare the given process. |
127 </p> |
125 </p> |
|
126 |
128 <dl> |
127 <dl> |
129 |
128 |
130 <dt><i>proc</i> (QProcess)</dt> |
129 <dt><i>proc</i> (QProcess)</dt> |
131 <dd> |
130 <dd> |
132 reference to the process to be prepared |
131 reference to the process to be prepared |