ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.AnsiTools.html

changeset 19
f8e3c1676f9b
child 61
fe1e8783a95f
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ProjectFlask/Documentation/source/Plugin_Project_Flask.ProjectFlask.AnsiTools.html	Sun Nov 22 14:12:44 2020 +0100
@@ -0,0 +1,107 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Project_Flask.ProjectFlask.AnsiTools</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>Plugin_Project_Flask.ProjectFlask.AnsiTools</h1>
+
+<p>
+Module implementing functions to work with ANSI escape sequences for colors.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>_AnsiColorSchemes</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#getAvailableColorSchemes">getAvailableColorSchemes</a></td>
+<td>Function to get a list of available color schemes.</td>
+</tr>
+<tr>
+<td><a href="#getColor">getColor</a></td>
+<td>Function to get the brush for a given scheme and color.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="getAvailableColorSchemes" ID="getAvailableColorSchemes"></a>
+<h2>getAvailableColorSchemes</h2>
+<b>getAvailableColorSchemes</b>(<i></i>)
+
+<p>
+    Function to get a list of available color schemes.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+list containing the names of the supported color schemes
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getColor" ID="getColor"></a>
+<h2>getColor</h2>
+<b>getColor</b>(<i>scheme, color</i>)
+
+<p>
+    Function to get the brush for a given scheme and color.
+</p>
+<dl>
+
+<dt><i>scheme</i> (str)</dt>
+<dd>
+name of the color scheme
+</dd>
+<dt><i>color</i> (int)</dt>
+<dd>
+ANSI color code
+</dd>
+</dl>
+<dl>
+<dt>Returns:</dt>
+<dd>
+brush for the given parameters or None in case of error
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QBrush or None
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial