diff -r a1600fa29542 -r e6fbd4a7484d ProjectWeb/Documentation/source/Plugin_Project_Web.ProjectWeb.Html5Prettifier.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectWeb/Documentation/source/Plugin_Project_Web.ProjectWeb.Html5Prettifier.html Mon Mar 16 19:41:53 2015 +0100 @@ -0,0 +1,133 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Project_Web.ProjectWeb.Html5Prettifier</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_Web.ProjectWeb.Html5Prettifier</h1> +<p> +Module implementing a class to prettify HTML code. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#Html5Prettifier">Html5Prettifier</a></td> +<td>Class implementing the HTML5 prettifier.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="Html5Prettifier" ID="Html5Prettifier"></a> +<h2>Html5Prettifier</h2> +<p> + Class implementing the HTML5 prettifier. +</p> +<h3>Derived from</h3> +QObject +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#Html5Prettifier.__init__">Html5Prettifier</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#Html5Prettifier.commentPrettify">commentPrettify</a></td> +<td>Public method to prettify HTML comments.</td> +</tr><tr> +<td><a href="#Html5Prettifier.getPrettifiedHtml">getPrettifiedHtml</a></td> +<td>Public method to prettify the HTML code.</td> +</tr><tr> +<td><a href="#Html5Prettifier.tagPrettify">tagPrettify</a></td> +<td>Public method to prettify HTML tags.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="Html5Prettifier.__init__" ID="Html5Prettifier.__init__"></a> +<h4>Html5Prettifier (Constructor)</h4> +<b>Html5Prettifier</b>(<i>html, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>html</i></dt> +<dd> +HTML text to be prettified (string) +</dd><dt><i>parent</i></dt> +<dd> +reference to the parent object (QObject) +</dd> +</dl><a NAME="Html5Prettifier.commentPrettify" ID="Html5Prettifier.commentPrettify"></a> +<h4>Html5Prettifier.commentPrettify</h4> +<b>commentPrettify</b>(<i>matchobj</i>) +<p> + Public method to prettify HTML comments. +</p><dl> +<dt><i>matchobj</i></dt> +<dd> +reference to the match object (re.MatchObject) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +prettified comment (string) +</dd> +</dl><a NAME="Html5Prettifier.getPrettifiedHtml" ID="Html5Prettifier.getPrettifiedHtml"></a> +<h4>Html5Prettifier.getPrettifiedHtml</h4> +<b>getPrettifiedHtml</b>(<i></i>) +<p> + Public method to prettify the HTML code. +</p><dl> +<dt>Returns:</dt> +<dd> +prettified HTML code (string) +</dd> +</dl><a NAME="Html5Prettifier.tagPrettify" ID="Html5Prettifier.tagPrettify"></a> +<h4>Html5Prettifier.tagPrettify</h4> +<b>tagPrettify</b>(<i>tag</i>) +<p> + Public method to prettify HTML tags. +</p><dl> +<dt><i>tag</i></dt> +<dd> +tag to be prettified (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +prettified tag (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file