diff options
author | Bjørn Lindeijer <bjorn@lindeijer.nl> | 2009-03-25 22:50:59 +0100 |
---|---|---|
committer | Bjørn Lindeijer <bjorn@lindeijer.nl> | 2009-03-25 22:50:59 +0100 |
commit | cc79f0fe21e1a2ef73cbe987d54e848b9a47142d (patch) | |
tree | edd316eb6094f0c02d6d014385865dcd88a2bc56 /src/gui/shop.h | |
parent | b0df784f1be44a657ca8092069488602270629b7 (diff) | |
parent | 99e8a3fd77b63a029fe02dcf771b6af1aad252ed (diff) | |
download | mana-cc79f0fe21e1a2ef73cbe987d54e848b9a47142d.tar.gz mana-cc79f0fe21e1a2ef73cbe987d54e848b9a47142d.tar.bz2 mana-cc79f0fe21e1a2ef73cbe987d54e848b9a47142d.tar.xz mana-cc79f0fe21e1a2ef73cbe987d54e848b9a47142d.zip |
Merge branch 'eathena/master'
Conflicts:
A lot of files.
Diffstat (limited to 'src/gui/shop.h')
-rw-r--r-- | src/gui/shop.h | 49 |
1 files changed, 45 insertions, 4 deletions
diff --git a/src/gui/shop.h b/src/gui/shop.h index aa72bf2a..6c3031af 100644 --- a/src/gui/shop.h +++ b/src/gui/shop.h @@ -31,10 +31,27 @@ class ShopItem; +/** + * 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. + */ class ShopItems : public gcn::ListModel { public: /** + * Constructor. Creates a new ShopItems instance. + * + * @param mergeDuplicates lets the Shop look for duplicate entries and + * merges them to one item. + */ + ShopItems(bool mergeDuplicates = false); + + /** * Destructor. */ ~ShopItems(); @@ -46,18 +63,28 @@ class ShopItems : public gcn::ListModel #ifdef EATHENA_SUPPORT /** - * Adds an item to the list (used by eAthena sell dialog). + * Adds an item to the list (used by sell dialog). Looks for + * duplicate entries, if mergeDuplicates was turned on. + * + * @param inventoryIndex the inventory index of the item + * @param id the id of the item + * @param quantity number of available copies of the item + * @param price price of the item */ void addItem(int inventoryIndex, int id, int amount, int price); #endif /** * Returns the number of items in the shop. + * + * @return the number of items in the shop */ int getNumberOfElements(); /** * Returns the name of item number i in the shop. + * + * @param i the index to retrieve */ std::string getElementAt(int i); @@ -67,17 +94,31 @@ class ShopItems : public gcn::ListModel ShopItem* at(int i) const; /** + * Removes an element from the shop. + * + * @param i index to remove + */ + void erase(int i); + + /** * Clear the vector. */ void clear(); + private: /** - * Direct access to the vector. + * Searches the current items in the shop for the specified + * id and returns the item if found, or 0 else. + * + * @return the item found or 0 */ - std::vector<ShopItem*>* getShop(); + ShopItem* findItem(int id); - private: + /** the shop storage */ std::vector<ShopItem*> mShopItems; + + /** Look for duplicate entries on addition */ + bool mMergeDuplicates; }; #endif |