|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>Plugin_Project_Web.ProjectWeb.Html5ToJsConverter</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>Plugin_Project_Web.ProjectWeb.Html5ToJsConverter</h1> |
|
23 <p> |
|
24 Module implementing the HTML5 to JavaScript converter. |
|
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> |
|
33 <td><a href="#Html5ToJsConverter">Html5ToJsConverter</a></td> |
|
34 <td>Class implementing the HTML5 to JavaScript converter.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="Html5ToJsConverter" ID="Html5ToJsConverter"></a> |
|
43 <h2>Html5ToJsConverter</h2> |
|
44 <p> |
|
45 Class implementing the HTML5 to JavaScript converter. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QObject |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>JsTemplate8</td></tr><tr><td>TagsToIgnore</td></tr> |
|
52 </table> |
|
53 <h3>Class Methods</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#Html5ToJsConverter.__init__">Html5ToJsConverter</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#Html5ToJsConverter.__createSoup">__createSoup</a></td> |
|
64 <td>Private method to get a BeaitifulSoup object with our HTML text.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#Html5ToJsConverter.__getClasses">__getClasses</a></td> |
|
67 <td>Private method to extract all classes of the HTML text.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#Html5ToJsConverter.__getIds">__getIds</a></td> |
|
70 <td>Private method to extract all IDs of the HTML text.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#Html5ToJsConverter.getJavaScript">getJavaScript</a></td> |
|
73 <td>Public method to get the converted JavaScript text.</td> |
|
74 </tr> |
|
75 </table> |
|
76 <h3>Static Methods</h3> |
|
77 <table> |
|
78 <tr><td>None</td></tr> |
|
79 </table> |
|
80 <a NAME="Html5ToJsConverter.__init__" ID="Html5ToJsConverter.__init__"></a> |
|
81 <h4>Html5ToJsConverter (Constructor)</h4> |
|
82 <b>Html5ToJsConverter</b>(<i>html, parent=None</i>) |
|
83 <p> |
|
84 Constructor |
|
85 </p><dl> |
|
86 <dt><i>html</i></dt> |
|
87 <dd> |
|
88 HTML text to be converted (string) |
|
89 </dd><dt><i>parent</i></dt> |
|
90 <dd> |
|
91 reference to the parent object (QObject) |
|
92 </dd> |
|
93 </dl><a NAME="Html5ToJsConverter.__createSoup" ID="Html5ToJsConverter.__createSoup"></a> |
|
94 <h4>Html5ToJsConverter.__createSoup</h4> |
|
95 <b>__createSoup</b>(<i></i>) |
|
96 <p> |
|
97 Private method to get a BeaitifulSoup object with our HTML text. |
|
98 </p><a NAME="Html5ToJsConverter.__getClasses" ID="Html5ToJsConverter.__getClasses"></a> |
|
99 <h4>Html5ToJsConverter.__getClasses</h4> |
|
100 <b>__getClasses</b>(<i></i>) |
|
101 <p> |
|
102 Private method to extract all classes of the HTML text. |
|
103 </p><dl> |
|
104 <dt>Returns:</dt> |
|
105 <dd> |
|
106 list of tuples containing the tag name and its classes |
|
107 as a blank separated string (list of tuples of two strings) |
|
108 </dd> |
|
109 </dl><a NAME="Html5ToJsConverter.__getIds" ID="Html5ToJsConverter.__getIds"></a> |
|
110 <h4>Html5ToJsConverter.__getIds</h4> |
|
111 <b>__getIds</b>(<i></i>) |
|
112 <p> |
|
113 Private method to extract all IDs of the HTML text. |
|
114 </p><dl> |
|
115 <dt>Returns:</dt> |
|
116 <dd> |
|
117 list of tuples containing the tag name and its ID |
|
118 (list of tuples of two strings) |
|
119 </dd> |
|
120 </dl><a NAME="Html5ToJsConverter.getJavaScript" ID="Html5ToJsConverter.getJavaScript"></a> |
|
121 <h4>Html5ToJsConverter.getJavaScript</h4> |
|
122 <b>getJavaScript</b>(<i></i>) |
|
123 <p> |
|
124 Public method to get the converted JavaScript text. |
|
125 </p><dl> |
|
126 <dt>Returns:</dt> |
|
127 <dd> |
|
128 JavaScript text (string) |
|
129 </dd> |
|
130 </dl> |
|
131 <div align="right"><a href="#top">Up</a></div> |
|
132 <hr /> |
|
133 </body></html> |