Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Network.IRC.IrcUtilities.html
Documentation/Source/eric5.Network.IRC.IrcUtilities.html
- changeset 2266
- f885a0bc2ccc
- child 2367
- 78f6c8193d37
equal
deleted
inserted
replaced
| 2265:72e6f479987b | 2266:f885a0bc2ccc |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Network.IRC.IrcUtilities</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Network.IRC.IrcUtilities</h1> | |
| 24 <p> | |
| 25 Module implementing functions used by several IRC objects. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>__ColorRe</td></tr><tr><td>__UrlRe</td></tr><tr><td>__channelModesDict</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr><td>None</td></tr> | |
| 34 </table> | |
| 35 <h3>Functions</h3> | |
| 36 <table> | |
| 37 <tr> | |
| 38 <td><a href="#__initChannelModesDict">__initChannelModesDict</a></td> | |
| 39 <td>Private module function to initialize the channels modes dictionary.</td> | |
| 40 </tr><tr> | |
| 41 <td><a href="#getChannelModesDict">getChannelModesDict</a></td> | |
| 42 <td>Module function to get the dictionary with the channel modes mappings.</td> | |
| 43 </tr><tr> | |
| 44 <td><a href="#ircFilter">ircFilter</a></td> | |
| 45 <td>Module method to make the message HTML compliant and detect URLs.</td> | |
| 46 </tr><tr> | |
| 47 <td><a href="#ircTimestamp">ircTimestamp</a></td> | |
| 48 <td>Module method to generate a time stamp string.</td> | |
| 49 </tr> | |
| 50 </table> | |
| 51 <hr /><hr /> | |
| 52 <a NAME="__initChannelModesDict" ID="__initChannelModesDict"></a> | |
| 53 <h2>__initChannelModesDict</h2> | |
| 54 <b>__initChannelModesDict</b>(<i></i>) | |
| 55 <p> | |
| 56 Private module function to initialize the channels modes dictionary. | |
| 57 </p> | |
| 58 <div align="right"><a href="#top">Up</a></div> | |
| 59 <hr /><hr /> | |
| 60 <a NAME="getChannelModesDict" ID="getChannelModesDict"></a> | |
| 61 <h2>getChannelModesDict</h2> | |
| 62 <b>getChannelModesDict</b>(<i></i>) | |
| 63 <p> | |
| 64 Module function to get the dictionary with the channel modes mappings. | |
| 65 </p><dl> | |
| 66 <dt>Returns:</dt> | |
| 67 <dd> | |
| 68 dictionary with channel modes mapping (dict) | |
| 69 </dd> | |
| 70 </dl> | |
| 71 <div align="right"><a href="#top">Up</a></div> | |
| 72 <hr /><hr /> | |
| 73 <a NAME="ircFilter" ID="ircFilter"></a> | |
| 74 <h2>ircFilter</h2> | |
| 75 <b>ircFilter</b>(<i>msg</i>) | |
| 76 <p> | |
| 77 Module method to make the message HTML compliant and detect URLs. | |
| 78 </p><dl> | |
| 79 <dt><i>msg</i></dt> | |
| 80 <dd> | |
| 81 message to process (string) | |
| 82 </dd> | |
| 83 </dl><dl> | |
| 84 <dt>Returns:</dt> | |
| 85 <dd> | |
| 86 processed message (string) | |
| 87 </dd> | |
| 88 </dl> | |
| 89 <div align="right"><a href="#top">Up</a></div> | |
| 90 <hr /><hr /> | |
| 91 <a NAME="ircTimestamp" ID="ircTimestamp"></a> | |
| 92 <h2>ircTimestamp</h2> | |
| 93 <b>ircTimestamp</b>(<i></i>) | |
| 94 <p> | |
| 95 Module method to generate a time stamp string. | |
| 96 </p><dl> | |
| 97 <dt>Returns:</dt> | |
| 98 <dd> | |
| 99 time stamp (string) | |
| 100 </dd> | |
| 101 </dl> | |
| 102 <div align="right"><a href="#top">Up</a></div> | |
| 103 <hr /> | |
| 104 </body></html> |
