Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Network.IRC.IrcUtilities.html
eric6/Documentation/Source/eric6.Network.IRC.IrcUtilities.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 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>eric6.Network.IRC.IrcUtilities</h1> | 23 <h1>eric6.Network.IRC.IrcUtilities</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing functions used by several IRC objects. | 26 Module implementing functions used by several IRC objects. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>__ColorRe</td></tr><tr><td>__UrlRe</td></tr><tr><td>__channelModesDict</td></tr> | 31 <tr><td>__ColorRe</td></tr><tr><td>__UrlRe</td></tr><tr><td>__channelModesDict</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 32 <tr><td>None</td></tr> | 36 <tr><td>None</td></tr> |
| 33 </table> | 37 </table> |
| 34 <h3>Functions</h3> | 38 <h3>Functions</h3> |
| 39 | |
| 35 <table> | 40 <table> |
| 41 | |
| 36 <tr> | 42 <tr> |
| 37 <td><a href="#__initChannelModesDict">__initChannelModesDict</a></td> | 43 <td><a href="#__initChannelModesDict">__initChannelModesDict</a></td> |
| 38 <td>Private module function to initialize the channels modes dictionary.</td> | 44 <td>Private module function to initialize the channels modes dictionary.</td> |
| 39 </tr><tr> | 45 </tr> |
| 46 <tr> | |
| 40 <td><a href="#getChannelModesDict">getChannelModesDict</a></td> | 47 <td><a href="#getChannelModesDict">getChannelModesDict</a></td> |
| 41 <td>Module function to get the dictionary with the channel modes mappings.</td> | 48 <td>Module function to get the dictionary with the channel modes mappings.</td> |
| 42 </tr><tr> | 49 </tr> |
| 50 <tr> | |
| 43 <td><a href="#ircFilter">ircFilter</a></td> | 51 <td><a href="#ircFilter">ircFilter</a></td> |
| 44 <td>Module method to make the message HTML compliant and detect URLs.</td> | 52 <td>Module method to make the message HTML compliant and detect URLs.</td> |
| 45 </tr><tr> | 53 </tr> |
| 54 <tr> | |
| 46 <td><a href="#ircTimestamp">ircTimestamp</a></td> | 55 <td><a href="#ircTimestamp">ircTimestamp</a></td> |
| 47 <td>Module method to generate a time stamp string.</td> | 56 <td>Module method to generate a time stamp string.</td> |
| 48 </tr> | 57 </tr> |
| 49 </table> | 58 </table> |
| 50 <hr /><hr /> | 59 <hr /> |
| 60 <hr /> | |
| 51 <a NAME="__initChannelModesDict" ID="__initChannelModesDict"></a> | 61 <a NAME="__initChannelModesDict" ID="__initChannelModesDict"></a> |
| 52 <h2>__initChannelModesDict</h2> | 62 <h2>__initChannelModesDict</h2> |
| 53 <b>__initChannelModesDict</b>(<i></i>) | 63 <b>__initChannelModesDict</b>(<i></i>) |
| 64 | |
| 54 <p> | 65 <p> |
| 55 Private module function to initialize the channels modes dictionary. | 66 Private module function to initialize the channels modes dictionary. |
| 56 </p> | 67 </p> |
| 57 <div align="right"><a href="#top">Up</a></div> | 68 <div align="right"><a href="#top">Up</a></div> |
| 58 <hr /><hr /> | 69 <hr /> |
| 70 <hr /> | |
| 59 <a NAME="getChannelModesDict" ID="getChannelModesDict"></a> | 71 <a NAME="getChannelModesDict" ID="getChannelModesDict"></a> |
| 60 <h2>getChannelModesDict</h2> | 72 <h2>getChannelModesDict</h2> |
| 61 <b>getChannelModesDict</b>(<i></i>) | 73 <b>getChannelModesDict</b>(<i></i>) |
| 74 | |
| 62 <p> | 75 <p> |
| 63 Module function to get the dictionary with the channel modes mappings. | 76 Module function to get the dictionary with the channel modes mappings. |
| 64 </p><dl> | 77 </p> |
| 78 <dl> | |
| 65 <dt>Returns:</dt> | 79 <dt>Returns:</dt> |
| 66 <dd> | 80 <dd> |
| 67 dictionary with channel modes mapping (dict) | 81 dictionary with channel modes mapping (dict) |
| 68 </dd> | 82 </dd> |
| 69 </dl> | 83 </dl> |
| 70 <div align="right"><a href="#top">Up</a></div> | 84 <div align="right"><a href="#top">Up</a></div> |
| 71 <hr /><hr /> | 85 <hr /> |
| 86 <hr /> | |
| 72 <a NAME="ircFilter" ID="ircFilter"></a> | 87 <a NAME="ircFilter" ID="ircFilter"></a> |
| 73 <h2>ircFilter</h2> | 88 <h2>ircFilter</h2> |
| 74 <b>ircFilter</b>(<i>msg</i>) | 89 <b>ircFilter</b>(<i>msg</i>) |
| 90 | |
| 75 <p> | 91 <p> |
| 76 Module method to make the message HTML compliant and detect URLs. | 92 Module method to make the message HTML compliant and detect URLs. |
| 77 </p><dl> | 93 </p> |
| 94 <dl> | |
| 95 | |
| 78 <dt><i>msg</i></dt> | 96 <dt><i>msg</i></dt> |
| 79 <dd> | 97 <dd> |
| 80 message to process (string) | 98 message to process (string) |
| 81 </dd> | 99 </dd> |
| 82 </dl><dl> | 100 </dl> |
| 101 <dl> | |
| 83 <dt>Returns:</dt> | 102 <dt>Returns:</dt> |
| 84 <dd> | 103 <dd> |
| 85 processed message (string) | 104 processed message (string) |
| 86 </dd> | 105 </dd> |
| 87 </dl> | 106 </dl> |
| 88 <div align="right"><a href="#top">Up</a></div> | 107 <div align="right"><a href="#top">Up</a></div> |
| 89 <hr /><hr /> | 108 <hr /> |
| 109 <hr /> | |
| 90 <a NAME="ircTimestamp" ID="ircTimestamp"></a> | 110 <a NAME="ircTimestamp" ID="ircTimestamp"></a> |
| 91 <h2>ircTimestamp</h2> | 111 <h2>ircTimestamp</h2> |
| 92 <b>ircTimestamp</b>(<i></i>) | 112 <b>ircTimestamp</b>(<i></i>) |
| 113 | |
| 93 <p> | 114 <p> |
| 94 Module method to generate a time stamp string. | 115 Module method to generate a time stamp string. |
| 95 </p><dl> | 116 </p> |
| 117 <dl> | |
| 96 <dt>Returns:</dt> | 118 <dt>Returns:</dt> |
| 97 <dd> | 119 <dd> |
| 98 time stamp (string) | 120 time stamp (string) |
| 99 </dd> | 121 </dd> |
| 100 </dl> | 122 </dl> |
