KGameChat
#include <KGame/KGameChat>
Public Types | |
enum | SendingIds { SendToGroup = 1 } |
Public Types inherited from KChatBase | |
enum | SendingIds { SendToAll = 0 } |
Public Types inherited from QFrame | |
enum | Shadow |
enum | Shape |
enum | StyleMask |
Public Types inherited from QWidget | |
enum | RenderFlag |
typedef | RenderFlags |
Public Types inherited from QObject | |
typedef | QObjectList |
Public Types inherited from QPaintDevice | |
enum | PaintDeviceMetric |
Public Slots | |
void | addMessage (const QString &fromName, const QString &text) override |
virtual void | addMessage (int fromId, const QString &text) |
void | slotReceiveMessage (int, const QByteArray &, quint32 receiver, quint32 sender) |
Public Slots inherited from KChatBase | |
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 | |
KGameChat (KGame *game, int msgid, KPlayer *fromPlayer, QWidget *parent, KChatBaseModel *model=nullptr, KChatBaseItemDelegate *delegate=nullptr) | |
KGameChat (KGame *game, int msgId, QWidget *parent, KChatBaseModel *model=nullptr, KChatBaseItemDelegate *delegate=nullptr) | |
KGameChat (QWidget *parent) | |
QString | fromName () const override |
KPlayer * | fromPlayer () const |
KGame * | game () const |
int | messageId () const |
void | setFromPlayer (KPlayer *player) |
void | setKGame (KGame *g) |
void | setMessageId (int msgid) |
Public Member Functions inherited from KChatBase | |
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 |
bool | insertSendingEntry (const QString &text, int id, int index=-1) |
int | maxItems () const |
QFont | messageFont () const |
KChatBaseModel * | model () |
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 |
Shadow | frameShadow () const const |
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 (Shadow) |
void | setFrameShape (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 () |
QAction * | addAction (const QIcon &icon, const QString &text) |
QAction * | addAction (const QIcon &icon, const QString &text, Args &&... args) |
QAction * | addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut) |
QAction * | addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, Args &&... args) |
QAction * | addAction (const QIcon &icon, const QString &text, const QKeySequence &shortcut, const QObject *receiver, const char *member, Qt::ConnectionType type) |
QAction * | addAction (const QIcon &icon, const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type) |
QAction * | addAction (const QString &text) |
QAction * | addAction (const QString &text, Args &&... args) |
QAction * | addAction (const QString &text, const QKeySequence &shortcut) |
QAction * | addAction (const QString &text, const QKeySequence &shortcut, Args &&... args) |
QAction * | addAction (const QString &text, const QKeySequence &shortcut, const QObject *receiver, const char *member, Qt::ConnectionType type) |
QAction * | addAction (const QString &text, const QObject *receiver, const char *member, Qt::ConnectionType type) |
void | addAction (QAction *action) |
void | addActions (const QList< QAction * > &actions) |
void | adjustSize () |
bool | autoFillBackground () const const |
QPalette::ColorRole | backgroundRole () const const |
QBackingStore * | backingStore () const const |
QSize | baseSize () const const |
QWidget * | childAt (const QPoint &p) const const |
QWidget * | childAt (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 |
QWidget * | focusProxy () const const |
QWidget * | focusWidget () const const |
const QFont & | font () const const |
QFontInfo | fontInfo () const const |
QFontMetrics | fontMetrics () const const |
QPalette::ColorRole | foregroundRole () const const |
QRect | frameGeometry () const const |
QSize | frameSize () const const |
const QRect & | geometry () 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) |
QGraphicsEffect * | graphicsEffect () const const |
QGraphicsProxyWidget * | graphicsProxyWidget () 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, const 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 | 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 |
QLayout * | layout () const const |
Qt::LayoutDirection | layoutDirection () const const |
QLocale | locale () const const |
void | lower () |
QPoint | mapFrom (const QWidget *parent, const QPoint &pos) const const |
QPointF | mapFrom (const QWidget *parent, const QPointF &pos) const const |
QPoint | mapFromGlobal (const QPoint &pos) const const |
QPointF | mapFromGlobal (const QPointF &pos) const const |
QPoint | mapFromParent (const QPoint &pos) const const |
QPointF | mapFromParent (const QPointF &pos) const const |
QPoint | mapTo (const QWidget *parent, const QPoint &pos) const const |
QPointF | mapTo (const QWidget *parent, const QPointF &pos) const const |
QPoint | mapToGlobal (const QPoint &pos) const const |
QPointF | mapToGlobal (const QPointF &pos) const const |
QPoint | mapToParent (const QPoint &pos) const const |
QPointF | mapToParent (const QPointF &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) |
QWidget * | nativeParentWidget () const const |
QWidget * | nextInFocusChain () const const |
QRect | normalGeometry () const const |
void | overrideWindowFlags (Qt::WindowFlags flags) |
virtual QPaintEngine * | paintEngine () const const override |
const QPalette & | palette () const const |
QWidget * | parentWidget () const const |
QPoint | pos () const const |
QWidget * | previousInFocusChain () 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, RenderFlags renderFlags) |
void | render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, 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 |
QScreen * | screen () 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 ®ion) |
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 | setScreen (QScreen *screen) |
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 |
QStyle * | style () const const |
QString | styleSheet () const const |
bool | testAttribute (Qt::WidgetAttribute attribute) const const |
QString | toolTip () const const |
int | toolTipDuration () const const |
QWidget * | topLevelWidget () 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 |
QWidget * | window () const const |
QString | windowFilePath () const const |
Qt::WindowFlags | windowFlags () const const |
QWindow * | windowHandle () 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) | |
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 | 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 |
Public Member Functions inherited from QPaintDevice | |
int | colorCount () const const |
int | depth () const const |
qreal | 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 Slots | |
void | slotAddPlayer (KPlayer *) |
void | slotPropertyChanged (KGamePropertyBase *, KPlayer *) |
void | slotReceivePrivateMessage (int msgid, const QByteArray &buffer, quint32 sender, KPlayer *me) |
void | slotRemovePlayer (KPlayer *) |
void | slotUnsetKGame () |
Protected Member Functions | |
bool | hasPlayer (int id) const |
bool | isSendToAllMessage (int id) const |
bool | isToGroupMessage (int id) const |
bool | isToPlayerMessage (int id) const |
int | playerId (int id) const |
void | returnPressed (const QString &text) override |
int | sendingId (int playerId) const |
virtual QString | sendToPlayerEntry (const QString &name) const |
Protected Member Functions inherited from KChatBase | |
KChatBase (KChatBasePrivate &dd, QWidget *parent, bool noComboBox) | |
virtual QString | comboBoxItem (const QString &name) const |
QModelIndex | indexAt (QPoint pos) const |
Protected Member Functions inherited from QFrame | |
virtual void | changeEvent (QEvent *ev) override |
virtual bool | event (QEvent *e) override |
virtual 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 (QEnterEvent *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 (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, qintptr *result) |
virtual void | resizeEvent (QResizeEvent *event) |
virtual void | showEvent (QShowEvent *event) |
virtual void | tabletEvent (QTabletEvent *event) |
void | updateMicroFocus (Qt::InputMethodQuery query) |
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 |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Protected Member Functions inherited from QPaintDevice |
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 35 of file kgamechat.h.
Member Enumeration Documentation
◆ SendingIds
enum KGameChat::SendingIds |
Definition at line 63 of file kgamechat.h.
Constructor & Destructor Documentation
◆ KGameChat() [1/3]
KGameChat::KGameChat | ( | KGame * | game, |
int | msgid, | ||
KPlayer * | fromPlayer, | ||
QWidget * | parent, | ||
KChatBaseModel * | model = nullptr, | ||
KChatBaseItemDelegate * | delegate = nullptr ) |
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 49 of file kgamechat.cpp.
◆ KGameChat() [2/3]
KGameChat::KGameChat | ( | KGame * | game, |
int | msgId, | ||
QWidget * | parent, | ||
KChatBaseModel * | model = nullptr, | ||
KChatBaseItemDelegate * | delegate = nullptr ) |
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 43 of file kgamechat.cpp.
◆ KGameChat() [3/3]
|
explicit |
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.
Definition at line 56 of file kgamechat.cpp.
◆ ~KGameChat()
|
override |
Definition at line 62 of file kgamechat.cpp.
Member Function Documentation
◆ addMessage [1/2]
Definition at line 111 of file kgamechat.h.
◆ addMessage [2/2]
|
virtualslot |
Definition at line 75 of file kgamechat.cpp.
◆ fromName()
|
overridevirtual |
reimplemented from KChatBase
- Returns
- KPlayer::name() for the player set by setFromPlayer
Implements KChatBase.
Definition at line 201 of file kgamechat.cpp.
◆ fromPlayer()
KPlayer * KGameChat::fromPlayer | ( | ) | const |
Definition at line 267 of file kgamechat.cpp.
◆ game()
KGame * KGameChat::game | ( | ) | const |
Definition at line 260 of file kgamechat.cpp.
◆ hasPlayer()
|
protected |
- Returns
- True if the player with this ID was added before (see slotAddPlayer)
Definition at line 208 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 153 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 158 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 165 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 146 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 KChatBase sendingEntry and the id this method returns is a KPlayer ID. If isToPlayerMessage returns false this method returns -1
Definition at line 177 of file kgamechat.cpp.
◆ returnPressed()
|
overrideprotectedvirtual |
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
-
text The message to be sent
Implements KChatBase.
Definition at line 94 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 188 of file kgamechat.cpp.
◆ sendToPlayerEntry()
- 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 172 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 213 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 237 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 Qt designer) it may be useful to change the message id.
See also messageId
Definition at line 139 of file kgamechat.cpp.
◆ slotAddPlayer
|
protectedslot |
Definition at line 290 of file kgamechat.cpp.
◆ slotPropertyChanged
|
protectedslot |
Definition at line 329 of file kgamechat.cpp.
◆ slotReceiveMessage
|
slot |
Definition at line 351 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 342 of file kgamechat.cpp.
◆ slotRemovePlayer
|
protectedslot |
Definition at line 310 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 274 of file kgamechat.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 20 2024 11:50:50 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.