ShopItems Class Reference

#include <shopitems.h>

Inheritance diagram for ShopItems:

Public Member Functions
	ShopItems (const bool mergeDuplicates, const std::string &currency)
	~ShopItems ()
ShopItem *	addItem (const int id, const ItemTypeT type, const ItemColor color, const int amount, const int price)
ShopItem *	addItem2 (const int inventoryIndex, const int id, const ItemTypeT type, const ItemColor color, const int amount, const int price)
ShopItem *	addItemNoDup (const int id, const ItemTypeT type, const ItemColor color, const int amount, const int price)
int	getNumberOfElements ()
bool	empty () const
std::string	getElementAt (int i)
ShopItem *	at (const size_t i) const
void	erase (const unsigned int i)
void	del (const unsigned int i)
void	clear ()
std::vector< ShopItem * > &	items ()
std::vector< ShopItem * > &	allItems ()
void	setMergeDuplicates (const bool b)
void	updateList ()
Public Member Functions inherited from ListModel
	ListModel ()
virtual	~ListModel ()

Private Member Functions
ShopItem *	findItem (const int id, const ItemColor color) const
bool	findInAllItems (std::vector< ShopItem * >::iterator &it, const ShopItem *const item)

Private Attributes
std::vector< ShopItem * >	mAllShopItems
std::vector< ShopItem * >	mShopItems
std::string	mCurrency
bool	mMergeDuplicates

Detailed Description

This class handles the list of items available in a shop.

The addItem routine can automatically check, if an item already exists and only adds duplicates to the old item, if one is found. The original distribution of the duplicates can be retrieved from the item.

This functionality can be enabled in the constructor.

Definition at line 49 of file shopitems.h.

Constructor & Destructor Documentation

ShopItems()

ShopItems::ShopItems	(	const bool	mergeDuplicates,
		const std::string &	currency
	)

Constructor.

Parameters

mergeDuplicates

lets the Shop look for duplicate entries and merges them to one item.

Definition at line 33 of file shopitems.cpp.

                                                :
    ListModel(),
    mAllShopItems(),
    mShopItems(),
    mCurrency(currency),
    mMergeDuplicates(mergeDuplicates)
{
}

~ShopItems()

ShopItems::~ShopItems

(

)

Definition at line 43 of file shopitems.cpp.

{
    clear();
}

References clear().

Member Function Documentation

addItem()

ShopItem * ShopItems::addItem	(	const int	id,
		const ItemTypeT	type,
		const ItemColor	color,
		const int	amount,
		const int	price
	)

Adds an item to the list.

Definition at line 59 of file shopitems.cpp.

{
    ShopItem *const item = new ShopItem(-1,
        id,
        type,
        color,
        amount,
        price,
        mCurrency);
    mShopItems.push_back(item);
    mAllShopItems.push_back(item);
    return item;
}

References mAllShopItems, mCurrency, and mShopItems.

Referenced by SellDialog::addItem(), BuyDialog::addItem(), and ShopWindow::loadList().

addItem2()

ShopItem * ShopItems::addItem2	(	const int	inventoryIndex,
		const int	id,
		const ItemTypeT	type,
		const ItemColor	color,
		const int	amount,
		const int	price
	)

Adds an item to the list (used by sell dialog). Looks for duplicate entries, if mergeDuplicates was turned on.

Parameters

inventoryIndex	the inventory index of the item
id	the id of the item
amount	number of available copies of the item
price	price of the item

Definition at line 99 of file shopitems.cpp.

{
    ShopItem *item = nullptr;
    if (mMergeDuplicates)
        item = findItem(id, color);
 
    if (item != nullptr)
    {
        item->addDuplicate(inventoryIndex, quantity);
    }
    else
    {
        item = new ShopItem(inventoryIndex,
            id,
            type,
            color,
            quantity,
            price,
            mCurrency);
        mShopItems.push_back(item);
        mAllShopItems.push_back(item);
    }
    return item;
}

References ShopItem::addDuplicate(), findItem(), mAllShopItems, mCurrency, mMergeDuplicates, and mShopItems.

Referenced by SellDialog::addItem().

addItemNoDup()

