KChatBaseModel Class Reference

#include <KChatBaseModel>

Inheritance diagram for KChatBaseModel:

Public Slots
virtual void	addMessage (const QString &fromName, const QString &text)
virtual void	addSystemMessage (const QString &fromName, const QString &text)
void	slotClear ()

Public Member Functions
	KChatBaseModel (QObject *parent=nullptr)
	~KChatBaseModel () override
void	clear ()
QVariant	data (const QModelIndex &index, int role) const override
int	maxItems () const
const QFont &	messageFont () const
const QFont &	nameFont () const
virtual void	readConfig (KConfig *conf=nullptr)
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
virtual void	saveConfig (KConfig *conf=nullptr)
void	setBothFont (const QFont &font)
void	setMaxItems (int maxItems)
void	setMessageFont (const QFont &font)
void	setNameFont (const QFont &font)
void	setSystemBothFont (const QFont &font)
void	setSystemMessageFont (const QFont &font)
void	setSystemNameFont (const QFont &font)
const QFont &	systemMessageFont () const
const QFont &	systemNameFont () const
Public Member Functions inherited from QAbstractListModel
	QAbstractListModel (QObject *parent)
virtual bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
virtual Qt::ItemFlags	flags (const QModelIndex &index) const const override
virtual QModelIndex	index (int row, int column, const QModelIndex &parent) const const override
virtual QModelIndex	sibling (int row, int column, const QModelIndex &idx) const const override
Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent)
virtual QModelIndex	buddy (const QModelIndex &index) const const
virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const
virtual bool	canFetchMore (const QModelIndex &parent) const const
bool	checkIndex (const QModelIndex &index, CheckIndexOptions options) const const
virtual bool	clearItemData (const QModelIndex &index)
virtual int	columnCount (const QModelIndex &parent) const const=0
void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)
void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)
void	columnsInserted (const QModelIndex &parent, int first, int last)
void	columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
void	columnsRemoved (const QModelIndex &parent, int first, int last)
void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles)
virtual void	fetchMore (const QModelIndex &parent)
virtual bool	hasChildren (const QModelIndex &parent) const const
bool	hasIndex (int row, int column, const QModelIndex &parent) const const
virtual QVariant	headerData (int section, Qt::Orientation orientation, int role) const const
void	headerDataChanged (Qt::Orientation orientation, int first, int last)
bool	insertColumn (int column, const QModelIndex &parent)
virtual bool	insertColumns (int column, int count, const QModelIndex &parent)
bool	insertRow (int row, const QModelIndex &parent)
virtual bool	insertRows (int row, int count, const QModelIndex &parent)
virtual QMap< int, QVariant >	itemData (const QModelIndex &index) const const
void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)
void	layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)
virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const
virtual QMimeData *	mimeData (const QModelIndexList &indexes) const const
virtual QStringList	mimeTypes () const const
void	modelAboutToBeReset ()
void	modelReset ()
bool	moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)
virtual bool	moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)
bool	moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)
virtual bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)
virtual void	multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const const
virtual QModelIndex	parent (const QModelIndex &index) const const=0
bool	removeColumn (int column, const QModelIndex &parent)
virtual bool	removeColumns (int column, int count, const QModelIndex &parent)
bool	removeRow (int row, const QModelIndex &parent)
virtual bool	removeRows (int row, int count, const QModelIndex &parent)
virtual void	revert ()
virtual QHash< int, QByteArray >	roleNames () const const
void	rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)
void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)
void	rowsInserted (const QModelIndex &parent, int first, int last)
void	rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
void	rowsRemoved (const QModelIndex &parent, int first, int last)
virtual bool	setData (const QModelIndex &index, const QVariant &value, int role)
virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role)
virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
virtual void	sort (int column, Qt::SortOrder order)
virtual QSize	span (const QModelIndex &index) const const
virtual bool	submit ()
virtual Qt::DropActions	supportedDragActions () const const
virtual Qt::DropActions	supportedDropActions () const const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Public Types inherited from QAbstractItemModel
enum	CheckIndexOption
typedef	CheckIndexOptions
enum	LayoutChangeHint
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QAbstractItemModel
	DoNotUseParent
	HorizontalSortHint
	IndexIsValid
	NoLayoutChangeHint
	NoOption
	ParentIsInvalid
	VerticalSortHint
Protected Member Functions inherited from QAbstractItemModel
void	beginInsertColumns (const QModelIndex &parent, int first, int last)
void	beginInsertRows (const QModelIndex &parent, int first, int last)
bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
void	beginRemoveColumns (const QModelIndex &parent, int first, int last)
void	beginRemoveRows (const QModelIndex &parent, int first, int last)
void	beginResetModel ()
void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)
QModelIndex	createIndex (int row, int column, const void *ptr) const const
QModelIndex	createIndex (int row, int column, quintptr id) const const
void	endInsertColumns ()
void	endInsertRows ()
void	endMoveColumns ()
void	endMoveRows ()
void	endRemoveColumns ()
void	endRemoveRows ()
void	endResetModel ()
QModelIndexList	persistentIndexList () const const
virtual void	resetInternalData ()
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

The model used to store messages displayed in the chat dialog messages list.

This is a list model and thus derived from QAbstractListModel and implementing its abstract API.

Definition at line 69 of file kchatbasemodel.h.

Constructor & Destructor Documentation

KChatBaseModel()

KChatBaseModel::KChatBaseModel ( QObject * parent = nullptr )

explicit

Default constructor.

Definition at line 67 of file kchatbasemodel.cpp.

~KChatBaseModel()

KChatBaseModel::~KChatBaseModel ( )

override

Default destructor.

Definition at line 73 of file kchatbasemodel.cpp.

Member Function Documentation

addMessage

void KChatBaseModel::addMessage ( const QString & fromName, const QString & 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

fromName	The player who sent this message
text	The text to be added

Definition at line 207 of file kchatbasemodel.cpp.

addSystemMessage

void KChatBaseModel::addSystemMessage ( const QString & fromName, const QString & text )

virtualslot

This works just like addMessage but adds a system message.

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 222 of file kchatbasemodel.cpp.

clear()

void KChatBaseModel::clear

(

)

Clear all messages in the list.

Definition at line 164 of file kchatbasemodel.cpp.

data()

QVariant KChatBaseModel::data ( const QModelIndex & index, int role ) const

overridevirtual

Reimplementation of the inherited method.

Returns

The KChatBaseMessage at the given index as a QVariant

Implements QAbstractItemModel.

Definition at line 187 of file kchatbasemodel.cpp.

maxItems()

int KChatBaseModel::maxItems

(

)

const

Returns

The maximum number of messages in the list. -1 is unlimited. See also setMaxItems

Definition at line 182 of file kchatbasemodel.cpp.

messageFont()

const QFont & KChatBaseModel::messageFont

(

)

const

This font should be used for a message.

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

Returns

The font that is used for a message

Definition at line 105 of file kchatbasemodel.cpp.

nameFont()

const QFont & KChatBaseModel::nameFont

(

)

const

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

layoutMessage uses this to set the font using KChatBaseItemDelegate::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 100 of file kchatbasemodel.cpp.

readConfig()

void KChatBaseModel::readConfig ( KConfig * conf = nullptr )

virtual

Read the configuration from a KConfig object.

If the pointer is NULL KGlobal::config() is used and the group is changed to "KChatBase". The current KConfig::group is restored after this call.

Definition at line 150 of file kchatbasemodel.cpp.

rowCount()

int KChatBaseModel::rowCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

Reimplementation of the inherited method.

Returns

The current number of messages in the list

Implements QAbstractItemModel.

Definition at line 199 of file kchatbasemodel.cpp.

saveConfig()

void KChatBaseModel::saveConfig ( KConfig * conf = nullptr )

virtual

Save the configuration of the dialog to a KConfig object.

If the supplied KConfig pointer is NULL then KGlobal::config() is used instead (and the group is changed to "KChatBase") butr the current group is restored at the end.

Parameters

conf	A pointer to the KConfig object to save the config to. If you use 0 then KGlobal::config() is used and the group is changed to "KChatBase" (the current group is restored at the end).

Definition at line 136 of file kchatbasemodel.cpp.

setBothFont()

void KChatBaseModel::setBothFont

(

const QFont &

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

font	A font used for both nameFont and messageFont

Definition at line 94 of file kchatbasemodel.cpp.

setMaxItems()

void KChatBaseModel::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

maxItems

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

Definition at line 169 of file kchatbasemodel.cpp.

setMessageFont()

void KChatBaseModel::setMessageFont

(

const QFont &

font

)

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

See also

messageFont, setBothFont

Definition at line 89 of file kchatbasemodel.cpp.

setNameFont()

void KChatBaseModel::setNameFont

(

const QFont &

font

)

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

See also nameFont and setBothFont

Definition at line 84 of file kchatbasemodel.cpp.

setSystemBothFont()

void KChatBaseModel::setSystemBothFont

(

const QFont &

font

)

Same as setBothFont but applies only to system messages.

Definition at line 120 of file kchatbasemodel.cpp.

setSystemMessageFont()

void KChatBaseModel::setSystemMessageFont

(

const QFont &

font

)

Same as setMessageFont but applies only to system messages.

Definition at line 115 of file kchatbasemodel.cpp.

setSystemNameFont()

void KChatBaseModel::setSystemNameFont

(

const QFont &

font

)

Same as setNameFont but applies only to system messages.

Definition at line 110 of file kchatbasemodel.cpp.

slotClear

void KChatBaseModel::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 79 of file kchatbasemodel.cpp.

systemMessageFont()

const QFont & KChatBaseModel::systemMessageFont

(

)

const

Same as systemMessageFont but applies only to system messages.

Definition at line 131 of file kchatbasemodel.cpp.

systemNameFont()

const QFont & KChatBaseModel::systemNameFont

(

)

const

Same as systemNameFont but applies only to system messages.

Definition at line 126 of file kchatbasemodel.cpp.

---

The documentation for this class was generated from the following files:

• kchatbasemodel.h
• kchatbasemodel.cpp