• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdenetwork API Reference
  • KDE Home
  • Contact Us
 

kopete/libkopete

  • Kopete
  • BlackLister
Public Slots | Signals | Public Member Functions | List of all members
Kopete::BlackLister Class Reference

#include <kopeteblacklister.h>

Inheritance diagram for Kopete::BlackLister:
Inheritance graph
[legend]

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)
 

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.

See also
Kopete::Account::block() Kopete::Account::unblock()
Author
Roie Kerstein sf_ke.nosp@m.rste.nosp@m.inroi.nosp@m.e@be.nosp@m.zeqin.nosp@m.t.ne.nosp@m.t

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
protocolIdis the ID of the protocol owning accountId
accountIdis the ID of the owning Account.
parentThe QObject parent for this class.
nameThe 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

void Kopete::BlackLister::addContact ( const QString &  contactId)
slot

Add a contact to the blacklist.

This function emits the contactAdded() signal.

Parameters
contactIdis the ID of the contact to be added to the list.

Definition at line 64 of file kopeteblacklister.cpp.

void Kopete::BlackLister::addContact ( Contact *  contact)
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.

void Kopete::BlackLister::contactAdded ( const QString &  contactId)
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.

void Kopete::BlackLister::contactRemoved ( const QString &  contactId)
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 if contact 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 ID contactId is blocked, false otherwise.

Definition at line 54 of file kopeteblacklister.cpp.

void Kopete::BlackLister::removeContact ( Contact *  contact)
slot

Remove a contact from the blacklist.

Removes the contact from the blacklist. This function emits the contactRemoved() signal.

Parameters
contactis the contact to be removed from the list.

Definition at line 81 of file kopeteblacklister.cpp.

void Kopete::BlackLister::removeContact ( const QString &  contactId)
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:
  • kopeteblacklister.h
  • kopeteblacklister.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:53:51 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kopete/libkopete

Skip menu "kopete/libkopete"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdenetwork API Reference

Skip menu "kdenetwork API Reference"
  • kget
  • kopete
  •   kopete
  •   libkopete
  • krdc
  • krfb

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal