|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.Plugins.VcsPlugins.vcsGit.GitUtilities</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.vcsGit.GitUtilities</h1> |
|
23 <p> |
|
24 Module implementing some common utility functions for the Git 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="#prepareProcess">prepareProcess</a></td> |
|
41 <td>Public function to prepare the given process.</td> |
|
42 </tr><tr> |
|
43 <td><a href="#strToQByteArray">strToQByteArray</a></td> |
|
44 <td>Module function to convert a Python string into a QByteArray.</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="prepareProcess" ID="prepareProcess"></a> |
|
62 <h2>prepareProcess</h2> |
|
63 <b>prepareProcess</b>(<i>proc, language=""</i>) |
|
64 <p> |
|
65 Public function to prepare the given process. |
|
66 </p><dl> |
|
67 <dt><i>proc</i></dt> |
|
68 <dd> |
|
69 reference to the process to be prepared (QProcess) |
|
70 </dd><dt><i>language</i></dt> |
|
71 <dd> |
|
72 language to be set (string) |
|
73 </dd> |
|
74 </dl> |
|
75 <div align="right"><a href="#top">Up</a></div> |
|
76 <hr /><hr /> |
|
77 <a NAME="strToQByteArray" ID="strToQByteArray"></a> |
|
78 <h2>strToQByteArray</h2> |
|
79 <b>strToQByteArray</b>(<i>txt</i>) |
|
80 <p> |
|
81 Module function to convert a Python string into a QByteArray. |
|
82 </p><dl> |
|
83 <dt><i>txt</i> (str, bytes, bytearray, unicode)</dt> |
|
84 <dd> |
|
85 Python string to be converted |
|
86 </dd> |
|
87 </dl> |
|
88 <div align="right"><a href="#top">Up</a></div> |
|
89 <hr /> |
|
90 </body></html> |