kopete/libkopete
#include <kopeteblacklister.h>
Public Slots | |
void | addContact (const QString &contactId) |
void | addContact (Contact *contact) |
void | removeContact (Contact *contact) |
void | removeContact (const QString &contactId) |
Signals | |
void | contactAdded (const QString &contactId) |
void | contactRemoved (const QString &contactId) |
Public Member Functions | |
BlackLister (const QString &protocolId, const QString &accountId, QObject *parent=0) | |
~BlackLister () | |
bool | isBlocked (Contact *contact) |
bool | isBlocked (const QString &contactId) |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QObject (QObject *parent, const char *name) | |
virtual | ~QObject () |
bool | blockSignals (bool block) |
QObject * | child (const char *objName, const char *inheritsClass, bool recursiveSearch) const |
const QObjectList & | children () const |
const char * | className () const |
bool | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const QObject *receiver, const char *method) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) |
void | dumpObjectInfo () |
void | dumpObjectTree () |
QList< QByteArray > | dynamicPropertyNames () const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name) const |
QList< T > | findChildren (const QRegExp ®Exp) const |
QList< T > | findChildren (const QString &name) const |
bool | inherits (const char *className) const |
void | insertChild (QObject *object) |
void | installEventFilter (QObject *filterObj) |
bool | isA (const char *className) const |
bool | isWidgetType () const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const |
void | moveToThread (QThread *targetThread) |
const char * | name () const |
const char * | name (const char *defaultName) const |
QString | objectName () const |
QObject * | parent () const |
QVariant | property (const char *name) const |
void | removeChild (QObject *object) |
void | removeEventFilter (QObject *obj) |
void | setName (const char *name) |
void | setObjectName (const QString &name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const |
int | startTimer (int interval) |
QThread * | thread () const |
Additional Inherited Members | |
Static Public Member Functions inherited from QObject | |
bool | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
bool | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
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) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
Protected Member Functions inherited from QObject | |
bool | checkConnectArgs (const char *signal, const QObject *object, const char *method) |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const char *signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const char *signal) |
int | receivers (const char *signal) const |
QObject * | sender () const |
int | senderSignalIndex () const |
virtual void | timerEvent (QTimerEvent *event) |
Static Protected Member Functions inherited from QObject | |
QByteArray | normalizeSignalSlot (const char *signalSlot) |
Properties inherited from QObject | |
objectName | |
Detailed Description
Manages the list of blacklisted contacts for an account.
This class manages the list of contacts the user wishes to ignore permanently. In order to use the this class, there is no need to create an instance. Use the Kopete::Account::blackLister() instead.
Keep in mind that this class does not discard messages from blocked users - It only manages the list. It is the up to the protocol to check whether a user is blocked, and act accordingly. A protocol may re-implement Kopete::Account::block() and Kopete::Account::unblock() and use Kopete::Account::blackLister() as a persistent list manager only, or connect the signals contactAdded() and contactRemoved() to its slots.
Definition at line 45 of file kopeteblacklister.h.
Constructor & Destructor Documentation
Kopete::BlackLister::BlackLister | ( | const QString & | protocolId, |
const QString & | accountId, | ||
QObject * | parent = 0 |
||
) |
Create an instance, and read the blacklist from disk if it exists.
- Parameters
-
protocolId is the ID of the protocol owning accountId accountId is the ID of the owning Account. parent The QObject parent for this class. name The QObject name for this class.
Definition at line 38 of file kopeteblacklister.cpp.
Kopete::BlackLister::~BlackLister | ( | ) |
Definition at line 48 of file kopeteblacklister.cpp.
Member Function Documentation
|
slot |
Add a contact to the blacklist.
This function emits the contactAdded() signal.
- Parameters
-
contactId is the ID of the contact to be added to the list.
Definition at line 64 of file kopeteblacklister.cpp.
|
slot |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 74 of file kopeteblacklister.cpp.
|
signal |
A new contact has been added to the list.
Connect to this signal if you want to perform additional actions, and you prefer not to derive from this class.
|
signal |
A contact has been removed from the list.
Connect to this signal if you want to perform additional actions, and you prefer not to derive from this class.
bool Kopete::BlackLister::isBlocked | ( | Contact * | contact | ) |
- Returns
true
ifcontact
is blocked,false
otherwise.
Definition at line 59 of file kopeteblacklister.cpp.
bool Kopete::BlackLister::isBlocked | ( | const QString & | contactId | ) |
- Returns
true
if the contact with IDcontactId
is blocked,false
otherwise.
Definition at line 54 of file kopeteblacklister.cpp.
|
slot |
Remove a contact from the blacklist.
Removes the contact from the blacklist. This function emits the contactRemoved() signal.
- Parameters
-
contact is the contact to be removed from the list.
Definition at line 81 of file kopeteblacklister.cpp.
|
slot |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 95 of file kopeteblacklister.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:29:20 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.