|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>Plugin_Project_Web.ProjectWeb.Html5Prettifier</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.Html5Prettifier</h1> |
|
23 <p> |
|
24 Module implementing a class to prettify HTML code. |
|
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="#Html5Prettifier">Html5Prettifier</a></td> |
|
34 <td>Class implementing the HTML5 prettifier.</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="Html5Prettifier" ID="Html5Prettifier"></a> |
|
43 <h2>Html5Prettifier</h2> |
|
44 <p> |
|
45 Class implementing the HTML5 prettifier. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QObject |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>None</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="#Html5Prettifier.__init__">Html5Prettifier</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#Html5Prettifier.commentPrettify">commentPrettify</a></td> |
|
64 <td>Public method to prettify HTML comments.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#Html5Prettifier.getPrettifiedHtml">getPrettifiedHtml</a></td> |
|
67 <td>Public method to prettify the HTML code.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#Html5Prettifier.tagPrettify">tagPrettify</a></td> |
|
70 <td>Public method to prettify HTML tags.</td> |
|
71 </tr> |
|
72 </table> |
|
73 <h3>Static Methods</h3> |
|
74 <table> |
|
75 <tr><td>None</td></tr> |
|
76 </table> |
|
77 <a NAME="Html5Prettifier.__init__" ID="Html5Prettifier.__init__"></a> |
|
78 <h4>Html5Prettifier (Constructor)</h4> |
|
79 <b>Html5Prettifier</b>(<i>html, parent=None</i>) |
|
80 <p> |
|
81 Constructor |
|
82 </p><dl> |
|
83 <dt><i>html</i></dt> |
|
84 <dd> |
|
85 HTML text to be prettified (string) |
|
86 </dd><dt><i>parent</i></dt> |
|
87 <dd> |
|
88 reference to the parent object (QObject) |
|
89 </dd> |
|
90 </dl><a NAME="Html5Prettifier.commentPrettify" ID="Html5Prettifier.commentPrettify"></a> |
|
91 <h4>Html5Prettifier.commentPrettify</h4> |
|
92 <b>commentPrettify</b>(<i>matchobj</i>) |
|
93 <p> |
|
94 Public method to prettify HTML comments. |
|
95 </p><dl> |
|
96 <dt><i>matchobj</i></dt> |
|
97 <dd> |
|
98 reference to the match object (re.MatchObject) |
|
99 </dd> |
|
100 </dl><dl> |
|
101 <dt>Returns:</dt> |
|
102 <dd> |
|
103 prettified comment (string) |
|
104 </dd> |
|
105 </dl><a NAME="Html5Prettifier.getPrettifiedHtml" ID="Html5Prettifier.getPrettifiedHtml"></a> |
|
106 <h4>Html5Prettifier.getPrettifiedHtml</h4> |
|
107 <b>getPrettifiedHtml</b>(<i></i>) |
|
108 <p> |
|
109 Public method to prettify the HTML code. |
|
110 </p><dl> |
|
111 <dt>Returns:</dt> |
|
112 <dd> |
|
113 prettified HTML code (string) |
|
114 </dd> |
|
115 </dl><a NAME="Html5Prettifier.tagPrettify" ID="Html5Prettifier.tagPrettify"></a> |
|
116 <h4>Html5Prettifier.tagPrettify</h4> |
|
117 <b>tagPrettify</b>(<i>tag</i>) |
|
118 <p> |
|
119 Public method to prettify HTML tags. |
|
120 </p><dl> |
|
121 <dt><i>tag</i></dt> |
|
122 <dd> |
|
123 tag to be prettified (string) |
|
124 </dd> |
|
125 </dl><dl> |
|
126 <dt>Returns:</dt> |
|
127 <dd> |
|
128 prettified tag (string) |
|
129 </dd> |
|
130 </dl> |
|
131 <div align="right"><a href="#top">Up</a></div> |
|
132 <hr /> |
|
133 </body></html> |