Documentation/Source/eric5.Utilities.__init__.html

changeset 1732
b140a24e147a
parent 1370
cb90f71f11f5
child 2031
c36c2eb62a75
equal deleted inserted replaced
1731:56cf9c150dbf 1732:b140a24e147a
24 <p> 24 <p>
25 Package implementing various functions/classes needed everywhere within eric5. 25 Package implementing various functions/classes needed everywhere within eric5.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>_escape</td></tr><tr><td>_escape_map</td></tr><tr><td>_uescape</td></tr><tr><td>codingBytes_regexps</td></tr><tr><td>coding_regexps</td></tr><tr><td>configDir</td></tr><tr><td>supportedCodecs</td></tr> 29 <tr><td>_escape</td></tr><tr><td>_escape_map</td></tr><tr><td>_uescape</td></tr><tr><td>_uunescape</td></tr><tr><td>codingBytes_regexps</td></tr><tr><td>coding_regexps</td></tr><tr><td>configDir</td></tr><tr><td>supportedCodecs</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#CodingError">CodingError</a></td> 34 <td><a href="#CodingError">CodingError</a></td>
156 <td>Module function to check, if the environment contains an entry.</td> 156 <td>Module function to check, if the environment contains an entry.</td>
157 </tr><tr> 157 </tr><tr>
158 <td><a href="#html_encode">html_encode</a></td> 158 <td><a href="#html_encode">html_encode</a></td>
159 <td>Function to correctly encode a text for html.</td> 159 <td>Function to correctly encode a text for html.</td>
160 </tr><tr> 160 </tr><tr>
161 <td><a href="#html_udecode">html_udecode</a></td>
162 <td>Function to correctly decode a html text to a unicode text.</td>
163 </tr><tr>
161 <td><a href="#html_uencode">html_uencode</a></td> 164 <td><a href="#html_uencode">html_uencode</a></td>
162 <td>Function to correctly encode a unicode text for html.</td> 165 <td>Function to correctly encode a unicode text for html.</td>
163 </tr><tr> 166 </tr><tr>
164 <td><a href="#isExecutable">isExecutable</a></td> 167 <td><a href="#isExecutable">isExecutable</a></td>
165 <td>Function to check, if a file is executable.</td> 168 <td>Function to check, if a file is executable.</td>
221 <td><a href="#splitPath">splitPath</a></td> 224 <td><a href="#splitPath">splitPath</a></td>
222 <td>Function to split a pathname into a directory part and a file part.</td> 225 <td>Function to split a pathname into a directory part and a file part.</td>
223 </tr><tr> 226 </tr><tr>
224 <td><a href="#toNativeSeparators">toNativeSeparators</a></td> 227 <td><a href="#toNativeSeparators">toNativeSeparators</a></td>
225 <td>Function returning a path, that is using native separator characters.</td> 228 <td>Function returning a path, that is using native separator characters.</td>
229 </tr><tr>
230 <td><a href="#unescape_uentities">unescape_uentities</a></td>
231 <td>Function to decode html entities.</td>
226 </tr><tr> 232 </tr><tr>
227 <td><a href="#win32_GetUserName">win32_GetUserName</a></td> 233 <td><a href="#win32_GetUserName">win32_GetUserName</a></td>
228 <td>Function to get the user name under Win32.</td> 234 <td>Function to get the user name under Win32.</td>
229 </tr><tr> 235 </tr><tr>
230 <td><a href="#win32_Kill">win32_Kill</a></td> 236 <td><a href="#win32_Kill">win32_Kill</a></td>
1048 the encoded text (string) 1054 the encoded text (string)
1049 </dd> 1055 </dd>
1050 </dl> 1056 </dl>
1051 <div align="right"><a href="#top">Up</a></div> 1057 <div align="right"><a href="#top">Up</a></div>
1052 <hr /><hr /> 1058 <hr /><hr />
1059 <a NAME="html_udecode" ID="html_udecode"></a>
1060 <h2>html_udecode</h2>
1061 <b>html_udecode</b>(<i>text, pattern=_uunescape</i>)
1062 <p>
1063 Function to correctly decode a html text to a unicode text.
1064 </p><dl>
1065 <dt><i>text</i></dt>
1066 <dd>
1067 text to be decoded (string)
1068 </dd><dt><i>pattern</i></dt>
1069 <dd>
1070 search pattern for text to be decoded (string)
1071 </dd>
1072 </dl><dl>
1073 <dt>Returns:</dt>
1074 <dd>
1075 the decoded text (string)
1076 </dd>
1077 </dl>
1078 <div align="right"><a href="#top">Up</a></div>
1079 <hr /><hr />
1053 <a NAME="html_uencode" ID="html_uencode"></a> 1080 <a NAME="html_uencode" ID="html_uencode"></a>
1054 <h2>html_uencode</h2> 1081 <h2>html_uencode</h2>
1055 <b>html_uencode</b>(<i>text, pattern=_uescape</i>) 1082 <b>html_uencode</b>(<i>text, pattern=_uescape</i>)
1056 <p> 1083 <p>
1057 Function to correctly encode a unicode text for html. 1084 Function to correctly encode a unicode text for html.
1472 path with converted separator characters (string) 1499 path with converted separator characters (string)
1473 </dd> 1500 </dd>
1474 </dl> 1501 </dl>
1475 <div align="right"><a href="#top">Up</a></div> 1502 <div align="right"><a href="#top">Up</a></div>
1476 <hr /><hr /> 1503 <hr /><hr />
1504 <a NAME="unescape_uentities" ID="unescape_uentities"></a>
1505 <h2>unescape_uentities</h2>
1506 <b>unescape_uentities</b>(<i>m</i>)
1507 <p>
1508 Function to decode html entities.
1509 </p><dl>
1510 <dt><i>m</i></dt>
1511 <dd>
1512 the match object
1513 </dd>
1514 </dl><dl>
1515 <dt>Returns:</dt>
1516 <dd>
1517 the converted text (string)
1518 </dd>
1519 </dl>
1520 <div align="right"><a href="#top">Up</a></div>
1521 <hr /><hr />
1477 <a NAME="win32_GetUserName" ID="win32_GetUserName"></a> 1522 <a NAME="win32_GetUserName" ID="win32_GetUserName"></a>
1478 <h2>win32_GetUserName</h2> 1523 <h2>win32_GetUserName</h2>
1479 <b>win32_GetUserName</b>(<i></i>) 1524 <b>win32_GetUserName</b>(<i></i>)
1480 <p> 1525 <p>
1481 Function to get the user name under Win32. 1526 Function to get the user name under Win32.

eric ide

mercurial