KDE 4.2 API Reference libkdegames
KChat Class Reference
#include <KChat>
Inheritance diagram for KChat:
Detailed Description
A chat widget for non-KGame games.Docu is TODO
Definition at line 36 of file kchat.h.
Signals | |
| void | signalSendMessage (int id, const QString &msg) |
Public Member Functions | |
| int | addPlayer (const QString &nick) |
| bool | autoAddMessages () const |
| int | fromId () const |
| virtual QString | fromName () const |
| KChat (QWidget *parent, bool twoPlayerGame=false) | |
| QString | player (int id) const |
| void | removePlayer (int id) |
| void | removePlayer (const QString &nick) |
| void | setAutoAddMessages (bool add) |
| void | setFromNickname (const QString &name) |
| virtual | ~KChat () |
Protected Member Functions | |
| virtual void | returnPressed (const QString &) |
| int | uniqueId () |
Constructor & Destructor Documentation
| KChat::KChat | ( | QWidget * | parent, | |
| bool | twoPlayerGame = false | |||
| ) | [explicit] |
Member Function Documentation
| int KChat::addPlayer | ( | const QString & | nick | ) |
| 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
| int KChat::fromId | ( | ) | 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.
| QString KChat::player | ( | int | id | ) | const |
| void KChat::removePlayer | ( | int | id | ) |
| void KChat::removePlayer | ( | const QString & | nick | ) |
| void KChat::returnPressed | ( | const QString & | text | ) | [protected, virtual] |
This emits signalSendMessage and, if autoAddMessages is true, calls KChatBase::addMessage.
Implements KChatBase.
| 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
| void KChat::setFromNickname | ( | const QString & | name | ) |
| 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
| int KChat::uniqueId | ( | ) | [protected] |
The documentation for this class was generated from the following files:
