//+----------------------------------------------------------------------------+
//| Description:  Magic Set Editor - Program to make Magic (tm) cards          |
//| Copyright:    (C) 2001 - 2010 Twan van Laarhoven and Sean Hunt             |
//| License:      GNU General Public License 2 or later (see file COPYING)     |
//+----------------------------------------------------------------------------+

#ifndef HEADER_GUI_CONTROL_FILTERED_CARD_LIST
#define HEADER_GUI_CONTROL_FILTERED_CARD_LIST

// ----------------------------------------------------------------------------- : Includes

#include <util/prec.hpp>
#include <gui/control/card_list.hpp>

DECLARE_POINTER_TYPE(CardListFilter);

// ----------------------------------------------------------------------------- : CardListFilter

/// A filter function to determine which items are shown in a card list
class CardListFilter : public IntrusivePtrVirtualBase {
  public:
	virtual ~CardListFilter() {}
	/// Should a card be shown in the list?
	virtual bool keep(const CardP& card) const { return false; }
	/// Select cards from a card list
	virtual void getItems(const vector<CardP>& cards, vector<VoidP>& out) const;
};

// ----------------------------------------------------------------------------- : FilteredCardList

/// A card list that lists a subset of the cards in the set
class FilteredCardList : public CardListBase {
  public:
	FilteredCardList(Window* parent, int id, long style = 0);
	
	/// Change the filter to use
	void setFilter(const CardListFilterP& filter);
	
  protected:
	/// Get only the subset of the cards
	virtual void getItems(vector<VoidP>& out) const;
	
	virtual void onChangeSet();
	
  private:	
	CardListFilterP filter;	///< Filter with which this.cards is made
};


// ----------------------------------------------------------------------------- : EOF
#endif
