/*
 * %kadu copyright begin%
 * Copyright 2011 Rafał Malinowski (rafal.przemyslaw.malinowski@gmail.com)
 * %kadu copyright end%
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef EXCLUDE_BUDDY_TALKABLE_FILTER_H
#define EXCLUDE_BUDDY_TALKABLE_FILTER_H

#include "buddies/buddy.h"

#include "talkable/filter/talkable-filter.h"

/**
 * @addtogroup Talkable
 * @{
 */

/**
 * @class ExcludeBuddyTalkableFilter
 * @author Rafał 'Vogel' Malinowski
 * @short Filter that removes given Buddy from list.
 *
 * This filter removes given Buddy from list. All other items are passed to next filters.
 */
class ExcludeBuddyTalkableFilter : public TalkableFilter
{
	Q_OBJECT

	Buddy ExcludedBuddy;

public:
	/**
	 * @author Rafał 'Vogel' Malinowski
	 * @short Create new instance of ExcludeBuddyTalkableFilter with given parent.
	 * @param excludedBuddy buddy parameter of filter
	 * @param parent QObject parent of new object
	 *
	 * Create new instance of ExcludeBuddyTalkableFilter with given parent. All Buddy items that
	 * are equal to excludedBuddy will be rejected by this filter.
	 */
	explicit ExcludeBuddyTalkableFilter(const Buddy &excludedBuddy, QObject *parent = 0);
	virtual ~ExcludeBuddyTalkableFilter();

	virtual FilterResult filterBuddy(const Buddy &buddy);

};

/**
 * @}
 */

#endif // EXCLUDE_BUDDY_TALKABLE_FILTER_H
