KChatBase

Search for usage in LXR

#include <KChatBase>

Inheritance diagram for KChatBase:

Public Types

enum  SendingIds { SendToAll = 0 }
 
- Public Types inherited from QFrame
enum  Shadow
 
enum  Shape
 
enum  StyleMask
 
- Public Types inherited from QWidget
enum  RenderFlag
 
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric
 

Public Slots

virtual void addMessage (const QString &fromName, const QString &text)
 
virtual void addSystemMessage (const QString &fromName, const QString &text)
 
void setAcceptMessage (bool a)
 
void slotClear ()
 

Public Member Functions

 KChatBase (QWidget *parent, KChatBaseModel *model=nullptr, KChatBaseItemDelegate *delegate=nullptr, bool noComboBox=false)
 
 ~KChatBase () override
 
virtual bool acceptMessage () const
 
bool addSendingEntry (const QString &text, int id)
 
void changeSendingEntry (const QString &text, int id)
 
void clear ()
 
int findIndex (int id) const
 
virtual QString fromName () const =0
 
bool insertSendingEntry (const QString &text, int id, int index=-1)
 
int maxItems () const
 
QFont messageFont () const
 
KChatBaseModelmodel ()
 
QFont nameFont () const
 
int nextId () const
 
virtual void readConfig (KConfig *conf=nullptr)
 
void removeSendingEntry (int id)
 
virtual void saveConfig (KConfig *conf=nullptr)
 
int sendingEntry () const
 
void setBothFont (const QFont &font)
 
void setCompletionMode (KCompletion::CompletionMode mode)
 
void setMaxItems (int maxItems)
 
void setMessageFont (const QFont &font)
 
void setModel (KChatBaseModel *m)
 
void setNameFont (const QFont &font)
 
void setSendingEntry (int id)
 
void setSystemBothFont (const QFont &font)
 
void setSystemMessageFont (const QFont &font)
 
void setSystemNameFont (const QFont &font)
 
QFont systemMessageFont () const
 
QFont systemNameFont () const
 
- Public Member Functions inherited from QFrame
 QFrame (QWidget *parent, Qt::WindowFlags f)
 
QRect frameRect () const const
 
QFrame::Shadow frameShadow () const const
 
QFrame::Shape frameShape () const const
 
int frameStyle () const const
 
int frameWidth () const const
 
int lineWidth () const const
 
int midLineWidth () const const
 
void setFrameRect (const QRect &)
 
void setFrameShadow (QFrame::Shadow)
 
void setFrameShape (QFrame::Shape)
 
void setFrameStyle (int style)
 
void setLineWidth (int)
 
void setMidLineWidth (int)
 
virtual QSize sizeHint () const const override
 
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, Qt::WindowFlags f)
 
bool acceptDrops () const const
 
QString accessibleDescription () const const
 
QString accessibleName () const const
 
QList< QAction * > actions () const const
 
void activateWindow ()
 
void addAction (QAction *action)
 
void addActions (QList< QAction * > actions)
 
void adjustSize ()
 
bool autoFillBackground () const const
 
QPalette::ColorRole backgroundRole () const const
 
QBackingStorebackingStore () const const
 
QSize baseSize () const const
 
QWidgetchildAt (const QPoint &p) const const
 
QWidgetchildAt (int x, int y) const const
 
QRect childrenRect () const const
 
QRegion childrenRegion () const const
 
void clearFocus ()
 
void clearMask ()
 
bool close ()
 
QMargins contentsMargins () const const
 
QRect contentsRect () const const
 
Qt::ContextMenuPolicy contextMenuPolicy () const const
 
QCursor cursor () const const
 
void customContextMenuRequested (const QPoint &pos)
 
WId effectiveWinId () const const
 
void ensurePolished () const const
 
Qt::FocusPolicy focusPolicy () const const
 
QWidgetfocusProxy () const const
 
QWidgetfocusWidget () const const
 
const QFontfont () const const
 
QFontInfo fontInfo () const const
 
QFontMetrics fontMetrics () const const
 
QPalette::ColorRole foregroundRole () const const
 
QRect frameGeometry () const const
 
QSize frameSize () const const
 
const QRectgeometry () const const
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const const
 
QPixmap grab (const QRect &rectangle)
 
void grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
 
void grabKeyboard ()
 
void grabMouse ()
 
void grabMouse (const QCursor &cursor)
 
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
 
QGraphicsEffectgraphicsEffect () const const
 
QGraphicsProxyWidgetgraphicsProxyWidget () const const
 
bool hasEditFocus () const const
 
bool hasFocus () const const
 
virtual bool hasHeightForWidth () const const
 
bool hasMouseTracking () const const
 
bool hasTabletTracking () const const
 
int height () const const
 
virtual int heightForWidth (int w) const const
 
void hide ()
 
Qt::InputMethodHints inputMethodHints () const const
 
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const const
 
void insertAction (QAction *before, QAction *action)
 
void insertActions (QAction *before, QList< QAction * > actions)
 
bool isActiveWindow () const const
 
bool isAncestorOf (const QWidget *child) const const
 
bool isEnabled () const const
 
bool isEnabledTo (const QWidget *ancestor) const const
 
bool isEnabledToTLW () const const
 
bool isFullScreen () const const
 
bool isHidden () const const
 
bool isMaximized () const const
 
bool isMinimized () const const
 
bool isModal () const const
 
bool isTopLevel () const const
 
bool isVisible () const const
 
bool isVisibleTo (const QWidget *ancestor) const const
 
bool isWindow () const const
 
bool isWindowModified () const const
 
QLayoutlayout () const const
 
Qt::LayoutDirection layoutDirection () const const
 
QLocale locale () const const
 
void lower ()
 
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const const
 
QPoint mapFromGlobal (const QPoint &pos) const const
 
QPoint mapFromParent (const QPoint &pos) const const
 
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
 
QPoint mapToGlobal (const QPoint &pos) const const
 
QPoint mapToParent (const QPoint &pos) const const
 
QRegion mask () const const
 
int maximumHeight () const const
 
QSize maximumSize () const const
 
int maximumWidth () const const
 
int minimumHeight () const const
 
QSize minimumSize () const const
 
virtual QSize minimumSizeHint () const const
 
int minimumWidth () const const
 
void move (const QPoint &)
 
void move (int x, int y)
 
QWidgetnativeParentWidget () const const
 
QWidgetnextInFocusChain () const const
 
QRect normalGeometry () const const
 
void overrideWindowFlags (Qt::WindowFlags flags)
 
virtual QPaintEnginepaintEngine () const const override
 
const QPalettepalette () const const
 
QWidgetparentWidget () const const
 
QPoint pos () const const
 
QWidgetpreviousInFocusChain () const const
 
 QWIDGETSIZE_MAX QWIDGETSIZE_MAX
 
void raise ()
 
QRect rect () const const
 
void releaseKeyboard ()
 
void releaseMouse ()
 
void releaseShortcut (int id)
 
void removeAction (QAction *action)
 
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
 
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
 
void repaint ()
 
void repaint (const QRect &rect)
 
void repaint (const QRegion &rgn)
 
void repaint (int x, int y, int w, int h)
 
void resize (const QSize &)
 
void resize (int w, int h)
 
bool restoreGeometry (const QByteArray &geometry)
 
QByteArray saveGeometry () const const
 
QScreenscreen () const const
 
void scroll (int dx, int dy)
 
void scroll (int dx, int dy, const QRect &r)
 
void setAcceptDrops (bool on)
 
void setAccessibleDescription (const QString &description)
 
void setAccessibleName (const QString &name)
 
void setAttribute (Qt::WidgetAttribute attribute, bool on)
 
void setAutoFillBackground (bool enabled)
 
void setBackgroundRole (QPalette::ColorRole role)
 
void setBaseSize (const QSize &)
 
void setBaseSize (int basew, int baseh)
 
void setContentsMargins (const QMargins &margins)
 
void setContentsMargins (int left, int top, int right, int bottom)
 
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
 
void setCursor (const QCursor &)
 
void setDisabled (bool disable)
 
void setEditFocus (bool enable)
 
void setEnabled (bool)
 
void setFixedHeight (int h)
 
void setFixedSize (const QSize &s)
 
void setFixedSize (int w, int h)
 
void setFixedWidth (int w)
 
void setFocus ()
 
void setFocus (Qt::FocusReason reason)
 
void setFocusPolicy (Qt::FocusPolicy policy)
 
void setFocusProxy (QWidget *w)
 
void setFont (const QFont &)
 
void setForegroundRole (QPalette::ColorRole role)
 
void setGeometry (const QRect &)
 
void setGeometry (int x, int y, int w, int h)
 
void setGraphicsEffect (QGraphicsEffect *effect)
 
void setHidden (bool hidden)
 
void setInputMethodHints (Qt::InputMethodHints hints)
 
void setLayout (QLayout *layout)
 
void setLayoutDirection (Qt::LayoutDirection direction)
 
void setLocale (const QLocale &locale)
 
void setMask (const QBitmap &bitmap)
 
void setMask (const QRegion &region)
 
