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