Introduced SelectionListener to fix updating problem in inventory window

(should also be used to fix similar problem in trade, buy and sell dialogs).
Made the ItemInfo be passed around as a reference instead of a pointer, since
it is never NULL.

10 files changed, 204 insertions, 51 deletions

diff --git a/src/gui/buy.cpp b/src/gui/buy.cpp
index 7b9eb29c..20ceca92 100644
--- a/src/gui/buy.cpp
+++ b/src/gui/buy.cpp
@@ -140,7 +140,8 @@ void BuyDialog::addItem(short id, int price)
 {
     ITEM_SHOP item_shop;
 
-    item_shop.name = itemDb->getItemInfo(id)->getName() + " " + toString(price) + " GP";
+    item_shop.name = itemDb->getItemInfo(id).getName() + " "
+        + toString(price) + " GP";
     item_shop.price = price;
     item_shop.id = id;
 
@@ -262,9 +263,10 @@ void BuyDialog::mouseClick(int x, int y, int button, int count)
     int selectedItem = mItemList->getSelected();
     if (selectedItem > -1)
     {
-        mItemDescLabel->setCaption("Description: " +
-                itemDb->getItemInfo(mShopItems->at(selectedItem).id)->getDescription());
-        mItemEffectLabel->setCaption("Effect: " +
-                itemDb->getItemInfo(mShopItems->at(selectedItem).id)->getEffect());
+        const ItemInfo &info =
+            itemDb->getItemInfo(mShopItems->at(selectedItem).id);
+
+        mItemDescLabel->setCaption("Description: " + info.getDescription());
+        mItemEffectLabel->setCaption("Effect: " + info.getEffect());
     }
 }
diff --git a/src/gui/equipmentwindow.cpp b/src/gui/equipmentwindow.cpp
index 2cbffde4..ec525c47 100644
--- a/src/gui/equipmentwindow.cpp
+++ b/src/gui/equipmentwindow.cpp
@@ -65,7 +65,7 @@ void EquipmentWindow::draw(gcn::Graphics *graphics)
             continue;
         }
 
-        image = item->getInfo()->getImage();
+        image = item->getInfo().getImage();
         dynamic_cast<Graphics*>(graphics)->drawImage(
                 image, 36 * (i % 4) + 10, 36 * (i / 4) + 25);
     }
@@ -76,7 +76,7 @@ void EquipmentWindow::draw(gcn::Graphics *graphics)
         return;
     }
 
-    image = item->getInfo()->getImage();
+    image = item->getInfo().getImage();
 
     dynamic_cast<Graphics*>(graphics)->drawImage(image, 160, 25);
     graphics->drawText(toString(item->getQuantity()), 170, 62,
diff --git a/src/gui/inventorywindow.cpp b/src/gui/inventorywindow.cpp
index 04f07479..5812a71a 100644
--- a/src/gui/inventorywindow.cpp
+++ b/src/gui/inventorywindow.cpp
@@ -55,6 +55,8 @@ InventoryWindow::InventoryWindow():
     mDropButton = new Button("Drop", "drop", this);
 
     mItems = new ItemContainer(player_node->mInventory.get());
+    mItems->addSelectionListener(this);
+
     mInvenScroll = new ScrollArea(mItems);
     mInvenScroll->setPosition(8, 8);
     mInvenScroll->setHorizontalScrollPolicy(gcn::ScrollArea::SHOW_NEVER);
@@ -123,33 +125,46 @@ void InventoryWindow::action(const std::string& eventId, gcn::Widget* widget)
     }
 }
 
