<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>libkdegames: KGameChat Class Reference (libkdegames)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">libkdegames</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.5.5 -->
<div class="contents">
<h1>KGameChat Class Reference</h1><!-- doxytag: class="KGameChat" --><!-- doxytag: inherits="KChatBase" --><code>#include <<a class="el" href="kgamechat_8h-source.html">kgamechat.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for KGameChat:</div>
<div class="dynsection">
<p><center><img src="classKGameChat.png" usemap="#KGameChat_map" border="0" alt=""></center>
<map name="KGameChat_map">
<area href="classKChatBase.html" alt="KChatBase" shape="rect" coords="0,0,78,24">
</map>
</div>
<p>
<a href="classKGameChat-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
A Chat widget for KGame-based games.
<p>
Call <a class="el" href="classKGameChat.html#e8b14c34e1d1aecb8308cfb7857bc4a5">setFromPlayer()</a> first - this will be used as the "from" part of every message you will send. Otherwise it won't work! You can also use the fromPlayer parameter in the constructor though...<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Andreas Beckermann <<a href="mailto:b_mann@gmx.de">b_mann@gmx.de</a>> </dd></dl>
<p>Definition at line <a class="el" href="kgamechat_8h-source.html#l00043">43</a> of file <a class="el" href="kgamechat_8h-source.html">kgamechat.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b>SendingIds</b> { <b>SendToGroup</b> = 1
}</td></tr>
<tr><td colspan="2"><br><h2>Public Slots</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#aeb15c81209b7df7e110b07d3431e187">addMessage</a> (const QString &fromName, const QString &text)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2af936f57b48a7e14872d35e9ff3b12d"></a><!-- doxytag: member="KGameChat::addMessage" ref="2af936f57b48a7e14872d35e9ff3b12d" args="(int fromId, const QString &text)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>addMessage</b> (int fromId, const QString &text)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6c21d50afc04b5ef52f4d7603ae8da96"></a><!-- doxytag: member="KGameChat::slotReceiveMessage" ref="6c21d50afc04b5ef52f4d7603ae8da96" args="(int, const QByteArray &, Q_UINT32 receiver, Q_UINT32 sender)" -->
void </td><td class="memItemRight" valign="bottom"><b>slotReceiveMessage</b> (int, const QByteArray &, Q_UINT32 receiver, Q_UINT32 sender)</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#2ba3c277135514583772eb2b888c4f22">KGameChat</a> (<a class="el" href="classKGame.html">KGame</a> *game, int msgid, <a class="el" href="classKPlayer.html">KPlayer</a> *fromPlayer, QWidget *parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#b3f5867a0e813688b39d9de7d11f4e3e">KGameChat</a> (<a class="el" href="classKGame.html">KGame</a> *game, int msgId, QWidget *parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#da920d9cd058fc1bdfc935e4ed24f3c4">KGameChat</a> (QWidget *parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#e8b14c34e1d1aecb8308cfb7857bc4a5">setFromPlayer</a> (<a class="el" href="classKPlayer.html">KPlayer</a> *player)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d62c4d293bd8d09a18748a8687d07dce"></a><!-- doxytag: member="KGameChat::fromPlayer" ref="d62c4d293bd8d09a18748a8687d07dce" args="() const " -->
<a class="el" href="classKPlayer.html">KPlayer</a> * </td><td class="memItemRight" valign="bottom"><b>fromPlayer</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#43dea3262a4cb97e8913a13c48c807ec">setKGame</a> (<a class="el" href="classKGame.html">KGame</a> *g)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="33ff37288b729b1a2ef2476374f2f003"></a><!-- doxytag: member="KGameChat::game" ref="33ff37288b729b1a2ef2476374f2f003" args="() const " -->
<a class="el" href="classKGame.html">KGame</a> * </td><td class="memItemRight" valign="bottom"><b>game</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#2c0723ab043701f26b36e9d17734e341">messageId</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#95cce83ecb197d813b481edfeae4d818">setMessageId</a> (int msgid)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#7c9c444f7d085998e8462bc39ba6e5d4">fromName</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Protected Slots</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#1fe2536d45f57e036de1d02d4767a43c">slotUnsetKGame</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f217ba0ad1ebcb5a1782787e73b94384"></a><!-- doxytag: member="KGameChat::slotPropertyChanged" ref="f217ba0ad1ebcb5a1782787e73b94384" args="(KGamePropertyBase *, KPlayer *)" -->
void </td><td class="memItemRight" valign="bottom"><b>slotPropertyChanged</b> (<a class="el" href="classKGamePropertyBase.html">KGamePropertyBase</a> *, <a class="el" href="classKPlayer.html">KPlayer</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4a7ddbfa28f8ff341aa15a1f5ff748b"></a><!-- doxytag: member="KGameChat::slotAddPlayer" ref="d4a7ddbfa28f8ff341aa15a1f5ff748b" args="(KPlayer *)" -->
void </td><td class="memItemRight" valign="bottom"><b>slotAddPlayer</b> (<a class="el" href="classKPlayer.html">KPlayer</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6b3d9e08d74cf26cc5660a08f9d50aa4"></a><!-- doxytag: member="KGameChat::slotRemovePlayer" ref="6b3d9e08d74cf26cc5660a08f9d50aa4" args="(KPlayer *)" -->
void </td><td class="memItemRight" valign="bottom"><b>slotRemovePlayer</b> (<a class="el" href="classKPlayer.html">KPlayer</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#03577cf6a8c48960e88ca0c62b41d9b0">slotReceivePrivateMessage</a> (int msgid, const QByteArray &buffer, Q_UINT32 sender, <a class="el" href="classKPlayer.html">KPlayer</a> *me)</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#125d1642ea0d52a2e2039c9030b394bc">isSendToAllMessage</a> (int id) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#13ce999c7280df42d9bc4354534a075b">isToGroupMessage</a> (int id) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#ce6812a353f58a4a6fceb5e99fd129e0">isToPlayerMessage</a> (int id) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#35de19b14b4672aaacb85a106d6b90c8">playerId</a> (int id) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#d5f7c056d39c0735a05d94825fd1b292">sendingId</a> (int playerId) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#46b4943f3d7d35c2f9424080e01c7a53">hasPlayer</a> (int id) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#f4c80cf495d64f2c8223d20f631cb372">sendToPlayerEntry</a> (const QString &name) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKGameChat.html#bdbd8f2335fae5ba98d3360b2b16bb55">returnPressed</a> (const QString &text)</td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="2ba3c277135514583772eb2b888c4f22"></a><!-- doxytag: member="KGameChat::KGameChat" ref="2ba3c277135514583772eb2b888c4f22" args="(KGame *game, int msgid, KPlayer *fromPlayer, QWidget *parent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KGameChat::KGameChat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKGame.html">KGame</a> * </td>
<td class="paramname"> <em>game</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>msgid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classKPlayer.html">KPlayer</a> * </td>
<td class="paramname"> <em>fromPlayer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QWidget * </td>
<td class="paramname"> <em>parent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct a <a class="el" href="classKGame.html">KGame</a> chat widget on <code>game</code> that used <code>msgid</code> for the chat message.
<p>
The <code>fromPlayer</code> is the local player (see <a class="el" href="classKGameChat.html#e8b14c34e1d1aecb8308cfb7857bc4a5">setFromPlayer</a>).
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00065">65</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="b3f5867a0e813688b39d9de7d11f4e3e"></a><!-- doxytag: member="KGameChat::KGameChat" ref="b3f5867a0e813688b39d9de7d11f4e3e" args="(KGame *game, int msgId, QWidget *parent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KGameChat::KGameChat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKGame.html">KGame</a> * </td>
<td class="paramname"> <em>game</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>msgId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QWidget * </td>
<td class="paramname"> <em>parent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. To make use of this widget you need to call <a class="el" href="classKGameChat.html#e8b14c34e1d1aecb8308cfb7857bc4a5">setFromPlayer</a> manually.
<p>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00060">60</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="da920d9cd058fc1bdfc935e4ed24f3c4"></a><!-- doxytag: member="KGameChat::KGameChat" ref="da920d9cd058fc1bdfc935e4ed24f3c4" args="(QWidget *parent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KGameChat::KGameChat </td>
<td>(</td>
<td class="paramtype">QWidget * </td>
<td class="paramname"> <em>parent</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This constructs a widget that is not usable.
<p>
You must call at least setGame, setFromPlayer and setMessageId manually. <dl class="since" compact><dt><b>Since:</b></dt><dd>3.2 </dd></dl>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00071">71</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e8b14c34e1d1aecb8308cfb7857bc4a5"></a><!-- doxytag: member="KGameChat::setFromPlayer" ref="e8b14c34e1d1aecb8308cfb7857bc4a5" args="(KPlayer *player)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KGameChat::setFromPlayer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPlayer.html">KPlayer</a> * </td>
<td class="paramname"> <em>player</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This sets the fromPlayer to <code>player</code>.
<p>
The fromPlayer is the player that will appear as "from" when you send messages through this widget. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>player</em> </td><td>The player of this widget </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00198">198</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="43dea3262a4cb97e8913a13c48c807ec"></a><!-- doxytag: member="KGameChat::setKGame" ref="43dea3262a4cb97e8913a13c48c807ec" args="(KGame *g)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KGameChat::setKGame </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKGame.html">KGame</a> * </td>
<td class="paramname"> <em>g</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the <a class="el" href="classKGame.html">KGame</a> object for this chat widget.
<p>
All messages will be sent through this object. You don't have to implement any send functions, just call this function, call <a class="el" href="classKGameChat.html#e8b14c34e1d1aecb8308cfb7857bc4a5">setFromPlayer</a> and be done :-) <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>g</em> </td><td>The <a class="el" href="classKGame.html">KGame</a> object the messages will be sent through </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00221">221</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="2c0723ab043701f26b36e9d17734e341"></a><!-- doxytag: member="KGameChat::messageId" ref="2c0723ab043701f26b36e9d17734e341" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int KGameChat::messageId </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The id of the messages produced by <a class="el" href="classKGameChat.html" title="A Chat widget for KGame-based games.">KGameChat</a>. The id will be used in <a class="el" href="classKGame.html">KGame</a> as parameter msgid in the method <a class="el" href="classKGameNetwork.html#27afbe51a7837e653b5513c4fd3e0af4">KGame::sendMessage</a> </dd></dl>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00154">154</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="95cce83ecb197d813b481edfeae4d818"></a><!-- doxytag: member="KGameChat::setMessageId" ref="95cce83ecb197d813b481edfeae4d818" args="(int msgid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KGameChat::setMessageId </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>msgid</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the message id of the chat widget.
<p>
It is recommended that you don't use this but prefer the constructor instead, but in certain situations (such as using this widget in Qt designer) it may be useful to change the message id.<p>
See also <a class="el" href="classKGameChat.html#2c0723ab043701f26b36e9d17734e341">messageId</a> <dl class="since" compact><dt><b>Since:</b></dt><dd>3.2 </dd></dl>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00151">151</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="7c9c444f7d085998e8462bc39ba6e5d4"></a><!-- doxytag: member="KGameChat::fromName" ref="7c9c444f7d085998e8462bc39ba6e5d4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const QString & KGameChat::fromName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
reimplemented from <a class="el" href="classKChatBase.html">KChatBase</a>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classKPlayer.html#ec005101037bbdf9d445f69a5d6682c9">KPlayer::name()</a> for the player set by <a class="el" href="classKGameChat.html#e8b14c34e1d1aecb8308cfb7857bc4a5">setFromPlayer</a> </dd></dl>
<p>Implements <a class="el" href="classKChatBase.html#bcbc2a1c411c4c352ea22dbe7325645d">KChatBase</a>.</p>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00190">190</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="aeb15c81209b7df7e110b07d3431e187"></a><!-- doxytag: member="KGameChat::addMessage" ref="aeb15c81209b7df7e110b07d3431e187" args="(const QString &fromName, const QString &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void KGameChat::addMessage </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>fromName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>text</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline, virtual, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a text in the listbox.
<p>
See also signalSendMessage()<p>
Maybe you want to replace this with a function that creates a nicer text than "fromName: text"<p>
Update: the function layoutMessage is called by this now. This means that you will get user defined outlook on the messages :-) <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fromName</em> </td><td>The player who sent this message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>The text to be added </td></tr>
</table>
</dl>
<p>Reimplemented from <a class="el" href="classKChatBase.html#87230262c5a40c360fddc4df22bd396c">KChatBase</a>.</p>
<p>Definition at line <a class="el" href="kgamechat_8h-source.html#l00121">121</a> of file <a class="el" href="kgamechat_8h-source.html">kgamechat.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="125d1642ea0d52a2e2039c9030b394bc"></a><!-- doxytag: member="KGameChat::isSendToAllMessage" ref="125d1642ea0d52a2e2039c9030b394bc" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KGameChat::isSendToAllMessage </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td width="100%"> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The ID of the sending entry, as returned by <a class="el" href="classKChatBase.html#1847d424028059dbf73c95eacf3be977">KChatBase::sendingEntry</a> </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the entry "send to all" was selected, otherwise false </dd></dl>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00157">157</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="13ce999c7280df42d9bc4354534a075b"></a><!-- doxytag: member="KGameChat::isToGroupMessage" ref="13ce999c7280df42d9bc4354534a075b" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KGameChat::isToGroupMessage </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td width="100%"> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Used to indicate whether a message shall be sent to a group of players.
<p>
Note that this was not yet implemented when this doc was written so this description might be wrong. (FIXME) <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The ID of the sending entry, as returned by <a class="el" href="classKChatBase.html#1847d424028059dbf73c95eacf3be977">KChatBase::sendingEntry</a> </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the message is meant to be sent to a group (see <a class="el" href="classKPlayer.html#300571584f3fb5da37bf56b377131b03">KPlayer::group</a>), e.g. if "send to my group" was selected. </dd></dl>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00160">160</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="ce6812a353f58a4a6fceb5e99fd129e0"></a><!-- doxytag: member="KGameChat::isToPlayerMessage" ref="ce6812a353f58a4a6fceb5e99fd129e0" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KGameChat::isToPlayerMessage </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td width="100%"> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Used to indicate whether the message shall be sent to a single player only.
<p>
Note that you can also call <a class="el" href="classKGameChat.html#125d1642ea0d52a2e2039c9030b394bc">isSendToAllMessage</a> and <a class="el" href="classKGameChat.html#13ce999c7280df42d9bc4354534a075b">isToGroupMessage</a> - if both return false it must be a player message. This behaviour might be changed later - so don't depend on it.<p>
See also toPlayerId <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The ID of the sending entry, as returned by <a class="el" href="classKChatBase.html#1847d424028059dbf73c95eacf3be977">KChatBase::sendingEntry</a> </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the message shall be sent to a special player, otherwise false. </dd></dl>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00163">163</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="35de19b14b4672aaacb85a106d6b90c8"></a><!-- doxytag: member="KGameChat::playerId" ref="35de19b14b4672aaacb85a106d6b90c8" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int KGameChat::playerId </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td width="100%"> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>The ID of the sending entry, as returned by <a class="el" href="classKChatBase.html#1847d424028059dbf73c95eacf3be977">KChatBase::sendingEntry</a> </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The ID of the player (see <a class="el" href="classKPlayer.html#a1151863225396c0f96678bf3ca938ae" title="Returns the id of the player.">KPlayer::id</a>) the sending entry belongs to. Note that the parameter id is an id as returned by ref <a class="el" href="classKChatBase.html#1847d424028059dbf73c95eacf3be977">KChatBase::sendingEntry</a> and the id this method returns is a <a class="el" href="classKPlayer.html" title="Base class for a game player.">KPlayer</a> ID. If isToPlayerMessage returns false this method returns -1 </dd></dl>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00170">170</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="d5f7c056d39c0735a05d94825fd1b292"></a><!-- doxytag: member="KGameChat::sendingId" ref="d5f7c056d39c0735a05d94825fd1b292" args="(int playerId) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int KGameChat::sendingId </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>playerId</em> </td>
<td> ) </td>
<td width="100%"> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>playerId</em> </td><td>The ID of the <a class="el" href="classKPlayer.html" title="Base class for a game player.">KPlayer</a> object </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The ID of the sending entry (see <a class="el" href="classKChatBase.html" title="The base class for chat widgets.">KChatBase</a>) or -1 if the player id was not found. </dd></dl>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00179">179</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="46b4943f3d7d35c2f9424080e01c7a53"></a><!-- doxytag: member="KGameChat::hasPlayer" ref="46b4943f3d7d35c2f9424080e01c7a53" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KGameChat::hasPlayer </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td width="100%"> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the player with this ID was added before (see slotAddPlayer) </dd></dl>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00193">193</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="f4c80cf495d64f2c8223d20f631cb372"></a><!-- doxytag: member="KGameChat::sendToPlayerEntry" ref="f4c80cf495d64f2c8223d20f631cb372" args="(const QString &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString KGameChat::sendToPlayerEntry </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the added player </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A string that will be added as sending entry in <a class="el" href="classKChatBase.html">KChatBase</a>. By default this is "send to name" where name is the name that you specify. See also <a class="el" href="classKChatBase.html#d86a506bd30b229d77a6643cf63f3140" title="Adds a new entry in the combo box.">KChatBase::addSendingEntry</a> </dd></dl>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00167">167</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="1fe2536d45f57e036de1d02d4767a43c"></a><!-- doxytag: member="KGameChat::slotUnsetKGame" ref="1fe2536d45f57e036de1d02d4767a43c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KGameChat::slotUnsetKGame </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unsets a <a class="el" href="classKGame.html" title="The main KDE game object.">KGame</a> object that has been set using setKGame before.
<p>
You don't have to call this - this is usually done automatically.
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00255">255</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="03577cf6a8c48960e88ca0c62b41d9b0"></a><!-- doxytag: member="KGameChat::slotReceivePrivateMessage" ref="03577cf6a8c48960e88ca0c62b41d9b0" args="(int msgid, const QByteArray &buffer, Q_UINT32 sender, KPlayer *me)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KGameChat::slotReceivePrivateMessage </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>msgid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QByteArray & </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Q_UINT32 </td>
<td class="paramname"> <em>sender</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classKPlayer.html">KPlayer</a> * </td>
<td class="paramname"> <em>me</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [protected, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Called when <a class="el" href="classKPlayer.html#210346b1f5f4200a1f9dbb028dda9781" title="The player object got a message which was targeted at it but has no default method...">KPlayer::signalNetworkData</a> is emitted.
<p>
The message gets forwarded to slotReceiveMessage if <code>me</code> equals fromPlayer.
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00320">320</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="bdbd8f2335fae5ba98d3360b2b16bb55"></a><!-- doxytag: member="KGameChat::returnPressed" ref="bdbd8f2335fae5ba98d3360b2b16bb55" args="(const QString &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KGameChat::returnPressed </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>text</em> </td>
<td> ) </td>
<td width="100%"><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This is called whenever the user pushed return ie wants to send a message.
<p>
Note that you MUST add the message to the widget when this function is called as it has already been added to the KCompletion object of the KLineEdit widget!<p>
Must be implemented in derived classes <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>The message to be sent </td></tr>
</table>
</dl>
<p>Implements <a class="el" href="classKChatBase.html#a5094584b796d548536a6fdaa36e1364">KChatBase</a>.</p>
<p>Definition at line <a class="el" href="kgamechat_8cpp-source.html#l00108">108</a> of file <a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="kgamechat_8h-source.html">kgamechat.h</a><li><a class="el" href="kgamechat_8cpp-source.html">kgamechat.cpp</a></ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>libkdegames</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKCanvasRootPixmap.html">kcanvasrootpixmap</option>, <option value="classKCardDialog.html">kcarddialog</option>, <option value="classKChat.html">kchat</option>, <option value="classKChatBase.html">kchatbase</option>, <option value="classKChatBaseText.html">kchatbasetext</option>, <option value="classKExtHighscore_1_1Item.html">kexthighscore::item</option>, <option value="classKExtHighscore_1_1ItemArray.html">kexthighscore::itemarray</option>, <option value="classKExtHighscore_1_1Manager.html">kexthighscore::manager</option>, <option value="classKExtHighscore_1_1MultiplayerScores.html">kexthighscore::multiplayerscores</option>, <option value="classKExtHighscore_1_1Score.html">kexthighscore::score</option>, <option value="classKGame.html">kgame</option>, <option value="classKGameChat.html">kgamechat</option>, <option value="classKGameComputerIO.html">kgamecomputerio</option>, <option value="classKGameConnectDialog.html">kgameconnectdialog</option>, <option value="classKGameDialog.html">kgamedialog</option>, <option value="classKGameDialogChatConfig.html">kgamedialogchatconfig</option>, <option value="classKGameDialogConfig.html">kgamedialogconfig</option>, <option value="classKGameErrorDialog.html">kgameerrordialog</option>, <option value="classKGameErrorMessageDialog.html">kgameerrormessagedialog</option>, <option value="classKGameIO.html">kgameio</option>, <option value="classKGameKeyIO.html">kgamekeyio</option>, <option value="classKGameLCD.html">kgamelcd</option>, <option value="classKGameLCDClock.html">kgamelcdclock</option>, <option value="classKGameLCDList.html">kgamelcdlist</option>, <option value="classKGameMisc.html">kgamemisc</option>, <option value="classKGameMouseIO.html">kgamemouseio</option>, <option value="classKGameNetwork.html">kgamenetwork</option>, <option value="classKGameProcess.html">kgameprocess</option>, <option value="classKGameProcessIO.html">kgameprocessio</option>, <option value="classKGameProgress.html">kgameprogress</option>, <option value="classKGameProperty.html">kgameproperty</option>, <option value="classKGamePropertyBase.html">kgamepropertybase</option>, <option value="classKGamePropertyHandler.html">kgamepropertyhandler</option>, <option value="classKGameSequence.html">kgamesequence</option>, <option value="classKGrid2D_1_1Generic.html">kgrid2d::generic</option>, <option value="classKGrid2D_1_1Hexagonal.html">kgrid2d::hexagonal</option>, <option value="classKGrid2D_1_1HexagonalBase.html">kgrid2d::hexagonalbase</option>, <option value="classKGrid2D_1_1Square.html">kgrid2d::square</option>, <option value="classKGrid2D_1_1SquareBase.html">kgrid2d::squarebase</option>, <option value="classKHighscore.html">khighscore</option>, <option value="classKMessageClient.html">kmessageclient</option>, <option value="classKMessageDirect.html">kmessagedirect</option>, <option value="classKMessageIO.html">kmessageio</option>, <option value="classKMessageServer.html">kmessageserver</option>, <option value="classKMessageServerSocket.html">kmessageserversocket</option>, <option value="classKMessageSocket.html">kmessagesocket</option>, <option value="classKPlayer.html">kplayer</option>, <option value="classKScoreDialog.html">kscoredialog</option>, <option value="classKStdGameAction.html">kstdgameaction</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../libkdegames/html/index.html">libkdegames</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
ea24284f03fd4a8a4b64047514d93f64
>
files
>
117