ShopItem * ShopItems::addItemNoDup	(	const int	id,
		const ItemTypeT	type,
		const ItemColor	color,
		const int	amount,
		const int	price
	)

Definition at line 77 of file shopitems.cpp.

{
    ShopItem *item = findItem(id, color);
    if (item == nullptr)
    {
        item = new ShopItem(-1,
            id,
            type,
            color,
            amount,
            price,
            mCurrency);
        mShopItems.push_back(item);
        mAllShopItems.push_back(item);
    }
    return item;
}

References findItem(), mAllShopItems, mCurrency, and mShopItems.

Referenced by ShopWindow::addBuyItem(), and ShopWindow::addSellItem().

allItems()

std::vector<ShopItem*>& ShopItems::allItems ( )

inline

Definition at line 139 of file shopitems.h.

        { return mAllShopItems; }

References mAllShopItems.

Referenced by BuyDialog::action(), BuyDialog::applyNameFilter(), and NpcSellDialog::sellManyItems().

at()

ShopItem * ShopItems::at

(

const size_t

i

)

const

Returns the item number i in the shop.

Definition at line 129 of file shopitems.cpp.

{
    if (i >= mShopItems.size())
        return nullptr;
 
    return mShopItems.at(i);
}

References mShopItems.

Referenced by BuyDialog::action(), ShopListBox::draw(), ShopListBox::mouseMoved(), ShopListBox::mouseReleased(), BuyingStoreSellDialog::sellAction(), EggSelectionDialog::sellAction(), InsertCardDialog::sellAction(), NpcSellDialog::sellAction(), ShopSellDialog::sellAction(), NpcSellDialog::sellManyItems(), NpcSellDialog::sellOneItem(), SellDialog::updateButtonsAndLabels(), BuyDialog::updateButtonsAndLabels(), and BuyDialog::updateSlider().

clear()

void ShopItems::clear

(

)

Clears the list of items in the shop.

Definition at line 174 of file shopitems.cpp.

{
    delete_all(mAllShopItems);
    mAllShopItems.clear();
    mShopItems.clear();
}

References delete_all(), mAllShopItems, and mShopItems.

Referenced by ShopWindow::loadList(), SellDialog::reset(), BuyDialog::reset(), and ~ShopItems().

del()

void ShopItems::del

(

const unsigned int

i

)

Removes an element from the shop and destroy it.

Parameters

i	index to remove

Definition at line 161 of file shopitems.cpp.

{
    if (i >= CAST_U32(mShopItems.size()))
        return;
 
    ShopItem *item = *(mShopItems.begin() + i);
    STD_VECTOR<ShopItem*>::iterator it;
    if (findInAllItems(it, item))
        mAllShopItems.erase(it);
    mShopItems.erase(mShopItems.begin() + i);
    delete item;
}

References CAST_U32, findInAllItems(), mAllShopItems, and mShopItems.

Referenced by ShopWindow::action(), and NpcSellDialog::sellOneItem().

empty()

bool ShopItems::empty ( ) const

inline

Definition at line 102 of file shopitems.h.

        { return mShopItems.empty(); }

References mShopItems.

Referenced by ShopWindow::isShopEmpty().

erase()

void ShopItems::erase

(

const unsigned int

i

)

Removes an element from the shop.

Parameters

i	index to remove

Definition at line 149 of file shopitems.cpp.

{
    if (i >= CAST_U32(mShopItems.size()))
        return;
 
    const ShopItem *const item = *(mShopItems.begin() + i);
    STD_VECTOR<ShopItem*>::iterator it;
    if (findInAllItems(it, item))
        mAllShopItems.erase(it);
    mShopItems.erase(mShopItems.begin() + i);
}

References CAST_U32, findInAllItems(), mAllShopItems, and mShopItems.

findInAllItems()

bool ShopItems::findInAllItems ( std::vector< ShopItem * >::iterator &  it, const ShopItem *const  item  )

private

Definition at line 137 of file shopitems.cpp.

{
    const STD_VECTOR<ShopItem*>::iterator it_end = mAllShopItems.end();
    for (it = mAllShopItems.begin(); it != it_end; ++ it)
    {
        if (*it == item)
            return true;
    }
    return false;
}

References mAllShopItems.