-void InventoryWindow::mouseClick(int x, int y, int button, int count)
+void InventoryWindow::selectionChanged(const SelectionEvent &event)
 {
-    Window::mouseClick(x, y, button, count);
-
     Item *item = mItems->getItem();
 
-    if (!item) {
-        return;
+    // Update name, effect and description
+    if (!item)
+    {
+        mItemNameLabel->setCaption("Name:");
+        mItemEffectLabel->setCaption("Effect:");
+        mItemDescriptionLabel->setCaption("Description:");
+    }
+    else
+    {
+        const ItemInfo& itemInfo = item->getInfo();
+        std::string SomeText;
+        SomeText = "Name: " + itemInfo.getName();
+        mItemNameLabel->setCaption(SomeText);
+        SomeText = "Effect: " + itemInfo.getEffect();
+        mItemEffectLabel->setCaption(SomeText);
+        SomeText = "Description: " + itemInfo.getDescription();
+        mItemDescriptionLabel->setCaption(SomeText);
+
+        mItemNameLabel->adjustSize();
+        mItemEffectLabel->adjustSize();
+        mItemDescriptionLabel->adjustSize();
     }
+}
 
-    // Show Name and Description
-    std::string SomeText;
-    SomeText = "Name: " + item->getInfo()->getName();
-    mItemNameLabel->setCaption(SomeText);
-    mItemNameLabel->adjustSize();
-    SomeText = "Effect: " + item->getInfo()->getEffect();
-    mItemEffectLabel->setCaption(SomeText);
-    mItemEffectLabel->adjustSize();
-    SomeText = "Description: " + item->getInfo()->getDescription();
-    mItemDescriptionLabel->setCaption(SomeText);
-    mItemDescriptionLabel->adjustSize();
+void InventoryWindow::mouseClick(int x, int y, int button, int count)
+{
+    Window::mouseClick(x, y, button, count);
 
     if (button == gcn::MouseInput::RIGHT)
     {
-        /*
-         * convert relative to the window coordinates to
-         * absolute screen coordinates
+        Item *item = mItems->getItem();
+
+        if (!item) return;
+
+        /* Convert relative to the window coordinates to
+         * absolute screen coordinates.
          */
         int mx = x + getX();
         int my = y + getY();
@@ -223,11 +238,6 @@ void InventoryWindow::loadWindowState()
     updateWidgets();
 }
 
-void InventoryWindow::setDefaultSize(int defaultX, int defaultY, int defaultWidth, int defaultHeight)
-{
-    Window::setDefaultSize(defaultX, defaultY, defaultWidth, defaultHeight);
-}
-
 void InventoryWindow::resetToDefaultSize()
 {
     Window::resetToDefaultSize();
diff --git a/src/gui/inventorywindow.h b/src/gui/inventorywindow.h
index da7a7ef2..a2c7535b 100644
--- a/src/gui/inventorywindow.h
+++ b/src/gui/inventorywindow.h
@@ -27,6 +27,7 @@
 #include <guichan/actionlistener.hpp>
 
 #include "window.h"
+#include "selectionlistener.h"
 
 #include "../guichanfwd.h"
 
@@ -38,7 +39,7 @@ class ItemContainer;
  *
  * \ingroup Interface
  */
-class InventoryWindow : public Window, gcn::ActionListener
+class InventoryWindow : public Window, gcn::ActionListener, SelectionListener
 {
     public:
         /**
@@ -47,14 +48,14 @@ class InventoryWindow : public Window, gcn::ActionListener
         InventoryWindow();
 
         /**
-         * Logic (updates buttons and weight information)
+         * Logic (updates buttons and weight information).
          */
         void logic();
 
         /**
          * Called when receiving actions from the widgets.
          */
-        void action(const std::string& eventId, gcn::Widget* widget);
+        void action(const std::string &eventId, gcn::Widget *widget);
 
         void mouseClick(int x, int y, int button, int count);
 
@@ -64,10 +65,15 @@ class InventoryWindow : public Window, gcn::ActionListener
 
         void loadWindowState();
 
-        void setDefaultSize(int defaultX, int defaultY, int defaultWidth, int defaultHeight);
-
         void resetToDefaultSize();
 
+        /**
+         * Updates labels to currently selected item.
+         *
+         * @see SelectionListener::selectionChanged.
+         */
+        void selectionChanged(const SelectionEvent &event);
+
     private:
         void updateButtons();    /** Updates button states */
 
diff --git a/src/gui/itemcontainer.cpp b/src/gui/itemcontainer.cpp
index c7c55fd9..5bcd000d 100644
--- a/src/gui/itemcontainer.cpp
+++ b/src/gui/itemcontainer.cpp
@@ -25,6 +25,8 @@
 
 #include <guichan/mouseinput.hpp>
 
+#include "selectionlistener.h"
+
 #include "../graphics.h"
 #include "../inventory.h"
 #include "../item.h"
@@ -38,14 +40,14 @@
 #include "../utils/tostring.h"
 
 ItemContainer::ItemContainer(Inventory *inventory):
-    mInventory(inventory)
+    mInventory(inventory),
+    mSelectedItem(NULL)
 {
     ResourceManager *resman = ResourceManager::getInstance();
 
     mSelImg = resman->getImage("graphics/gui/selection.png");
     if (!mSelImg) logger->error("Unable to load selection.png");
 
-    mSelectedItem = 0; // No item selected
     mMaxItems = mInventory->getLastUsedSlot() - 1; // Count from 0, usage from 2
 
     addMouseListener(this);
@@ -84,7 +86,7 @@ void ItemContainer::draw(gcn::Graphics* graphics)
     // sure somewhere else)
     if (mSelectedItem && mSelectedItem->getQuantity() <= 0)
     {
-        mSelectedItem = 0;
+        selectNone();
     }
 
     /*
@@ -111,7 +113,7 @@ void ItemContainer::draw(gcn::Graphics* graphics)
 
         // Draw item icon
         Image* image;
-        if ((image = item->getInfo()->getImage()) != NULL)
+        if ((image = item->getInfo().getImage()) != NULL)
         {
             dynamic_cast<Graphics*>(graphics)->drawImage(
                     image, itemX, itemY);
@@ -150,7 +152,28 @@ Item* ItemContainer::getItem()
 
 void ItemContainer::selectNone()
 {
-    mSelectedItem = 0;
+    setSelectedItem(NULL);
+}
+
+void ItemContainer::setSelectedItem(Item *item)
+{
+    if (mSelectedItem != item)
+    {
+        mSelectedItem = item;
+        fireSelectionChangedEvent();
+    }
+}
+
+void ItemContainer::fireSelectionChangedEvent()
+{
+    SelectionEvent event(this);
+    SelectionListeners::iterator i_end = mListeners.end();
+    SelectionListeners::iterator i;
+
+    for (i = mListeners.begin(); i != i_end; ++i)
+    {
+        (*i)->selectionChanged(event);
+    }
 }
 
 void ItemContainer::mousePress(int mx, int my, int button)
@@ -166,6 +189,6 @@ void ItemContainer::mousePress(int mx, int my, int button)
         if (index > INVENTORY_SIZE) {
             index = INVENTORY_SIZE - 1;
         }
-        mSelectedItem = mInventory->getItem(index);
+        setSelectedItem(mInventory->getItem(index));
     }
 }
diff --git a/src/gui/itemcontainer.h b/src/gui/itemcontainer.h
index f52f37ec..a2d5f0f7 100644
--- a/src/gui/itemcontainer.h
+++ b/src/gui/itemcontainer.h
@@ -27,9 +27,12 @@
 #include <guichan/mouselistener.hpp>
 #include <guichan/widget.hpp>
 
+#include <list>
+
 class Image;
 class Inventory;
 class Item;
+class SelectionListener;
 
 /**
  * An item container. Used to show items in inventory and trade dialog.
@@ -76,16 +79,46 @@ class ItemContainer : public gcn::Widget, public gcn::MouseListener
         Item* getItem();
 
         /**
-         * Set selected item to -1.
+         * Sets selected item to NULL.
          */
         void selectNone();
 
+        /**
+         * Adds a listener to the list that's notified each time a change to
+         * the selection occurs.
+         */
+        void addSelectionListener(SelectionListener *listener)
+        {
+            mListeners.push_back(listener);
+        }
+
+        /**
+         * Removes a listener from the list that's notified each time a change
+         * to the selection occurs.
+         */
+        void removeSelectionListener(SelectionListener *listener)
+        {
+            mListeners.remove(listener);
+        }
+
     private:
+        /**
+         * Sets the currently selected item.
+         */
+        void setSelectedItem(Item *item);
+
+        /**
+         * Sends out selection events to the list of selection listeners.
+         */
+        void fireSelectionChangedEvent();
+
         Inventory *mInventory;
         Image *mSelImg;
         Item *mSelectedItem;
 
         int mMaxItems;
+
+        std::list<SelectionListener*> mListeners;
 };
 
 #endif
diff --git a/src/gui/popupmenu.cpp b/src/gui/popupmenu.cpp
index 59316de1..ab81f7d0 100644
--- a/src/gui/popupmenu.cpp
+++ b/src/gui/popupmenu.cpp
@@ -106,7 +106,7 @@ void PopupMenu::showPopup(int x, int y, FloorItem *floorItem)
     mBrowserBox->clearRows();
 
     // Floor item can be picked up (single option, candidate for removal)
-    std::string name = itemDb->getItemInfo(mFloorItem->getItemId())->getName();
+    std::string name = itemDb->getItemInfo(mFloorItem->getItemId()).getName();
     mBrowserBox->addRow("@@pickup|Pick Up " + name + "@@");
 
     //browserBox->addRow("@@look|Look To@@");
diff --git a/src/gui/selectionlistener.h b/src/gui/selectionlistener.h
new file mode 100644
index 00000000..e01b0c2f
--- /dev/null
+++ b/src/gui/selectionlistener.h
@@ -0,0 +1,78 @@
+/*
+ *  The Mana World
+ *  Copyright 2004 The Mana World Development Team
+ *
+ *  This file is part of The Mana World.
+ *
+ *  The Mana World 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
+ *  any later version.
+ *
+ *  The Mana World 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 The Mana World; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ *  $Id: itemcontainer.h 2545 2006-08-17 19:11:28Z crush_tmw $
+ */
+
+#ifndef _TMW_SELECTIONLISTENER_H__
+#define _TMW_SELECTIONLISTENER_H__
+
+#include <guichan/widget.hpp>
+
+/**
+ * An event that characterizes a change in the current selection.
+ *
+ * \ingroup GUI
+ */
+class SelectionEvent
+{
+    public:
+        /**
+         * Constructor.
+         */
+        SelectionEvent(gcn::Widget *source):
+            mSource(source)
+        {
+        }
+
+        /**
+         * The widget from which the event originated.
+         */
+        gcn::Widget* getSource() const
+        {
+            return mSource;
+        }
+
+    private:
+        gcn::Widget *mSource;
+};
+
+/**
+ * The listener that's notified when a selection value changes.
+ *
+ * \ingroup GUI
+ */
+class SelectionListener
+{
+    public:
+        /**
+         * Virtual destructor.
+         */
+        virtual ~SelectionListener() {}
+
+        /**
+         * Called whenever the value of the selection changes.
+         */
+        virtual void selectionChanged(const SelectionEvent &event) = 0;
+};
+
+typedef std::list<SelectionListener*> SelectionListeners;
+
+#endif
diff --git a/src/gui/sell.cpp b/src/gui/sell.cpp
index 17185d71..44fa8e41 100644
--- a/src/gui/sell.cpp
+++ b/src/gui/sell.cpp
@@ -142,7 +142,7 @@ void SellDialog::addItem(Item *item, int price)
 
     ITEM_SHOP item_shop;
 
-    item_shop.name = item->getInfo()->getName() + " " + toString(price) + " GP";
+    item_shop.name = item->getInfo().getName() + " " + toString(price) + " GP";
     item_shop.price = price;
     item_shop.index = item->getInvIndex();
     item_shop.id = item->getId();
@@ -259,9 +259,10 @@ void SellDialog::mouseClick(int x, int y, int button, int count)
     int selectedItem = mItemList->getSelected();
     if (selectedItem > -1)
     {
-        mItemDescLabel->setCaption("Description: " +
-                itemDb->getItemInfo(mShopItems->at(selectedItem).id)->getDescription());
-        mItemEffectLabel->setCaption("Effect: " +
-                itemDb->getItemInfo(mShopItems->at(selectedItem).id)->getEffect());
+        const ItemInfo &info =
+            itemDb->getItemInfo(mShopItems->at(selectedItem).id);
+
+        mItemDescLabel->setCaption("Description: " + info.getDescription());
+        mItemEffectLabel->setCaption("Effect: " + info.getEffect());
     }
 }
diff --git a/src/gui/trade.cpp b/src/gui/trade.cpp
index 0086879e..babb5a87 100644
--- a/src/gui/trade.cpp
+++ b/src/gui/trade.cpp
@@ -250,10 +250,10 @@ void TradeWindow::mouseClick(int x, int y, int button, int count)
 
     // Show Name and Description
     std::string SomeText;
-    SomeText = "Name: " + item->getInfo()->getName();
+    SomeText = "Name: " + item->getInfo().getName();
     mItemNameLabel->setCaption(SomeText);
     mItemNameLabel->adjustSize();
-    SomeText = "Description: " + item->getInfo()->getDescription();
+    SomeText = "Description: " + item->getInfo().getDescription();
     mItemDescriptionLabel->setCaption(SomeText);
     mItemDescriptionLabel->adjustSize();
 }