void setMaximumHeight (int maxh)
 
void setMaximumSize (const QSize &)
 
void setMaximumSize (int maxw, int maxh)
 
void setMaximumWidth (int maxw)
 
void setMinimumHeight (int minh)
 
void setMinimumSize (const QSize &)
 
void setMinimumSize (int minw, int minh)
 
void setMinimumWidth (int minw)
 
void setMouseTracking (bool enable)
 
void setPalette (const QPalette &)
 
void setParent (QWidget *parent)
 
void setParent (QWidget *parent, Qt::WindowFlags f)
 
void setShortcutAutoRepeat (int id, bool enable)
 
void setShortcutEnabled (int id, bool enable)
 
void setSizeIncrement (const QSize &)
 
void setSizeIncrement (int w, int h)
 
void setSizePolicy (QSizePolicy)
 
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
 
void setStatusTip (const QString &)
 
void setStyle (QStyle *style)
 
void setStyleSheet (const QString &styleSheet)
 
void setTabletTracking (bool enable)
 
void setToolTip (const QString &)
 
void setToolTipDuration (int msec)
 
void setUpdatesEnabled (bool enable)
 
void setupUi (QWidget *widget)
 
virtual void setVisible (bool visible)
 
void setWhatsThis (const QString &)
 
void setWindowFilePath (const QString &filePath)
 
void setWindowFlag (Qt::WindowType flag, bool on)
 
void setWindowFlags (Qt::WindowFlags type)
 
void setWindowIcon (const QIcon &icon)
 
void setWindowIconText (const QString &)
 
void setWindowModality (Qt::WindowModality windowModality)
 
void setWindowModified (bool)
 
void setWindowOpacity (qreal level)
 
void setWindowRole (const QString &role)
 
void setWindowState (Qt::WindowStates windowState)
 
void setWindowTitle (const QString &)
 
void show ()
 
void showFullScreen ()
 
void showMaximized ()
 
void showMinimized ()
 
void showNormal ()
 
QSize size () const const
 
QSize sizeIncrement () const const
 
QSizePolicy sizePolicy () const const
 
void stackUnder (QWidget *w)
 
QString statusTip () const const
 
QStylestyle () const const
 
QString styleSheet () const const
 
bool testAttribute (Qt::WidgetAttribute attribute) const const
 
QString toolTip () const const
 
int toolTipDuration () const const
 
QWidgettopLevelWidget () const const
 
bool underMouse () const const
 
void ungrabGesture (Qt::GestureType gesture)
 
void unsetCursor ()
 
void unsetLayoutDirection ()
 
void unsetLocale ()
 
void update ()
 
void update (const QRect &rect)
 
void update (const QRegion &rgn)
 
void update (int x, int y, int w, int h)
 
void updateGeometry ()
 
bool updatesEnabled () const const
 
QRegion visibleRegion () const const
 
QString whatsThis () const const
 
int width () const const
 
QWidgetwindow () const const
 
QString windowFilePath () const const
 
Qt::WindowFlags windowFlags () const const
 
QWindowwindowHandle () const const
 
QIcon windowIcon () const const
 
void windowIconChanged (const QIcon &icon)
 
QString windowIconText () const const
 
void windowIconTextChanged (const QString &iconText)
 
Qt::WindowModality windowModality () const const
 
qreal windowOpacity () const const
 
QString windowRole () const const
 
Qt::WindowStates windowState () const const
 
QString windowTitle () const const
 
void windowTitleChanged (const QString &title)
 
Qt::WindowType windowType () const const
 
WId winId () const const
 
int x () const const
 
int y () const const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, 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
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
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 setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
 
int depth () const const
 
int devicePixelRatio () const const
 
qreal devicePixelRatioF () const const
 
int height () const const
 
int heightMM () const const
 
int logicalDpiX () const const
 
int logicalDpiY () const const
 
bool paintingActive () const const
 
int physicalDpiX () const const
 
int physicalDpiY () const const
 
int width () const const
 
int widthMM () const const
 

Protected Member Functions

 KChatBase (KChatBasePrivate &dd, QWidget *parent, bool noComboBox)
 
virtual QString comboBoxItem (const QString &name) const
 
const QModelIndex indexAt (const QPoint &pos) const
 
virtual void returnPressed (const QString &text)=0
 
- Protected Member Functions inherited from QFrame
virtual void changeEvent (QEvent *ev) override
 
virtual bool event (QEvent *e) override
 
void initStyleOption (QStyleOptionFrame *option) const const
 
virtual void paintEvent (QPaintEvent *) override
 
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
 
virtual void closeEvent (QCloseEvent *event)
 
