Debian Codegraph @

cocoa/doc/html/index.html

raw
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>IRCClient: IRCClient - a Cocoa IRC Framework to create IRC clients</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body>
7 <!-- Generated by Doxygen 1.5.7.1 -->
8 <div class="navigation" id="top">
9 <div class="tabs">
10 <ul>
11 <li class="current"><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="annotated.html"><span>Classes</span></a></li>
13 <li><a href="files.html"><span>Files</span></a></li>
14 </ul>
15 </div>
16 </div>
17 <div class="contents">
18 <h1>IRCClient - a Cocoa IRC Framework to create IRC clients</h1>
19 <p>
20 <h3 align="center">1.0 </h3><h2><a class="anchor" name="intro_sec">
21 Introduction</a></h2>
22 IRCClient is a Cocoa Framework that uses the excellent libircclient library written by Georgy Yunaev.<h2><a class="anchor" name="usage">
23 Basic Usage</a></h2>
24 To use this framework, you will need to write an <a class="el" href="protocol_i_r_c_client_session_delegate-p.html">IRCClientSessionDelegate</a> to handle all of the events generated by the server, and an <a class="el" href="protocol_i_r_c_client_channel_delegate-p.html">IRCClientChannelDelegate</a> to handle all of the events generated by channels on that server.<p>
25 You then create an <a class="el" href="interface_i_r_c_client_session.html" title="Represents a connected IRC Session.">IRCClientSession</a> object in your code, assign the required properties, and call connect: to connect to the server and run: to create the new thread and start receiving events. For example:<p>
26 <div class="fragment"><pre class="fragment"> <a class="code" href="interface_i_r_c_client_session.html" title="Represents a connected IRC Session.">IRCClientSession</a> *session = [[<a class="code" href="interface_i_r_c_client_session.html" title="Represents a connected IRC Session.">IRCClientSession</a> alloc] init];
27 MyIRCClientSessionDelegate *controller = [[MyIRCClientSessionDelegate alloc] init];
28
29 [session setDelegate:controller];
30 [controller setSession:session];
31
32 [session setServer:<span class="stringliteral">@"irc.dal.net"</span>];
33 [session setPort:<span class="stringliteral">@"6667"</span>];
34 [session setNickname:<span class="stringliteral">@"test"</span>];
35 [session setUsername:<span class="stringliteral">@"test"</span>];
36 [session setRealname:<span class="stringliteral">@"test"</span>];
37 [session connect];
38
39 [session run]; <span class="comment">//starts the thread</span>
40 </pre></div><h2><a class="anchor" name="author">
41 Author, copyright, support.</a></h2>
42 If you have any questions, bug reports, suggestions regarding libircclient or the IRCClient framework, please visit <a href="http://libircclient.sourceforge.net">http://libircclient.sourceforge.net</a><p>
43 <pre>
44 libircclient Copyright (C) 2004-2009 Georgy Yunaev <a href="mailto:[email protected]">[email protected]</a>
45 IRCClient Copyright (C) 2009 Nathan Ollerenshaw <a href="mailto:[email protected]">[email protected]</a></pre><p>
46 <pre> This library is free software; you can redistribute it and/or modify it
47 under the terms of the GNU Lesser General Public License as published by
48 the Free Software Foundation; either version 2 of the License, or (at your
49 option) any later version.</pre><p>
50 <pre> This library is distributed in the hope that it will be useful, but WITHOUT
51 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
52 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
53 License for more details.
54 </pre> </div>
55 <hr size="1"><address style="text-align: right;"><small>Generated on Sat Jan 10 18:10:37 2009 for IRCClient by&nbsp;
56 <a href="http://www.doxygen.org/index.html">
57 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
58 </body>
59 </html>