Mercurial Repositories > IRC client / file comparison
comparison: ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcUtilities.html
ExtensionIrc/Documentation/Source/Plugin_Extension_Irc.ExtensionIrc.IrcUtilities.html
- changeset 3
- 51c2c37bde76
equal
deleted
inserted
replaced
| 2:5b635dc8895f | 3:51c2c37bde76 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>Plugin_Extension_Irc.ExtensionIrc.IrcUtilities</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>Plugin_Extension_Irc.ExtensionIrc.IrcUtilities</h1> | |
| 10 <p> | |
| 11 Module implementing functions used by several IRC objects. | |
| 12 </p> | |
| 13 | |
| 14 <h3>Global Attributes</h3> | |
| 15 <table> | |
| 16 <tr><td>__ColorRe</td></tr> | |
| 17 <tr><td>__UrlRe</td></tr> | |
| 18 <tr><td>__channelModesDict</td></tr> | |
| 19 </table> | |
| 20 | |
| 21 <h3>Classes</h3> | |
| 22 <table> | |
| 23 <tr><td>None</td></tr> | |
| 24 </table> | |
| 25 | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr> | |
| 29 <td><a href="#__initChannelModesDict">__initChannelModesDict</a></td> | |
| 30 <td>Private module function to initialize the channels modes dictionary.</td> | |
| 31 </tr> | |
| 32 <tr> | |
| 33 <td><a href="#getChannelModesDict">getChannelModesDict</a></td> | |
| 34 <td>Module function to get the dictionary with the channel modes mappings.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#ircFilter">ircFilter</a></td> | |
| 38 <td>Module method to make the message HTML compliant and detect URLs.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#ircTimestamp">ircTimestamp</a></td> | |
| 42 <td>Module method to generate a time stamp string.</td> | |
| 43 </tr> | |
| 44 </table> | |
| 45 | |
| 46 <hr /> | |
| 47 <hr /> | |
| 48 <a NAME="__initChannelModesDict" ID="__initChannelModesDict"></a> | |
| 49 <h2>__initChannelModesDict</h2> | |
| 50 <b>__initChannelModesDict</b>(<i></i>) | |
| 51 <p> | |
| 52 Private module function to initialize the channels modes dictionary. | |
| 53 </p> | |
| 54 | |
| 55 <div align="right"><a href="#top">Up</a></div> | |
| 56 <hr /> | |
| 57 <hr /> | |
| 58 <a NAME="getChannelModesDict" ID="getChannelModesDict"></a> | |
| 59 <h2>getChannelModesDict</h2> | |
| 60 <b>getChannelModesDict</b>(<i></i>) | |
| 61 <p> | |
| 62 Module function to get the dictionary with the channel modes mappings. | |
| 63 </p> | |
| 64 | |
| 65 <dl> | |
| 66 <dt>Return:</dt> | |
| 67 <dd> | |
| 68 dictionary with channel modes mapping | |
| 69 </dd> | |
| 70 </dl> | |
| 71 <dl> | |
| 72 <dt>Return Type:</dt> | |
| 73 <dd> | |
| 74 dict | |
| 75 </dd> | |
| 76 </dl> | |
| 77 <div align="right"><a href="#top">Up</a></div> | |
| 78 <hr /> | |
| 79 <hr /> | |
| 80 <a NAME="ircFilter" ID="ircFilter"></a> | |
| 81 <h2>ircFilter</h2> | |
| 82 <b>ircFilter</b>(<i>msg</i>) | |
| 83 <p> | |
| 84 Module method to make the message HTML compliant and detect URLs. | |
| 85 </p> | |
| 86 | |
| 87 <dl> | |
| 88 | |
| 89 <dt><i>msg</i> (str)</dt> | |
| 90 <dd> | |
| 91 message to process | |
| 92 </dd> | |
| 93 </dl> | |
| 94 <dl> | |
| 95 <dt>Return:</dt> | |
| 96 <dd> | |
| 97 processed message | |
| 98 </dd> | |
| 99 </dl> | |
| 100 <dl> | |
| 101 <dt>Return Type:</dt> | |
| 102 <dd> | |
| 103 str | |
| 104 </dd> | |
| 105 </dl> | |
| 106 <div align="right"><a href="#top">Up</a></div> | |
| 107 <hr /> | |
| 108 <hr /> | |
| 109 <a NAME="ircTimestamp" ID="ircTimestamp"></a> | |
| 110 <h2>ircTimestamp</h2> | |
| 111 <b>ircTimestamp</b>(<i></i>) | |
| 112 <p> | |
| 113 Module method to generate a time stamp string. | |
| 114 </p> | |
| 115 | |
| 116 <dl> | |
| 117 <dt>Return:</dt> | |
| 118 <dd> | |
| 119 time stamp | |
| 120 </dd> | |
| 121 </dl> | |
| 122 <dl> | |
| 123 <dt>Return Type:</dt> | |
| 124 <dd> | |
| 125 str | |
| 126 </dd> | |
| 127 </dl> | |
| 128 <div align="right"><a href="#top">Up</a></div> | |
| 129 <hr /> | |
| 130 </body></html> |
