#include <kchat.h>
A chat widget for non-KGame games.
Docu is TODO
- Author
- Andreas Beckermann b_man.nosp@m.n@gm.nosp@m.x.de
Definition at line 36 of file kchat.h.
◆ KChat()
KChat::KChat |
( |
TQWidget * |
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.
◆ ~KChat()
◆ addPlayer()
int KChat::addPlayer |
( |
const TQString & |
nick | ) |
|
Adds a player nickname.
- Returns
- The unique ID of the player
Definition at line 92 of file kchat.cpp.
◆ autoAddMessages()
bool KChat::autoAddMessages |
( |
| ) |
const |
◆ fromId()
int KChat::fromId |
( |
| ) |
const |
◆ fromName()
const TQString & 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.
◆ player()
const TQString & KChat::player |
( |
int |
id | ) |
const |
- Returns
- The nickname of the player which belongs to this id
Definition at line 71 of file kchat.cpp.
◆ removePlayer() [1/2]
void KChat::removePlayer |
( |
const TQString & |
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.
◆ removePlayer() [2/2]
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.
◆ returnPressed()
void KChat::returnPressed |
( |
const TQString & |
text | ) |
|
|
protectedvirtual |
◆ setAutoAddMessages()
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.
◆ setFromNickname()
void KChat::setFromNickname |
( |
const TQString & |
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.
◆ signalSendMessage
void KChat::signalSendMessage |
( |
int |
id, |
|
|
const TQString & |
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 |
◆ uniqueId()
The Id of the next player.
Incremented after every call.
Definition at line 67 of file kchat.cpp.
The documentation for this class was generated from the following files: