#include <kgamechat.h>

Public Types | |
enum | SendingIds { SendToGroup = 1 } |
![]() | |
enum | SendingIds { SendToAll = 0 } |
Public Slots | |
virtual void | addMessage (const TQString &fromName, const TQString &text) |
virtual void | addMessage (int fromId, const TQString &text) |
void | slotReceiveMessage (int, const TQByteArray &, TQ_UINT32 receiver, TQ_UINT32 sender) |
![]() | |
virtual void | addMessage (const TQString &fromName, const TQString &text) |
virtual void | addSystemMessage (const TQString &fromName, const TQString &text) |
virtual void | addItem (const TQListBoxItem *item) |
void | slotClear () |
void | setAcceptMessage (bool a) |
Public Member Functions | |
KGameChat (KGame *game, int msgid, KPlayer *fromPlayer, TQWidget *parent) | |
KGameChat (KGame *game, int msgId, TQWidget *parent) | |
KGameChat (TQWidget *parent) | |
void | setFromPlayer (KPlayer *player) |
KPlayer * | fromPlayer () const |
void | setKGame (KGame *g) |
KGame * | game () const |
int | messageId () const |
void | setMessageId (int msgid) |
virtual const TQString & | fromName () const |
![]() | |
KChatBase (TQWidget *parent, bool noComboBox=false) | |
virtual | ~KChatBase () |
virtual const TQString & | fromName () const =0 |
bool | addSendingEntry (const TQString &text, int id) |
bool | insertSendingEntry (const TQString &text, int id, int index=-1) |
void | changeSendingEntry (const TQString &text, int id) |
void | setSendingEntry (int id) |
void | removeSendingEntry (int id) |
int | sendingEntry () const |
int | findIndex (int id) const |
int | nextId () const |
virtual bool | acceptMessage () const |
void | setCompletionMode (TDEGlobalSettings::Completion mode) |
void | setNameFont (const TQFont &font) |
void | setMessageFont (const TQFont &font) |
void | setBothFont (const TQFont &font) |
void | setSystemNameFont (const TQFont &font) |
void | setSystemMessageFont (const TQFont &font) |
void | setSystemBothFont (const TQFont &font) |
const TQFont & | nameFont () const |
const TQFont & | messageFont () const |
const TQFont & | systemNameFont () const |
const TQFont & | systemMessageFont () const |
virtual void | saveConfig (TDEConfig *conf=0) |
virtual void | readConfig (TDEConfig *conf=0) |
void | setMaxItems (int maxItems) |
void | clear () |
int | maxItems () const |
Protected Slots | |
void | slotUnsetKGame () |
void | slotPropertyChanged (KGamePropertyBase *, KPlayer *) |
void | slotAddPlayer (KPlayer *) |
void | slotRemovePlayer (KPlayer *) |
void | slotReceivePrivateMessage (int msgid, const TQByteArray &buffer, TQ_UINT32 sender, KPlayer *me) |
Protected Member Functions | |
bool | isSendToAllMessage (int id) const |
bool | isToGroupMessage (int id) const |
bool | isToPlayerMessage (int id) const |
int | playerId (int id) const |
int | sendingId (int playerId) const |
bool | hasPlayer (int id) const |
virtual TQString | sendToPlayerEntry (const TQString &name) const |
virtual void | returnPressed (const TQString &text) |
![]() | |
virtual void | returnPressed (const TQString &text)=0 |
virtual TQString | comboBoxItem (const TQString &name) const |
virtual TQListBoxItem * | layoutMessage (const TQString &fromName, const TQString &text) |
virtual TQListBoxItem * | layoutSystemMessage (const TQString &fromName, const TQString &text) |
Additional Inherited Members | |
![]() | |
void | rightButtonClicked (TQListBoxItem *, const TQPoint &) |
Detailed Description
A Chat widget for KGame-based games.
Call setFromPlayer() 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...
Definition at line 43 of file kgamechat.h.
Member Enumeration Documentation
◆ SendingIds
enum KGameChat::SendingIds |
Definition at line 72 of file kgamechat.h.
Constructor & Destructor Documentation
◆ KGameChat() [1/3]
Construct a KGame chat widget on game
that used msgid
for the chat message.
The fromPlayer
is the local player (see setFromPlayer).
Definition at line 65 of file kgamechat.cpp.
◆ KGameChat() [2/3]
KGameChat::KGameChat | ( | KGame * | game, |
int | msgId, | ||
TQWidget * | parent | ||
) |
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 setFromPlayer manually.
Definition at line 60 of file kgamechat.cpp.
◆ KGameChat() [3/3]
KGameChat::KGameChat | ( | TQWidget * | parent | ) |
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.
You must call at least setGame, setFromPlayer and setMessageId manually.
- Since
- 3.2
Definition at line 71 of file kgamechat.cpp.
◆ ~KGameChat()
|
virtual |
Definition at line 76 of file kgamechat.cpp.
Member Function Documentation
◆ addMessage [1/2]
|
inlinevirtualslot |
Definition at line 122 of file kgamechat.h.
◆ addMessage [2/2]
|
virtualslot |
Definition at line 91 of file kgamechat.cpp.
◆ fromName()
|
virtual |
reimplemented from KChatBase
- Returns
- KPlayer::name() for the player set by setFromPlayer
Implements KChatBase.
Definition at line 190 of file kgamechat.cpp.
◆ fromPlayer()
KPlayer * KGameChat::fromPlayer | ( | ) | const |
Definition at line 250 of file kgamechat.cpp.
◆ game()
KGame * KGameChat::game | ( | ) | const |
Definition at line 245 of file kgamechat.cpp.
◆ hasPlayer()
|
protected |
- Returns
- True if the player with this ID was added before (see slotAddPlayer)
Definition at line 193 of file kgamechat.cpp.
◆ isSendToAllMessage()
|
protected |
- Parameters
-
id The ID of the sending entry, as returned by KChatBase::sendingEntry
- Returns
- True if the entry "send to all" was selected, otherwise false
Definition at line 157 of file kgamechat.cpp.
◆ isToGroupMessage()
|
protected |
Used to indicate whether a message shall be sent to a group of players.
Note that this was not yet implemented when this doc was written so this description might be wrong. (FIXME)
- Parameters
-
id The ID of the sending entry, as returned by KChatBase::sendingEntry
- Returns
- True if the message is meant to be sent to a group (see KPlayer::group), e.g. if "send to my group" was selected.
Definition at line 160 of file kgamechat.cpp.
◆ isToPlayerMessage()
|
protected |
Used to indicate whether the message shall be sent to a single player only.
Note that you can also call isSendToAllMessage and isToGroupMessage - if both return false it must be a player message. This behaviour might be changed later - so don't depend on it.
See also toPlayerId
- Parameters
-
id The ID of the sending entry, as returned by KChatBase::sendingEntry
- Returns
- True if the message shall be sent to a special player, otherwise false.
Definition at line 163 of file kgamechat.cpp.
◆ messageId()
int KGameChat::messageId | ( | ) | const |
- Returns
- The id of the messages produced by KGameChat. The id will be used in KGame as parameter msgid in the method KGame::sendMessage
Definition at line 154 of file kgamechat.cpp.
◆ playerId()
|
protected |
- Parameters
-
id The ID of the sending entry, as returned by KChatBase::sendingEntry
- Returns
- The ID of the player (see KPlayer::id) the sending entry belongs to. Note that the parameter id is an id as returned by ref KChatBase::sendingEntry and the id this method returns is a KPlayer ID. If isToPlayerMessage returns false this method returns -1
Definition at line 170 of file kgamechat.cpp.
◆ returnPressed()
|
protectedvirtual |
This is called whenever the user pushed return ie wants to send a message.
Note that you MUST add the message to the widget when this function is called as it has already been added to the TDECompletion object of the KLineEdit widget!
Must be implemented in derived classes
- Parameters
-
text The message to be sent
Implements KChatBase.
Definition at line 108 of file kgamechat.cpp.
◆ sendingId()
|
protected |
- Parameters
-
playerId The ID of the KPlayer object
- Returns
- The ID of the sending entry (see KChatBase) or -1 if the player id was not found.
Definition at line 179 of file kgamechat.cpp.
◆ sendToPlayerEntry()
|
protectedvirtual |
- Parameters
-
name The name of the added player
- Returns
- A string that will be added as sending entry in KChatBase. By default this is "send to name" where name is the name that you specify. See also KChatBase::addSendingEntry
Definition at line 167 of file kgamechat.cpp.
◆ setFromPlayer()
void KGameChat::setFromPlayer | ( | KPlayer * | player | ) |
This sets the fromPlayer to player
.
The fromPlayer is the player that will appear as "from" when you send messages through this widget.
- Parameters
-
player The player of this widget
Definition at line 198 of file kgamechat.cpp.
◆ setKGame()
void KGameChat::setKGame | ( | KGame * | g | ) |
Set the KGame object for this chat widget.
All messages will be sent through this object. You don't have to implement any send functions, just call this function, call setFromPlayer and be done :-)
- Parameters
-
g The KGame object the messages will be sent through
Definition at line 221 of file kgamechat.cpp.
◆ setMessageId()
void KGameChat::setMessageId | ( | int | msgid | ) |
Change the message id of the chat widget.
It is recommended that you don't use this but prefer the constructor instead, but in certain situations (such as using this widget in TQt designer) it may be useful to change the message id.
See also messageId
- Since
- 3.2
Definition at line 151 of file kgamechat.cpp.
◆ slotAddPlayer
|
protectedslot |
Definition at line 270 of file kgamechat.cpp.
◆ slotPropertyChanged
|
protectedslot |
Definition at line 307 of file kgamechat.cpp.
◆ slotReceiveMessage
|
slot |
Definition at line 329 of file kgamechat.cpp.
◆ slotReceivePrivateMessage
|
protectedslot |
Called when KPlayer::signalNetworkData is emitted.
The message gets forwarded to slotReceiveMessage if me
equals fromPlayer.
Definition at line 320 of file kgamechat.cpp.
◆ slotRemovePlayer
|
protectedslot |
Definition at line 290 of file kgamechat.cpp.
◆ slotUnsetKGame
|
protectedslot |
Unsets a KGame object that has been set using setKGame before.
You don't have to call this - this is usually done automatically.
Definition at line 255 of file kgamechat.cpp.
The documentation for this class was generated from the following files: