Mercurial Repositories > Web Project and Tools / file comparison
comparison: ProjectWeb/Documentation/source/Plugin_Project_Web.ProjectWeb.Html5ToJsConverter.html
ProjectWeb/Documentation/source/Plugin_Project_Web.ProjectWeb.Html5ToJsConverter.html
- changeset 30
- 38092622e612
- parent 7
- e6fbd4a7484d
- child 35
- a3f1dcf94fe4
equal
deleted
inserted
replaced
| 29:38577502d613 | 30:38092622e612 |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Project_Web.ProjectWeb.Html5ToJsConverter</h1> | 23 <h1>Plugin_Project_Web.ProjectWeb.Html5ToJsConverter</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the HTML5 to JavaScript converter. | 26 Module implementing the HTML5 to JavaScript converter. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#Html5ToJsConverter">Html5ToJsConverter</a></td> | 38 <td><a href="#Html5ToJsConverter">Html5ToJsConverter</a></td> |
| 34 <td>Class implementing the HTML5 to JavaScript converter.</td> | 39 <td>Class implementing the HTML5 to JavaScript converter.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 43 | |
| 38 <table> | 44 <table> |
| 39 <tr><td>None</td></tr> | 45 <tr><td>None</td></tr> |
| 40 </table> | 46 </table> |
| 41 <hr /><hr /> | 47 <hr /> |
| 48 <hr /> | |
| 42 <a NAME="Html5ToJsConverter" ID="Html5ToJsConverter"></a> | 49 <a NAME="Html5ToJsConverter" ID="Html5ToJsConverter"></a> |
| 43 <h2>Html5ToJsConverter</h2> | 50 <h2>Html5ToJsConverter</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the HTML5 to JavaScript converter. | 53 Class implementing the HTML5 to JavaScript converter. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 QObject | 56 QObject |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>JsTemplate8</td></tr><tr><td>TagsToIgnore</td></tr> | 60 <tr><td>JsTemplate8</td></tr><tr><td>TagsToIgnore</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 68 | |
| 58 <table> | 69 <table> |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#Html5ToJsConverter.__init__">Html5ToJsConverter</a></td> | 72 <td><a href="#Html5ToJsConverter.__init__">Html5ToJsConverter</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#Html5ToJsConverter.__createSoup">__createSoup</a></td> | 76 <td><a href="#Html5ToJsConverter.__createSoup">__createSoup</a></td> |
| 64 <td>Private method to get a BeaitifulSoup object with our HTML text.</td> | 77 <td>Private method to get a BeaitifulSoup object with our HTML text.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#Html5ToJsConverter.__getClasses">__getClasses</a></td> | 80 <td><a href="#Html5ToJsConverter.__getClasses">__getClasses</a></td> |
| 67 <td>Private method to extract all classes of the HTML text.</td> | 81 <td>Private method to extract all classes of the HTML text.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#Html5ToJsConverter.__getIds">__getIds</a></td> | 84 <td><a href="#Html5ToJsConverter.__getIds">__getIds</a></td> |
| 70 <td>Private method to extract all IDs of the HTML text.</td> | 85 <td>Private method to extract all IDs of the HTML text.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#Html5ToJsConverter.getJavaScript">getJavaScript</a></td> | 88 <td><a href="#Html5ToJsConverter.getJavaScript">getJavaScript</a></td> |
| 73 <td>Public method to get the converted JavaScript text.</td> | 89 <td>Public method to get the converted JavaScript text.</td> |
| 74 </tr> | 90 </tr> |
| 75 </table> | 91 </table> |
| 76 <h3>Static Methods</h3> | 92 <h3>Static Methods</h3> |
| 93 | |
| 77 <table> | 94 <table> |
| 78 <tr><td>None</td></tr> | 95 <tr><td>None</td></tr> |
| 79 </table> | 96 </table> |
| 97 | |
| 80 <a NAME="Html5ToJsConverter.__init__" ID="Html5ToJsConverter.__init__"></a> | 98 <a NAME="Html5ToJsConverter.__init__" ID="Html5ToJsConverter.__init__"></a> |
| 81 <h4>Html5ToJsConverter (Constructor)</h4> | 99 <h4>Html5ToJsConverter (Constructor)</h4> |
| 82 <b>Html5ToJsConverter</b>(<i>html, parent=None</i>) | 100 <b>Html5ToJsConverter</b>(<i>html, parent=None</i>) |
| 101 | |
| 83 <p> | 102 <p> |
| 84 Constructor | 103 Constructor |
| 85 </p><dl> | 104 </p> |
| 105 <dl> | |
| 106 | |
| 86 <dt><i>html</i></dt> | 107 <dt><i>html</i></dt> |
| 87 <dd> | 108 <dd> |
| 88 HTML text to be converted (string) | 109 HTML text to be converted (string) |
| 89 </dd><dt><i>parent</i></dt> | 110 </dd> |
| 111 <dt><i>parent</i></dt> | |
| 90 <dd> | 112 <dd> |
| 91 reference to the parent object (QObject) | 113 reference to the parent object (QObject) |
| 92 </dd> | 114 </dd> |
| 93 </dl><a NAME="Html5ToJsConverter.__createSoup" ID="Html5ToJsConverter.__createSoup"></a> | 115 </dl> |
| 116 <a NAME="Html5ToJsConverter.__createSoup" ID="Html5ToJsConverter.__createSoup"></a> | |
| 94 <h4>Html5ToJsConverter.__createSoup</h4> | 117 <h4>Html5ToJsConverter.__createSoup</h4> |
| 95 <b>__createSoup</b>(<i></i>) | 118 <b>__createSoup</b>(<i></i>) |
| 119 | |
| 96 <p> | 120 <p> |
| 97 Private method to get a BeaitifulSoup object with our HTML text. | 121 Private method to get a BeaitifulSoup object with our HTML text. |
| 98 </p><a NAME="Html5ToJsConverter.__getClasses" ID="Html5ToJsConverter.__getClasses"></a> | 122 </p> |
| 123 <a NAME="Html5ToJsConverter.__getClasses" ID="Html5ToJsConverter.__getClasses"></a> | |
| 99 <h4>Html5ToJsConverter.__getClasses</h4> | 124 <h4>Html5ToJsConverter.__getClasses</h4> |
| 100 <b>__getClasses</b>(<i></i>) | 125 <b>__getClasses</b>(<i></i>) |
| 126 | |
| 101 <p> | 127 <p> |
| 102 Private method to extract all classes of the HTML text. | 128 Private method to extract all classes of the HTML text. |
| 103 </p><dl> | 129 </p> |
| 130 <dl> | |
| 104 <dt>Returns:</dt> | 131 <dt>Returns:</dt> |
| 105 <dd> | 132 <dd> |
| 106 list of tuples containing the tag name and its classes | 133 list of tuples containing the tag name and its classes |
| 107 as a blank separated string (list of tuples of two strings) | 134 as a blank separated string (list of tuples of two strings) |
| 108 </dd> | 135 </dd> |
| 109 </dl><a NAME="Html5ToJsConverter.__getIds" ID="Html5ToJsConverter.__getIds"></a> | 136 </dl> |
| 137 <a NAME="Html5ToJsConverter.__getIds" ID="Html5ToJsConverter.__getIds"></a> | |
| 110 <h4>Html5ToJsConverter.__getIds</h4> | 138 <h4>Html5ToJsConverter.__getIds</h4> |
| 111 <b>__getIds</b>(<i></i>) | 139 <b>__getIds</b>(<i></i>) |
| 140 | |
| 112 <p> | 141 <p> |
| 113 Private method to extract all IDs of the HTML text. | 142 Private method to extract all IDs of the HTML text. |
| 114 </p><dl> | 143 </p> |
| 144 <dl> | |
| 115 <dt>Returns:</dt> | 145 <dt>Returns:</dt> |
| 116 <dd> | 146 <dd> |
| 117 list of tuples containing the tag name and its ID | 147 list of tuples containing the tag name and its ID |
| 118 (list of tuples of two strings) | 148 (list of tuples of two strings) |
| 119 </dd> | 149 </dd> |
| 120 </dl><a NAME="Html5ToJsConverter.getJavaScript" ID="Html5ToJsConverter.getJavaScript"></a> | 150 </dl> |
| 151 <a NAME="Html5ToJsConverter.getJavaScript" ID="Html5ToJsConverter.getJavaScript"></a> | |
| 121 <h4>Html5ToJsConverter.getJavaScript</h4> | 152 <h4>Html5ToJsConverter.getJavaScript</h4> |
| 122 <b>getJavaScript</b>(<i></i>) | 153 <b>getJavaScript</b>(<i></i>) |
| 154 | |
| 123 <p> | 155 <p> |
| 124 Public method to get the converted JavaScript text. | 156 Public method to get the converted JavaScript text. |
| 125 </p><dl> | 157 </p> |
| 158 <dl> | |
| 126 <dt>Returns:</dt> | 159 <dt>Returns:</dt> |
| 127 <dd> | 160 <dd> |
| 128 JavaScript text (string) | 161 JavaScript text (string) |
| 129 </dd> | 162 </dd> |
| 130 </dl> | 163 </dl> |
