ProjectWeb/Documentation/source/Plugin_Project_Web.ProjectWeb.Html5ToJsConverter.html

changeset 7
e6fbd4a7484d
child 30
38092622e612
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ProjectWeb/Documentation/source/Plugin_Project_Web.ProjectWeb.Html5ToJsConverter.html	Mon Mar 16 19:41:53 2015 +0100
@@ -0,0 +1,133 @@
+<!DOCTYPE html>
+<html><head>
+<title>Plugin_Project_Web.ProjectWeb.Html5ToJsConverter</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.Html5ToJsConverter</h1>
+<p>
+Module implementing the HTML5 to JavaScript converter.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#Html5ToJsConverter">Html5ToJsConverter</a></td>
+<td>Class implementing the HTML5 to JavaScript converter.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="Html5ToJsConverter" ID="Html5ToJsConverter"></a>
+<h2>Html5ToJsConverter</h2>
+<p>
+    Class implementing the HTML5 to JavaScript converter.
+</p>
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+<table>
+<tr><td>JsTemplate8</td></tr><tr><td>TagsToIgnore</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#Html5ToJsConverter.__init__">Html5ToJsConverter</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#Html5ToJsConverter.__createSoup">__createSoup</a></td>
+<td>Private method to get a BeaitifulSoup object with our HTML text.</td>
+</tr><tr>
+<td><a href="#Html5ToJsConverter.__getClasses">__getClasses</a></td>
+<td>Private method to extract all classes of the HTML text.</td>
+</tr><tr>
+<td><a href="#Html5ToJsConverter.__getIds">__getIds</a></td>
+<td>Private method to extract all IDs of the HTML text.</td>
+</tr><tr>
+<td><a href="#Html5ToJsConverter.getJavaScript">getJavaScript</a></td>
+<td>Public method to get the converted JavaScript text.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="Html5ToJsConverter.__init__" ID="Html5ToJsConverter.__init__"></a>
+<h4>Html5ToJsConverter (Constructor)</h4>
+<b>Html5ToJsConverter</b>(<i>html, parent=None</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>html</i></dt>
+<dd>
+HTML text to be converted (string)
+</dd><dt><i>parent</i></dt>
+<dd>
+reference to the parent object (QObject)
+</dd>
+</dl><a NAME="Html5ToJsConverter.__createSoup" ID="Html5ToJsConverter.__createSoup"></a>
+<h4>Html5ToJsConverter.__createSoup</h4>
+<b>__createSoup</b>(<i></i>)
+<p>
+        Private method to get a BeaitifulSoup object with our HTML text.
+</p><a NAME="Html5ToJsConverter.__getClasses" ID="Html5ToJsConverter.__getClasses"></a>
+<h4>Html5ToJsConverter.__getClasses</h4>
+<b>__getClasses</b>(<i></i>)
+<p>
+        Private method to extract all classes of the HTML text.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of tuples containing the tag name and its classes
+            as a blank separated string (list of tuples of two strings)
+</dd>
+</dl><a NAME="Html5ToJsConverter.__getIds" ID="Html5ToJsConverter.__getIds"></a>
+<h4>Html5ToJsConverter.__getIds</h4>
+<b>__getIds</b>(<i></i>)
+<p>
+        Private method to extract all IDs of the HTML text.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of tuples containing the tag name and its ID
+            (list of tuples of two strings)
+</dd>
+</dl><a NAME="Html5ToJsConverter.getJavaScript" ID="Html5ToJsConverter.getJavaScript"></a>
+<h4>Html5ToJsConverter.getJavaScript</h4>
+<b>getJavaScript</b>(<i></i>)
+<p>
+        Public method to get the converted JavaScript text.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+JavaScript text (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial