• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • libtdegames
 

libtdegames

Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
KChatBase Class Referenceabstract

#include <kchatbase.h>

Inheritance diagram for KChatBase:
KChat KGameChat

Public Types

enum  SendingIds { SendToAll = 0 }
 

Public Slots

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)
 

Signals

void rightButtonClicked (TQListBoxItem *, const TQPoint &)
 

Public Member Functions

 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 Member Functions

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)
 

Detailed Description

The base class for chat widgets.

This is the base class for both KChat and KGameChat. KGameChat is the class you want to use if you write a KGame based game as it will do most things for you. KChat is more or less the same but not KGame dependant

KChatBase provides a complete chat widget, featuring different sending means (e.g. "send to all", "send to player1", "send to group2" and so on - see addSendingEntry). It also provides full auto-completion capabilities (see TDECompletion and KLineEdit) which defaults to disabled. The user can change this by right-clicking on the KLineEdit widget and selecting the desired behaviour. You can also change this manually by calling setCompletionMode.

To make KChatBase useful you have to overwrite at least returnPressed. Here you should send the message to all of your clients (or just some of them, depending on sendingEntry).

To add a message just call addMessage with the nickname of the player who sent the message and the message itself. If you don't want to use layoutMessage by any reason you can also call addItem directly. But you should better replace layoutMessage instead.

You probably don't want to use the abstract class KChatBase directly but use one of the derived classess KChat or KGameChat. The latter is the widget of choice if you develop a KGame application as you don't have to do anything but providing a KGame object.

Author
Andreas Beckermann b_man.nosp@m.n@gm.nosp@m.x.de

Definition at line 184 of file kchatbase.h.

Constructor & Destructor Documentation

◆ KChatBase()

KChatBase::KChatBase ( TQWidget *  parent,
bool  noComboBox = false 
)
Parameters
parentThe parent widget for this widget.
noComboBoxIf true then the combo box where the player can choose where to send messages to (either globally or just to some players) will not be added.

Definition at line 185 of file kchatbase.cpp.

◆ ~KChatBase()

KChatBase::~KChatBase ( )
virtual

Destruct the KChatBase object.

Also calls saveConfig

Definition at line 190 of file kchatbase.cpp.

Member Function Documentation

◆ acceptMessage()

bool KChatBase::acceptMessage ( ) const
virtual
Returns
True if this widget is able to send messages (see returnPressed) and false if not. The default implementation returns the value which has been set by setAcceptMessage (true by default)

Definition at line 244 of file kchatbase.cpp.

◆ addItem

void KChatBase::addItem ( const TQListBoxItem *  item)
virtualslot

This member function is mainly internally used to add a message.

It is called by addMessage which creates a single text from a player name and a text. You will hardly ever use this - but if you need it it will be here ;-)

But you may want to replace this in a derived class to create a non-default (maybe nicer ;-) ) behaviour

Parameters
itemThe TQListBoxItem that is being added

Definition at line 339 of file kchatbase.cpp.

◆ addMessage

void KChatBase::addMessage ( const TQString &  fromName,
const TQString &  text 
)
virtualslot

Add a text in the listbox.

See also signalSendMessage()

Maybe you want to replace this with a function that creates a nicer text than "fromName: text"

Update: the function layoutMessage is called by this now. This means that you will get user defined outlook on the messages :-)

Parameters
fromNameThe player who sent this message
textThe text to be added

Definition at line 349 of file kchatbase.cpp.

◆ addSendingEntry()

bool KChatBase::addSendingEntry ( const TQString &  text,
int  id 
)

Adds a new entry in the combo box.

The default is "send to all players" only. This function is provided for convenience. You can also call inserSendingEntry with index = -1. See also nextId!

Parameters
textThe text of the new entry
idAn ID for this entry. This must be unique for this entry. It has nothing to do with the position of the entry in the combo box. See nextId
Returns
True if successful, otherwise false (e.g. if the id is already used)

Definition at line 250 of file kchatbase.cpp.

◆ addSystemMessage

void KChatBase::addSystemMessage ( const TQString &  fromName,
const TQString &  text 
)
virtualslot

This works just like addMessage but adds a system message.

layoutSystemMessage is used to generate the displayed item. System messages will have a different look than player messages.

You may wish to use this to display status information from your game.

Definition at line 355 of file kchatbase.cpp.

◆ changeSendingEntry()

void KChatBase::changeSendingEntry ( const TQString &  text,
int  id 
)

