You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
126 lines
3.6 KiB
126 lines
3.6 KiB
/*
|
|
kopeteblacklister.h - Kopete BlackLister
|
|
|
|
Copyright (c) 2004 by Roie Kerstein <sf_kersteinroie@bezeqint.net>
|
|
|
|
*************************************************************************
|
|
* *
|
|
* This library is free software; you can redistribute it and/or *
|
|
* modify it under the terms of the GNU Lesser General Public *
|
|
* License as published by the Free Software Foundation; either *
|
|
* version 2 of the License, or (at your option) any later version. *
|
|
* *
|
|
*************************************************************************
|
|
*/
|
|
|
|
#ifndef KOPETEBLACKLISTER_H
|
|
#define KOPETEBLACKLISTER_H
|
|
|
|
#include <tqobject.h>
|
|
|
|
namespace Kopete
|
|
{
|
|
|
|
class Contact;
|
|
|
|
/**
|
|
* @brief 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 @ref 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 @ref Kopete::Account::block() and @ref Kopete::Account::unblock()
|
|
* and use @ref Kopete::Account::blackLister() as a persistent list manager
|
|
* only, or connect the signals @ref contactAdded() and @ref contactRemoved()
|
|
* to its slots.
|
|
*
|
|
* @sa Kopete::Account::block() Kopete::Account::unblock()
|
|
*
|
|
* @author Roie Kerstein <sf_kersteinroie@bezeqint.net>
|
|
*/
|
|
class BlackLister : public TQObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
|
|
public:
|
|
/**
|
|
* Create an instance, and read the blacklist from disk if it exists.
|
|
* @param protocolId is the ID of the protocol owning accountId
|
|
* @param accountId is the ID of the owning Account.
|
|
* @param parent The TQObject parent for this class.
|
|
* @param name The TQObject name for this class.
|
|
*/
|
|
BlackLister( const TQString &protocolId, const TQString &accountId, TQObject *parent = 0, const char *name = 0 );
|
|
~BlackLister();
|
|
|
|
/**
|
|
* \return @c true if @p contact is blocked, @c false otherwise.
|
|
*/
|
|
bool isBlocked( Contact *contact );
|
|
|
|
/**
|
|
* \return @c true if the contact with ID @p contactId is blocked, @c false otherwise.
|
|
*/
|
|
bool isBlocked( const TQString &contactId );
|
|
|
|
public slots:
|
|
/**
|
|
* Add a contact to the blacklist.
|
|
*
|
|
* This function emits the @ref contactAdded() signal.
|
|
* @param contactId is the ID of the contact to be added to the list.
|
|
*/
|
|
void addContact( const TQString &contactId );
|
|
|
|
/**
|
|
* @overload
|
|
*/
|
|
void addContact( Contact *contact );
|
|
|
|
/**
|
|
* \brief Remove a contact from the blacklist.
|
|
*
|
|
* Removes the contact from the blacklist.
|
|
* This function emits the @ref contactRemoved() signal.
|
|
* @param contact is the contact to be removed from the list.
|
|
*/
|
|
void removeContact( Contact *contact );
|
|
|
|
/**
|
|
* @overload
|
|
*/
|
|
void removeContact( const TQString &contactId );
|
|
|
|
signals:
|
|
/**
|
|
* \brief 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.
|
|
*/
|
|
void contactAdded( const TQString &contactId );
|
|
|
|
/**
|
|
* \brief 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.
|
|
*/
|
|
void contactRemoved( const TQString &contactId );
|
|
|
|
private:
|
|
void saveToDisk();
|
|
|
|
class Private;
|
|
Private *d;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|