--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitUtilities.html Sun Dec 10 17:42:11 2017 +0100 @@ -0,0 +1,90 @@ +<!DOCTYPE html> +<html><head> +<title>eric6.Plugins.VcsPlugins.vcsGit.GitUtilities</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>eric6.Plugins.VcsPlugins.vcsGit.GitUtilities</h1> +<p> +Module implementing some common utility functions for the Git package. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> +<table> +<tr> +<td><a href="#getConfigPath">getConfigPath</a></td> +<td>Public function to get the filename of the config file.</td> +</tr><tr> +<td><a href="#prepareProcess">prepareProcess</a></td> +<td>Public function to prepare the given process.</td> +</tr><tr> +<td><a href="#strToQByteArray">strToQByteArray</a></td> +<td>Module function to convert a Python string into a QByteArray.</td> +</tr> +</table> +<hr /><hr /> +<a NAME="getConfigPath" ID="getConfigPath"></a> +<h2>getConfigPath</h2> +<b>getConfigPath</b>(<i></i>) +<p> + Public function to get the filename of the config file. +</p><dl> +<dt>Returns:</dt> +<dd> +filename of the config file (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="prepareProcess" ID="prepareProcess"></a> +<h2>prepareProcess</h2> +<b>prepareProcess</b>(<i>proc, language=""</i>) +<p> + Public function to prepare the given process. +</p><dl> +<dt><i>proc</i></dt> +<dd> +reference to the proces to be prepared (QProcess) +</dd><dt><i>language</i></dt> +<dd> +language to be set (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="strToQByteArray" ID="strToQByteArray"></a> +<h2>strToQByteArray</h2> +<b>strToQByteArray</b>(<i>txt</i>) +<p> + Module function to convert a Python string into a QByteArray. +</p><dl> +<dt><i>txt</i> (str, bytes, bytearray, unicode)</dt> +<dd> +Python string to be converted +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file