This changes a combo box entry.

Parameters
textThe new text of the entry
idThe ID of the item to be changed

Definition at line 306 of file kchatbase.cpp.

◆ clear()

void KChatBase::clear ( )

Clear all messages in the list.

Definition at line 508 of file kchatbase.cpp.

◆ comboBoxItem()

TQString KChatBase::comboBoxItem ( const TQString &  name) const
protectedvirtual

Replace to customise the combo box.

Default: i18n("Send to %1).arg(name)

Parameters
nameThe name of the player
Returns
The string as it will be shown in the combo box

Definition at line 407 of file kchatbase.cpp.

◆ findIndex()

int KChatBase::findIndex ( int  id) const
Returns
The index of the combo box entry with the given id

Definition at line 325 of file kchatbase.cpp.

◆ fromName()

virtual const TQString& KChatBase::fromName ( ) const
pure virtual
Returns
The name that will be shown for messages from this widget. Either the string that was set by setFromName or the name of the player that was set by setFromPlayer

Implemented in KGameChat, and KChat.

◆ insertSendingEntry()

bool KChatBase::insertSendingEntry ( const TQString &  text,
int  id,
int  index = -1 
)

Inserts a new entry in the combo box.

Parameters
textThe entry
idAn ID for this entry. This must be unique for this entry. It has nothing to do with the position of the entry in the combo box!
See also
nextId
Parameters
indexThe position of the entry. If -1 the entry will be added at the bottom
Returns
True if successful, otherwise false (e.g. if the id is already used)

Definition at line 259 of file kchatbase.cpp.

◆ layoutMessage()

TQListBoxItem * KChatBase::layoutMessage ( const TQString &  fromName,
const TQString &  text 
)
protectedvirtual

Create a TQListBoxItem for this message.

This function is not yet written usefully - currently just a TQListBoxTex object is created which shows the message in this format: "fromName: text". This should fit most peoples needs but needs further improvements.

Definition at line 360 of file kchatbase.cpp.

◆ layoutSystemMessage()

TQListBoxItem * KChatBase::layoutSystemMessage ( const TQString &  fromName,
const TQString &  text 
)
protectedvirtual

Create a TQListBoxItem for this message.

This does the same as layoutMessage but generates a system message. You might want to use such a message to display e.g. status information from your game.

The default implementation just prepends "--- ".

Definition at line 382 of file kchatbase.cpp.

◆ maxItems()

int KChatBase::maxItems ( ) const
Returns
The maximum number of messages in the list. -1 is unlimited. See also setMaxItems

Definition at line 526 of file kchatbase.cpp.

◆ messageFont()

const TQFont & KChatBase::messageFont ( ) const

This font should be used for a message.

layoutMessage sets the font of a message using KChatBaseText::setMessageFont but if ypu replace layoutMessage with your own function you should use messageFont() yourself.

Returns
The font that is used for a message

Definition at line 441 of file kchatbase.cpp.

◆ nameFont()

const TQFont & KChatBase::nameFont ( ) const

This font should be used for the name (the "from: " part) of a message.

layoutMessage uses this to set the font using KChatBaseText::setNameFont but if you want to overwrite layoutMessage you should do this yourself.

Returns
The font that is used for the name part of the message.

Definition at line 438 of file kchatbase.cpp.

◆ nextId()

int KChatBase::nextId ( ) const
Returns
An ID that has not yet been used in the combo box.
See also
addSendingEntry

Definition at line 330 of file kchatbase.cpp.

◆ readConfig()

void KChatBase::readConfig ( TDEConfig *  conf = 0)
virtual

Read the configuration from a TDEConfig object.

If the pointer is NULL kapp->config() is used and the group is changed to "KChatBase". The current TDEConfig::group is restored after this call.

Definition at line 488 of file kchatbase.cpp.

◆ removeSendingEntry()

void KChatBase::removeSendingEntry ( int  id)

Removes the entry with the ID id from the combo box.

Note that id is not the index of the entry!

See also
addSendingEntry
Parameters
idThe unique id of the entry

Definition at line 296 of file kchatbase.cpp.

◆ returnPressed()

virtual void KChatBase::returnPressed ( const TQString &  text)
protectedpure virtual

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
textThe message to be sent

Implemented in KGameChat, and KChat.

◆ rightButtonClicked

void KChatBase::rightButtonClicked ( TQListBoxItem *  ,
const TQPoint &   
)
signal

Emitted when the user right-clicks on a list item.

See also
TQListBox::rightButtonClicked

◆ saveConfig()

void KChatBase::saveConfig ( TDEConfig *  conf = 0)
virtual

Save the configuration of the dialog to a TDEConfig object.

If the supplied TDEConfig pointer is NULL then kapp->config() is used instead (and the group is changed to "KChatBase") butr the current group is restored at the end.

Parameters
confA pointer to the TDEConfig object to save the config to. If you use 0 then kapp->config() is used and the group is changed to "KChatBase" (the current group is restored at the end).

Definition at line 468 of file kchatbase.cpp.

◆ sendingEntry()

int KChatBase::sendingEntry ( ) const
Returns
The unique ID of the sending entry that has been selected.
See also
addSendingEntry

Note that the entry "send to all" always uses KChatBase::SendToAll, i.e. 0 as id!

Definition at line 282 of file kchatbase.cpp.

◆ setAcceptMessage

void KChatBase::setAcceptMessage ( bool  a)
slot
Parameters
aIf false this widget cannot send a message until setAcceptMessage(true) is called

Definition at line 247 of file kchatbase.cpp.

◆ setBothFont()

void KChatBase::setBothFont ( const TQFont &  font)

This sets both - nameFont and messageFont to font.

You probably want to use this if you don't wish to distinguish between these parts of a message.

Parameters
fontA font used for both nameFont and messageFont

Definition at line 432 of file kchatbase.cpp.

◆ setCompletionMode()

void KChatBase::setCompletionMode ( TDEGlobalSettings::Completion  mode)

See KLineEdit::setCompletionMode.

Definition at line 417 of file kchatbase.cpp.

◆ setMaxItems()

void KChatBase::setMaxItems ( int  maxItems)

Set the maximum number of items in the list.

If the number of item exceeds the maximum as many items are deleted (oldest first) as necessary. The number of items will never exceed this value.

Parameters
maxItemsthe maximum number of items. -1 (default) for unlimited.

Definition at line 513 of file kchatbase.cpp.

◆ setMessageFont()

void KChatBase::setMessageFont ( const TQFont &  font)

Set the font that used used for the message part of a message.

See also
messageFont, setBothFont

Definition at line 426 of file kchatbase.cpp.

◆ setNameFont()

void KChatBase::setNameFont ( const TQFont &  font)

Set the font that used used for the name part of a message.

See also nameFont and setBothFont

Definition at line 420 of file kchatbase.cpp.

◆ setSendingEntry()

void KChatBase::setSendingEntry ( int  id)

This selects a combo box entry.

Parameters
idThe ID of the item to be selected

Definition at line 316 of file kchatbase.cpp.

◆ setSystemBothFont()

void KChatBase::setSystemBothFont ( const TQFont &  font)

Same as setBothFont but applies only to system messages.

See also
layoutSystemMessage

Definition at line 456 of file kchatbase.cpp.

◆ setSystemMessageFont()

void KChatBase::setSystemMessageFont ( const TQFont &  font)

Same as setMessageFont but applies only to system messages.

See also
layoutSystemMessage

Definition at line 450 of file kchatbase.cpp.

◆ setSystemNameFont()

void KChatBase::setSystemNameFont ( const TQFont &  font)

Same as setNameFont but applies only to system messages.

See also
layoutSystemMessage

Definition at line 444 of file kchatbase.cpp.

◆ slotClear

void KChatBase::slotClear ( )
slot

This clears all messages in the view.

Note that only the messages are cleared, not the sender names in the combo box!

Definition at line 412 of file kchatbase.cpp.

◆ systemMessageFont()

const TQFont & KChatBase::systemMessageFont ( ) const

Same as systemMessageFont but applies only to system messages.

See also
layoutSystemMessage

Definition at line 465 of file kchatbase.cpp.

◆ systemNameFont()

const TQFont & KChatBase::systemNameFont ( ) const

Same as systemNameFont but applies only to system messages.

See also
layoutSystemMessage

Definition at line 462 of file kchatbase.cpp.


The documentation for this class was generated from the following files:
  • kchatbase.h
  • kchatbase.cpp

libtdegames

Skip menu "libtdegames"
  • Main Page
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

libtdegames

Skip menu "libtdegames"
  • libtdegames
Generated for libtdegames by doxygen 1.8.13
This website is maintained by Timothy Pearson.