Referenced by del(), and erase().

findItem()

ShopItem * ShopItems::findItem ( const int  id, const ItemColor  color  ) const

private

Searches the current items in the shop for the specified id and returns the item if found, or 0 else.

Returns

the item found or 0

Definition at line 181 of file shopitems.cpp.

{
    STD_VECTOR<ShopItem*>::const_iterator it = mShopItems.begin();
    const STD_VECTOR<ShopItem*>::const_iterator e = mShopItems.end();
    while (it != e)
    {
        ShopItem *const item = *it;
        if (item->getId() == id && item->getColor() == color)
            return item;
 
        ++it;
    }
 
    return nullptr;
}

References Item::getColor(), Item::getId(), and mShopItems.

Referenced by addItem2(), and addItemNoDup().

getElementAt()

std::string ShopItems::getElementAt ( int  i )

virtual

Returns the name of item number i in the shop.

Parameters

i	the index to retrieve

Implements ListModel.

Definition at line 48 of file shopitems.cpp.

{
    if (i < 0 || CAST_U32(i)
        >= CAST_U32(mShopItems.size()) || (mShopItems.at(i) == nullptr))
    {
        return "";
    }
 
    return mShopItems.at(i)->getDisplayName();
}

References CAST_U32, and mShopItems.

getNumberOfElements()

int ShopItems::getNumberOfElements ( )

inlinevirtual

Returns the number of items in the shop.

Implements ListModel.

Definition at line 99 of file shopitems.h.

        { return CAST_S32(mShopItems.size()); }

References CAST_S32, and mShopItems.

Referenced by SellDialog::action(), BuyDialog::action(), ShopWindow::action(), ShopListBox::mouseMoved(), ShopListBox::mouseReleased(), and ShopWindow::updateButtonsAndLabels().

items()

std::vector<ShopItem*>& ShopItems::items ( )

inline

Definition at line 136 of file shopitems.h.

        { return mShopItems; }

References mShopItems.

Referenced by ShopWindow::action(), ShopWindow::announce(), ShopWindow::findShopItem(), ShopWindow::giveList(), ShopWindow::saveList(), and BuyDialog::sort().

setMergeDuplicates()

void ShopItems::setMergeDuplicates ( const bool  b )

inline

Definition at line 142 of file shopitems.h.

        { mMergeDuplicates = b; }

References mMergeDuplicates.

Referenced by EggSelectionDialog::initButtons(), InsertCardDialog::initButtons(), and SellDialog::postInit().

updateList()

void ShopItems::updateList

(

)

Definition at line 198 of file shopitems.cpp.

{
    mShopItems.clear();
    FOR_EACH (STD_VECTOR<ShopItem*>::iterator, it, mAllShopItems)
    {
        ShopItem *const item = *it;
        if ((item != nullptr) && item->isVisible())
            mShopItems.push_back(item);
    }
}

References FOR_EACH, ShopItem::isVisible(), mAllShopItems, and mShopItems.

Referenced by BuyDialog::applyNameFilter().

Field Documentation

mAllShopItems

std::vector<ShopItem*> ShopItems::mAllShopItems

private

The list of items in the shop.

Definition at line 161 of file shopitems.h.

Referenced by addItem(), addItem2(), addItemNoDup(), allItems(), clear(), del(), erase(), findInAllItems(), and updateList().

mCurrency

std::string ShopItems::mCurrency

private

Definition at line 165 of file shopitems.h.

Referenced by addItem(), addItem2(), and addItemNoDup().

mMergeDuplicates

bool ShopItems::mMergeDuplicates

private

Look for duplicate entries on addition.

Definition at line 168 of file shopitems.h.

Referenced by addItem2(), and setMergeDuplicates().

mShopItems

std::vector<ShopItem*> ShopItems::mShopItems

private

Definition at line 163 of file shopitems.h.

Referenced by addItem(), addItem2(), addItemNoDup(), at(), clear(), del(), empty(), erase(), findItem(), getElementAt(), getNumberOfElements(), items(), and updateList().

---

The documentation for this class was generated from the following files:

• src/gui/models/shopitems.h (986a3bf)
• src/gui/models/shopitems.cpp (986a3bf)