<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>LibIrcClient-Qt: include/ircsession.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<h1>include/ircsession.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">* Copyright (C) 2008-2009 J-P Nurmi jpnurmi@gmail.com</span>
<a name="l00003"></a>00003 <span class="comment">*</span>
<a name="l00004"></a>00004 <span class="comment">* This library is free software; you can redistribute it and/or modify it</span>
<a name="l00005"></a>00005 <span class="comment">* under the terms of the GNU Lesser General Public License as published by</span>
<a name="l00006"></a>00006 <span class="comment">* the Free Software Foundation; either version 2 of the License, or (at your</span>
<a name="l00007"></a>00007 <span class="comment">* option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment">*</span>
<a name="l00009"></a>00009 <span class="comment">* This library is distributed in the hope that it will be useful, but WITHOUT</span>
<a name="l00010"></a>00010 <span class="comment">* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span>
<a name="l00011"></a>00011 <span class="comment">* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public</span>
<a name="l00012"></a>00012 <span class="comment">* License for more details.</span>
<a name="l00013"></a>00013 <span class="comment">*</span>
<a name="l00014"></a>00014 <span class="comment">* $Id$</span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef IRC_SESSION_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define IRC_SESSION_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <<a class="code" href="ircglobal_8h.html">ircglobal.h</a>></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <QObject></span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 QT_FORWARD_DECLARE_CLASS(QHostAddress)
<a name="l00024"></a>00024 QT_FORWARD_DECLARE_CLASS(QNetworkProxy)
<a name="l00025"></a>00025 QT_FORWARD_DECLARE_CLASS(QAbstractSocket)
<a name="l00026"></a>00026
<a name="l00027"></a>00027 namespace Irc
<a name="l00028"></a>00028 {
<a name="l00029"></a>00029 <span class="keyword">class </span>SessionPrivate;
<a name="l00030"></a>00030
<a name="l00031"></a><a class="code" href="classIrc_1_1Session.html">00031</a> <span class="keyword">class </span>IRC_EXPORT <a class="code" href="classIrc_1_1Session.html" title="The Irc::Session class provides an IRC session.">Session</a> : <span class="keyword">public</span> QObject
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033 Q_OBJECT
<a name="l00034"></a>00034 Q_PROPERTY(QStringList autoJoinChannels READ autoJoinChannels WRITE setAutoJoinChannels)
<a name="l00035"></a>00035 Q_PROPERTY(<span class="keywordtype">int</span> autoReconnectDelay READ autoReconnectDelay WRITE setAutoReconnectDelay)
<a name="l00036"></a>00036 Q_PROPERTY(<span class="keywordtype">bool</span> connected READ isConnected)
<a name="l00037"></a>00037 Q_PROPERTY(QByteArray encoding READ encoding WRITE setEncoding)
<a name="l00038"></a>00038 Q_PROPERTY(QString ident READ ident WRITE setIdent)
<a name="l00039"></a>00039 Q_PROPERTY(QString nick READ nick WRITE setNick)
<a name="l00040"></a>00040 Q_PROPERTY(QString password READ password WRITE setPassword)
<a name="l00041"></a>00041 Q_PROPERTY(QString realName READ realName WRITE setRealName)
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="keyword">public</span>:
<a name="l00044"></a>00044 <a class="code" href="classIrc_1_1Session.html" title="The Irc::Session class provides an IRC session.">Session</a>(QObject* parent = 0);
<a name="l00045"></a>00045 ~<a class="code" href="classIrc_1_1Session.html" title="The Irc::Session class provides an IRC session.">Session</a>();
<a name="l00046"></a>00046
<a name="l00047"></a>00047 QStringList autoJoinChannels() <span class="keyword">const</span>;
<a name="l00048"></a>00048 <span class="keywordtype">void</span> addAutoJoinChannel(<span class="keyword">const</span> QString& channel);
<a name="l00049"></a>00049 <span class="keywordtype">void</span> removeAutoJoinChannel(<span class="keyword">const</span> QString& channel);
<a name="l00050"></a>00050 <span class="keywordtype">void</span> setAutoJoinChannels(<span class="keyword">const</span> QStringList& channels);
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keywordtype">int</span> autoReconnectDelay() <span class="keyword">const</span>;
<a name="l00053"></a>00053 <span class="keywordtype">void</span> setAutoReconnectDelay(<span class="keywordtype">int</span> seconds);
<a name="l00054"></a>00054
<a name="l00055"></a>00055 QByteArray encoding() <span class="keyword">const</span>;
<a name="l00056"></a>00056 <span class="keywordtype">void</span> setEncoding(<span class="keyword">const</span> QByteArray& encoding);
<a name="l00057"></a>00057
<a name="l00058"></a>00058 QString ident() <span class="keyword">const</span>;
<a name="l00059"></a>00059 <span class="keywordtype">void</span> setIdent(<span class="keyword">const</span> QString& ident);
<a name="l00060"></a>00060
<a name="l00061"></a>00061 QString nick() <span class="keyword">const</span>;
<a name="l00062"></a>00062
<a name="l00063"></a>00063 QString password() <span class="keyword">const</span>;
<a name="l00064"></a>00064 <span class="keywordtype">void</span> setPassword(<span class="keyword">const</span> QString& password);
<a name="l00065"></a>00065
<a name="l00066"></a>00066 QString realName() <span class="keyword">const</span>;
<a name="l00067"></a>00067 <span class="keywordtype">void</span> setRealName(<span class="keyword">const</span> QString& realName);
<a name="l00068"></a>00068
<a name="l00069"></a>00069 QString host() <span class="keyword">const</span>;
<a name="l00070"></a>00070 quint16 port() <span class="keyword">const</span>;
<a name="l00071"></a>00071
<a name="l00072"></a><a class="code" href="classIrc_1_1Session.html#16c27741e2f610c9c918937e44426bd8">00072</a> <span class="keyword">enum</span> <a class="code" href="classIrc_1_1Session.html#16c27741e2f610c9c918937e44426bd8">Option</a>
<a name="l00073"></a>00073 {
<a name="l00074"></a><a class="code" href="classIrc_1_1Session.html#16c27741e2f610c9c918937e44426bd8670e15a91638df9a4aa6b35a409efe87">00074</a> StripNicks = 0x1
<a name="l00075"></a>00075 };
<a name="l00076"></a>00076 Q_DECLARE_FLAGS(Options, Option)
<a name="l00077"></a>00077
<a name="l00078"></a>00078 Options options() const;
<a name="l00079"></a>00079 <span class="keywordtype">void</span> setOptions(Options options);
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="keywordtype">void</span> connectSlotsByName(const QObject* receiver);
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="keywordtype">bool</span> isConnected() const;
<a name="l00084"></a>00084
<a name="l00085"></a>00085 QAbstractSocket* socket() const;
<a name="l00086"></a>00086 <span class="keywordtype">void</span> setSocket(QAbstractSocket* socket);
<a name="l00087"></a>00087
<a name="l00088"></a>00088 public Q_SLOTS:
<a name="l00089"></a>00089 <span class="keywordtype">void</span> setNick(const QString& nick);
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="keywordtype">void</span> connectToServer(const QString& hostName, quint16 port = 6667);
<a name="l00092"></a>00092 <span class="keywordtype">void</span> connectToServer(const QHostAddress& address, quint16 port = 6667);
<a name="l00093"></a>00093 <span class="keywordtype">void</span> disconnectFromServer();
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="keywordtype">bool</span> sendRaw(const QString& message);
<a name="l00096"></a>00096 <span class="keywordtype">bool</span> cmdJoin(const QString& channel, const QString& key = QString());
<a name="l00097"></a>00097 <span class="keywordtype">bool</span> cmdPart(const QString& channel, const QString& reason = QString());
<a name="l00098"></a>00098 <span class="keywordtype">bool</span> cmdQuit(const QString& reason = QString());
<a name="l00099"></a>00099 <span class="keywordtype">bool</span> cmdNames(const QString& channel);
<a name="l00100"></a>00100 <span class="keywordtype">bool</span> cmdList(const QString& channel = QString());
<a name="l00101"></a>00101 <span class="keywordtype">bool</span> cmdWhois(const QString& nick);
<a name="l00102"></a>00102 <span class="keywordtype">bool</span> cmdMode(const QString& target, const QString& mode = QString());
<a name="l00103"></a>00103 <span class="keywordtype">bool</span> cmdTopic(const QString& channel, const QString& topic = QString());
<a name="l00104"></a>00104 <span class="keywordtype">bool</span> cmdInvite(const QString& nick, const QString& channel);
<a name="l00105"></a>00105 <span class="keywordtype">bool</span> cmdKick(const QString& nick, const QString& channel, const QString& reason = QString());
<a name="l00106"></a>00106 <span class="keywordtype">bool</span> cmdMessage(const QString& receiver, const QString& message);
<a name="l00107"></a>00107 <span class="keywordtype">bool</span> cmdNotice(const QString& receiver, const QString& notice);
<a name="l00108"></a>00108 <span class="keywordtype">bool</span> cmdCtcpAction(const QString& receiver, const QString& action);
<a name="l00109"></a>00109 <span class="keywordtype">bool</span> cmdCtcpRequest(const QString& nick, const QString& request);
<a name="l00110"></a>00110 <span class="keywordtype">bool</span> cmdCtcpReply(const QString& nick, const QString& reply);
<a name="l00111"></a>00111
<a name="l00112"></a>00112 Q_SIGNALS:
<a name="l00113"></a>00113 <span class="keywordtype">void</span> connected();
<a name="l00114"></a>00114 <span class="keywordtype">void</span> disconnected();
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="keywordtype">void</span> msgJoined(const QString& origin, const QString& channel);
<a name="l00117"></a>00117 <span class="keywordtype">void</span> msgParted(const QString& origin, const QString& channel, const QString& message);
<a name="l00118"></a>00118 <span class="keywordtype">void</span> msgQuit(const QString& origin, const QString& message);
<a name="l00119"></a>00119 <span class="keywordtype">void</span> msgNickChanged(const QString& origin, const QString& nick);
<a name="l00120"></a>00120 <span class="keywordtype">void</span> msgModeChanged(const QString& origin, const QString& receiver, const QString& mode, const QString& args);
<a name="l00121"></a>00121 <span class="keywordtype">void</span> msgTopicChanged(const QString& origin, const QString& channel, const QString& topic);
<a name="l00122"></a>00122 <span class="keywordtype">void</span> msgInvited(const QString& origin, const QString& receiver, const QString& channel);
<a name="l00123"></a>00123 <span class="keywordtype">void</span> msgKicked(const QString& origin, const QString& channel, const QString& nick, const QString& message);
<a name="l00124"></a>00124 <span class="keywordtype">void</span> msgMessageReceived(const QString& origin, const QString& receiver, const QString& message);
<a name="l00125"></a>00125 <span class="keywordtype">void</span> msgNoticeReceived(const QString& origin, const QString& receiver, const QString& notice);
<a name="l00126"></a>00126 <span class="keywordtype">void</span> msgCtcpRequestReceived(const QString& origin, const QString& request);
<a name="l00127"></a>00127 <span class="keywordtype">void</span> msgCtcpReplyReceived(const QString& origin, const QString& reply);
<a name="l00128"></a>00128 <span class="keywordtype">void</span> msgCtcpActionReceived(const QString& origin, const QString& receiver, const QString& action);
<a name="l00129"></a>00129 <span class="keywordtype">void</span> msgNumericMessageReceived(const QString& origin, uint code, const QStringList& params);
<a name="l00130"></a>00130 <span class="keywordtype">void</span> msgUnknownMessageReceived(const QString& origin, const QStringList& params);
<a name="l00131"></a>00131
<a name="l00132"></a>00132 private:
<a name="l00133"></a>00133 SessionPrivate* const d_ptr;
<a name="l00134"></a>00134 Q_DECLARE_PRIVATE(<a class="code" href="classIrc_1_1Session.html" title="The Irc::Session class provides an IRC session.">Session</a>)
<a name="l00135"></a>00135 Q_DISABLE_COPY(<a class="code" href="classIrc_1_1Session.html" title="The Irc::Session class provides an IRC session.">Session</a>)
<a name="l00136"></a>00136
<a name="l00137"></a>00137 Q_PRIVATE_SLOT(d_func(), <span class="keywordtype">void</span> _q_connected())
<a name="l00138"></a>00138 Q_PRIVATE_SLOT(d_func(), <span class="keywordtype">void</span> _q_disconnected())
<a name="l00139"></a>00139 Q_PRIVATE_SLOT(d_func(), <span class="keywordtype">void</span> _q_reconnect())
<a name="l00140"></a>00140 Q_PRIVATE_SLOT(d_func(), <span class="keywordtype">void</span> _q_error())
<a name="l00141"></a>00141 Q_PRIVATE_SLOT(d_func(), <span class="keywordtype">void</span> _q_state())
<a name="l00142"></a>00142 Q_PRIVATE_SLOT(d_func(), <span class="keywordtype">void</span> _q_readData())
<a name="l00143"></a>00143 };
<a name="l00144"></a>00144 }
<a name="l00145"></a>00145
<a name="l00146"></a>00146 Q_DECLARE_OPERATORS_FOR_FLAGS(Irc::<a class="code" href="classIrc_1_1Session.html" title="The Irc::Session class provides an IRC session.">Session</a>::Options)
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="preprocessor">#endif // IRC_SESSION_H</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 30 12:36:08 2009 for LibIrcClient-Qt by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
