ProjectWeb/Documentation/source/Plugin_Project_Web.ProjectWeb.Html5Prettifier.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.Html5Prettifier</h1> 23 <h1>Plugin_Project_Web.ProjectWeb.Html5Prettifier</h1>
24
23 <p> 25 <p>
24 Module implementing a class to prettify HTML code. 26 Module implementing a class to prettify HTML code.
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="#Html5Prettifier">Html5Prettifier</a></td> 38 <td><a href="#Html5Prettifier">Html5Prettifier</a></td>
34 <td>Class implementing the HTML5 prettifier.</td> 39 <td>Class implementing the HTML5 prettifier.</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="Html5Prettifier" ID="Html5Prettifier"></a> 49 <a NAME="Html5Prettifier" ID="Html5Prettifier"></a>
43 <h2>Html5Prettifier</h2> 50 <h2>Html5Prettifier</h2>
51
44 <p> 52 <p>
45 Class implementing the HTML5 prettifier. 53 Class implementing the HTML5 prettifier.
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>None</td></tr> 60 <tr><td>None</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="#Html5Prettifier.__init__">Html5Prettifier</a></td> 72 <td><a href="#Html5Prettifier.__init__">Html5Prettifier</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#Html5Prettifier.commentPrettify">commentPrettify</a></td> 76 <td><a href="#Html5Prettifier.commentPrettify">commentPrettify</a></td>
64 <td>Public method to prettify HTML comments.</td> 77 <td>Public method to prettify HTML comments.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#Html5Prettifier.getPrettifiedHtml">getPrettifiedHtml</a></td> 80 <td><a href="#Html5Prettifier.getPrettifiedHtml">getPrettifiedHtml</a></td>
67 <td>Public method to prettify the HTML code.</td> 81 <td>Public method to prettify the HTML code.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#Html5Prettifier.tagPrettify">tagPrettify</a></td> 84 <td><a href="#Html5Prettifier.tagPrettify">tagPrettify</a></td>
70 <td>Public method to prettify HTML tags.</td> 85 <td>Public method to prettify HTML tags.</td>
71 </tr> 86 </tr>
72 </table> 87 </table>
73 <h3>Static Methods</h3> 88 <h3>Static Methods</h3>
89
74 <table> 90 <table>
75 <tr><td>None</td></tr> 91 <tr><td>None</td></tr>
76 </table> 92 </table>
93
77 <a NAME="Html5Prettifier.__init__" ID="Html5Prettifier.__init__"></a> 94 <a NAME="Html5Prettifier.__init__" ID="Html5Prettifier.__init__"></a>
78 <h4>Html5Prettifier (Constructor)</h4> 95 <h4>Html5Prettifier (Constructor)</h4>
79 <b>Html5Prettifier</b>(<i>html, parent=None</i>) 96 <b>Html5Prettifier</b>(<i>html, parent=None</i>)
97
80 <p> 98 <p>
81 Constructor 99 Constructor
82 </p><dl> 100 </p>
101 <dl>
102
83 <dt><i>html</i></dt> 103 <dt><i>html</i></dt>
84 <dd> 104 <dd>
85 HTML text to be prettified (string) 105 HTML text to be prettified (string)
86 </dd><dt><i>parent</i></dt> 106 </dd>
107 <dt><i>parent</i></dt>
87 <dd> 108 <dd>
88 reference to the parent object (QObject) 109 reference to the parent object (QObject)
89 </dd> 110 </dd>
90 </dl><a NAME="Html5Prettifier.commentPrettify" ID="Html5Prettifier.commentPrettify"></a> 111 </dl>
112 <a NAME="Html5Prettifier.commentPrettify" ID="Html5Prettifier.commentPrettify"></a>
91 <h4>Html5Prettifier.commentPrettify</h4> 113 <h4>Html5Prettifier.commentPrettify</h4>
92 <b>commentPrettify</b>(<i>matchobj</i>) 114 <b>commentPrettify</b>(<i>matchobj</i>)
115
93 <p> 116 <p>
94 Public method to prettify HTML comments. 117 Public method to prettify HTML comments.
95 </p><dl> 118 </p>
119 <dl>
120
96 <dt><i>matchobj</i></dt> 121 <dt><i>matchobj</i></dt>
97 <dd> 122 <dd>
98 reference to the match object (re.MatchObject) 123 reference to the match object (re.MatchObject)
99 </dd> 124 </dd>
100 </dl><dl> 125 </dl>
126 <dl>
101 <dt>Returns:</dt> 127 <dt>Returns:</dt>
102 <dd> 128 <dd>
103 prettified comment (string) 129 prettified comment (string)
104 </dd> 130 </dd>
105 </dl><a NAME="Html5Prettifier.getPrettifiedHtml" ID="Html5Prettifier.getPrettifiedHtml"></a> 131 </dl>
132 <a NAME="Html5Prettifier.getPrettifiedHtml" ID="Html5Prettifier.getPrettifiedHtml"></a>
106 <h4>Html5Prettifier.getPrettifiedHtml</h4> 133 <h4>Html5Prettifier.getPrettifiedHtml</h4>
107 <b>getPrettifiedHtml</b>(<i></i>) 134 <b>getPrettifiedHtml</b>(<i></i>)
135
108 <p> 136 <p>
109 Public method to prettify the HTML code. 137 Public method to prettify the HTML code.
110 </p><dl> 138 </p>
139 <dl>
111 <dt>Returns:</dt> 140 <dt>Returns:</dt>
112 <dd> 141 <dd>
113 prettified HTML code (string) 142 prettified HTML code (string)
114 </dd> 143 </dd>
115 </dl><a NAME="Html5Prettifier.tagPrettify" ID="Html5Prettifier.tagPrettify"></a> 144 </dl>
145 <a NAME="Html5Prettifier.tagPrettify" ID="Html5Prettifier.tagPrettify"></a>
116 <h4>Html5Prettifier.tagPrettify</h4> 146 <h4>Html5Prettifier.tagPrettify</h4>
117 <b>tagPrettify</b>(<i>tag</i>) 147 <b>tagPrettify</b>(<i>tag</i>)
148
118 <p> 149 <p>
119 Public method to prettify HTML tags. 150 Public method to prettify HTML tags.
120 </p><dl> 151 </p>
152 <dl>
153
121 <dt><i>tag</i></dt> 154 <dt><i>tag</i></dt>
122 <dd> 155 <dd>
123 tag to be prettified (string) 156 tag to be prettified (string)
124 </dd> 157 </dd>
125 </dl><dl> 158 </dl>
159 <dl>
126 <dt>Returns:</dt> 160 <dt>Returns:</dt>
127 <dd> 161 <dd>
128 prettified tag (string) 162 prettified tag (string)
129 </dd> 163 </dd>
130 </dl> 164 </dl>

eric ide

mercurial