virtual void contextMenuEvent (QContextMenuEvent *event)
 
void create (WId window, bool initializeWindow, bool destroyOldWindow)
 
void destroy (bool destroyWindow, bool destroySubWindows)
 
virtual void dragEnterEvent (QDragEnterEvent *event)
 
virtual void dragLeaveEvent (QDragLeaveEvent *event)
 
virtual void dragMoveEvent (QDragMoveEvent *event)
 
virtual void dropEvent (QDropEvent *event)
 
virtual void enterEvent (QEvent *event)
 
virtual void focusInEvent (QFocusEvent *event)
 
bool focusNextChild ()
 
virtual bool focusNextPrevChild (bool next)
 
virtual void focusOutEvent (QFocusEvent *event)
 
bool focusPreviousChild ()
 
virtual void hideEvent (QHideEvent *event)
 
virtual void initPainter (QPainter *painter) const const override
 
virtual void inputMethodEvent (QInputMethodEvent *event)
 
virtual void keyPressEvent (QKeyEvent *event)
 
virtual void keyReleaseEvent (QKeyEvent *event)
 
virtual void leaveEvent (QEvent *event)
 
virtual int metric (QPaintDevice::PaintDeviceMetric m) const const override
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 
virtual void mouseMoveEvent (QMouseEvent *event)
 
virtual void mousePressEvent (QMouseEvent *event)
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 
virtual void moveEvent (QMoveEvent *event)
 
virtual bool nativeEvent (const QByteArray &eventType, void *message, long *result)
 
virtual void resizeEvent (QResizeEvent *event)
 
virtual void showEvent (QShowEvent *event)
 
virtual void tabletEvent (QTabletEvent *event)
 
void updateMicroFocus ()
 
virtual void wheelEvent (QWheelEvent *event)
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Properties inherited from QFrame
 frameRect
 
 frameShadow
 
 frameShape
 
 frameWidth
 
 lineWidth
 
 midLineWidth
 
- Properties inherited from QWidget
 acceptDrops
 
 accessibleDescription
 
 accessibleName
 
 autoFillBackground
 
 baseSize
 
 childrenRect
 
 childrenRegion
 
 contextMenuPolicy
 
 cursor
 
 enabled
 
 focus
 
 focusPolicy
 
 font
 
 frameGeometry
 
 frameSize
 
 fullScreen
 
 geometry
 
 height
 
 inputMethodHints
 
 isActiveWindow
 
 layoutDirection
 
 locale
 
 maximized
 
 maximumHeight
 
 maximumSize
 
 maximumWidth
 
 minimized
 
 minimumHeight
 
 minimumSize
 
 minimumSizeHint
 
 minimumWidth
 
 modal
 
 mouseTracking
 
 normalGeometry
 
 palette
 
 pos
 
 rect
 
 size
 
 sizeHint
 
 sizeIncrement
 
 sizePolicy
 
 statusTip
 
 styleSheet
 
 tabletTracking
 
 toolTip
 
 toolTipDuration
 
 updatesEnabled
 
 visible
 
 whatsThis
 
 width
 
 windowFilePath
 
 windowFlags
 
 windowIcon
 
 windowIconText
 
 windowModality
 
 windowModified
 
 windowOpacity
 
 windowTitle
 
 x
 
 y
 
- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
 
QWidgetfind (WId id)
 
QWidgetkeyboardGrabber ()
 
QWidgetmouseGrabber ()
 
void setTabOrder (QWidget *first, QWidget *second)
 
- 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)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QFrame
 Box
 
 HLine
 
 NoFrame
 
 Panel
 
 Plain
 
 Raised
 
 Shadow_Mask
 
 Shape_Mask
 
 StyledPanel
 
 Sunken
 
 VLine
 
 WinPanel
 
- Public Attributes inherited from QWidget
 DrawChildren
 
 DrawWindowBackground
 
 IgnoreMask
 
typedef RenderFlags
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Public Attributes inherited from QPaintDevice
 PdmDepth
 
 PdmDevicePixelRatio
 
 PdmDevicePixelRatioScaled
 
 PdmDpiX
 
 PdmDpiY
 
 PdmHeight
 
 PdmHeightMM
 
 PdmNumColors
 
 PdmPhysicalDpiX
 
 PdmPhysicalDpiY
 
 PdmWidth
 
 PdmWidthMM
 

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 dependent

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 KCompletion 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 KhatBase 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.

You probably don't want to use the abstract class KChatBase directly but use one of the derived classes 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. If you want to change the kind of elements displayed (using pixmaps for example), then you will also have to derive the KChatBaseModel and KChatBaseItemDelegate classes.

