libkdegames Library API Documentation

KChat Class Reference

A chat widget for non-KGame games. More...

#include <kchat.h>

Inheritance diagram for KChat:

Inheritance graph
[legend]
Collaboration diagram for KChat:

Collaboration graph
[legend]
List of all members.

Signals

void signalSendMessage (int id, const QString &msg)

Public Member Functions

 KChat (QWidget *parent, bool twoPlayerGame=false)
virtual const QStringfromName () const
void setFromNickname (const QString &name)
int addPlayer (const QString &nick)
void removePlayer (const QString &nick)
void removePlayer (int id)
bool autoAddMessages () const
void setAutoAddMessages (bool add)
const QStringplayer (int id) const
int fromId () const

Protected Member Functions

virtual void returnPressed (const QString &)
int uniqueId ()

Detailed Description

A chat widget for non-KGame games.

Docu is TODO

Author:
Andreas Beckermann <b_mann@gmx.de>

Definition at line 36 of file kchat.h.


Constructor & Destructor Documentation

KChat::KChat QWidget parent,
bool  twoPlayerGame = false
 

Parameters:
parent The parent widget for this widget.
twoPlayerGame If true the combo box where the player can choose to send to a single player or to all players will not be added as you will hardly need it in 2-player games.

Definition at line 39 of file kchat.cpp.


Member Function Documentation

const QString & KChat::fromName  )  const [virtual]
 

Equivalent to player(fromId()).

Returns:
The name that will be shown for messages from this widget. That is the string from setFromNickname

Implements KChatBase.

Definition at line 61 of file kchat.cpp.

References fromId(), and player().

void KChat::setFromNickname const QString name  ) 
 

This sets the name that will be shown on all chat widgets if this widget sends a message.

See signalSendMessage

Parameters:
name The name of the player owning this widget

Definition at line 59 of file kchat.cpp.

References addPlayer().

int KChat::addPlayer const QString nick  ) 
 

Adds a player nickname.

Returns:
The unique ID of the player

Definition at line 92 of file kchat.cpp.

References uniqueId().

Referenced by setFromNickname().

void KChat::removePlayer const QString nick  ) 
 

Removes all players with this nickname.

Better don't use this as it will remove *all* players with this nickname. Save the id instead and call removePlayer(id)

Parameters:
nick The nickname of the removed players

Definition at line 104 of file kchat.cpp.

void KChat::removePlayer int  id  ) 
 

Removes the player with this id, as returned by addPlayer.

Parameters:
id The id of the player to be removed

Definition at line 99 of file kchat.cpp.

bool KChat::autoAddMessages  )  const
 

Returns:
true if the messages which will be sent from here will be added automatically using KChatBase::addMessage. See also setAutoAddMessages

Definition at line 65 of file kchat.cpp.

Referenced by returnPressed().

void KChat::setAutoAddMessages bool  add  ) 
 

Usually the messages which will be sent from here (see signalSendMessage) are added autmatically to this widget.

But under some circumstances that would be very unhandy. So you can deactivate this behaviour here and call KChatBase::addMessage yourself

Parameters:
add If true (default) messages sent from here will be added automatically. Otherwise you will have to add them yourself

Definition at line 63 of file kchat.cpp.

const QString & KChat::player int  id  )  const
 

Returns:
The nickname of the player which belongs to this id

Definition at line 71 of file kchat.cpp.

Referenced by fromName(), and returnPressed().

int KChat::fromId  )  const
 

Returns:
The ID that belongs to the local player.
See also:
setFromNickname

Definition at line 69 of file kchat.cpp.

Referenced by fromName(), and returnPressed().

void KChat::signalSendMessage int  id,
const QString msg
[signal]
 

This signal is emitted when the player wants to send a message.

The message is added automatically using KChatBase::addMessage if autoAddMessages is enabled.

Parameters:
id The id of the player who sends the message - see setFromNickname and player
msg The message itself

Referenced by returnPressed().

void KChat::returnPressed const QString  )  [protected, virtual]
 

This emits signalSendMessage and, if autoAddMessages is true, calls KChatBase::addMessage.

Implements KChatBase.

Definition at line 74 of file kchat.cpp.

References KChatBase::addMessage(), autoAddMessages(), fromId(), player(), and signalSendMessage().

int KChat::uniqueId  )  [protected]
 

The Id of the next player.

Incremented after every call.

Definition at line 67 of file kchat.cpp.

Referenced by addPlayer().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkdegames Library Version 3.3.91.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Feb 22 20:07:14 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003