Author
Andreas Beckermann b_man[email protected][email protected][email protected]x.de
Gael de Chalendar (aka Kleag) kleag[email protected]@fre[email protected]e.fr for the port to Model/View

Definition at line 67 of file kchatbase.h.

Constructor & Destructor Documentation

◆ KChatBase()

KChatBase::KChatBase ( QWidget parent,
KChatBaseModel model = nullptr,
KChatBaseItemDelegate delegate = nullptr,
bool  noComboBox = false 
)
explicit
Parameters
parentThe parent widget for this widget.
model
delegate
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 56 of file kchatbase.cpp.

◆ ~KChatBase()

KChatBase::~KChatBase ( )
override

Destruct the KChatBase object.

Also calls saveConfig

Definition at line 119 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 125 of file kchatbase.cpp.

◆ addMessage

void KChatBase::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
fromNameThe player who sent this message
textThe text to be added

Definition at line 396 of file kchatbase.cpp.

◆ addSendingEntry()

bool KChatBase::addSendingEntry ( const QString 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 insertSendingEntry 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 139 of file kchatbase.cpp.

◆ addSystemMessage

void KChatBase::addSystemMessage ( const QString fromName,
const QString 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 403 of file kchatbase.cpp.

◆ changeSendingEntry()

void KChatBase::changeSendingEntry ( const QString 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 204 of file kchatbase.cpp.

◆ clear()

void KChatBase::clear ( )

Clear all messages in the list.

Definition at line 297 of file kchatbase.cpp.

◆ comboBoxItem()

QString KChatBase::comboBoxItem ( const QString name) const
protectedvirtual

Replace to customize 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 260 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 227 of file kchatbase.cpp.

◆ fromName()

virtual QString 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.

◆ indexAt()

const QModelIndex KChatBase::indexAt ( const QPoint pos) const
protected

Returns the model index of the message at the viewport coordinates point.

Parameters
posposition to check index for
Returns
model index of message with coordinates pos

Definition at line 107 of file kchatbase.cpp.

◆ insertSendingEntry()

bool KChatBase::insertSendingEntry ( const QString 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 148 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 319 of file kchatbase.cpp.

◆ messageFont()

QFont KChatBase::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 333 of file kchatbase.cpp.

◆ nameFont()

QFont 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 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 326 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 234 of file kchatbase.cpp.

◆ readConfig()

void KChatBase::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 287 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 189 of file kchatbase.cpp.

◆ returnPressed()

virtual void KChatBase::returnPressed ( const QString 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 KCompletion object of the KLineEdit widget!

Must be implemented in derived classes

Parameters
textThe message to be sent

Implemented in KGameChat.

◆ saveConfig()

void KChatBase::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
confA 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 277 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 173 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 132 of file kchatbase.cpp.

◆ setBothFont()

void KChatBase::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
fontA font used for both nameFont and messageFont

Definition at line 368 of file kchatbase.cpp.

◆ setCompletionMode()

void KChatBase::setCompletionMode ( KCompletion::CompletionMode  mode)

See KLineEdit::setCompletionMode.

Definition at line 270 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 304 of file kchatbase.cpp.

◆ setMessageFont()

void KChatBase::setMessageFont ( const QFont font)

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

See also
messageFont, setBothFont

Definition at line 361 of file kchatbase.cpp.

◆ setNameFont()

void KChatBase::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 354 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 216 of file kchatbase.cpp.

◆ setSystemBothFont()

void KChatBase::setSystemBothFont ( const QFont font)

Same as setBothFont but applies only to system messages.

See also
layoutSystemMessage

Definition at line 389 of file kchatbase.cpp.

◆ setSystemMessageFont()

void KChatBase::setSystemMessageFont ( const QFont font)

Same as setMessageFont but applies only to system messages.

See also
layoutSystemMessage

Definition at line 382 of file kchatbase.cpp.

◆ setSystemNameFont()

void KChatBase::setSystemNameFont ( const QFont font)

Same as setNameFont but applies only to system messages.

See also
layoutSystemMessage

Definition at line 375 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 265 of file kchatbase.cpp.

◆ systemMessageFont()

QFont KChatBase::systemMessageFont ( ) const

Same as systemMessageFont but applies only to system messages.

See also
layoutSystemMessage

Definition at line 347 of file kchatbase.cpp.

◆ systemNameFont()

QFont KChatBase::systemNameFont ( ) const

Same as systemNameFont but applies only to system messages.

See also
layoutSystemMessage

Definition at line 340 of file kchatbase.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sun Dec 4 2022 03:50:22 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.