Merge button classes in one.

2 files changed, 295 insertions, 17 deletions

diff --git a/src/gui/widgets/button.cpp b/src/gui/widgets/button.cpp
index 3cb6d823d..8e020370f 100644
--- a/src/gui/widgets/button.cpp
+++ b/src/gui/widgets/button.cpp
@@ -20,6 +20,49 @@
  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/*      _______   __   __   __   ______   __   __   _______   __   __
+ *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
+ *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
+ *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
+ *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
+ * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
+ * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
+ *
+ * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
+ *
+ *
+ * Per Larsson a.k.a finalman
+ * Olof Naessén a.k.a jansem/yakslem
+ *
+ * Visit: http://guichan.sourceforge.net
+ *
+ * License: (BSD)
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name of Guichan nor the names of its contributors may
+ *    be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
 #include "gui/widgets/button.h"
 
 #include "client.h"
@@ -53,8 +96,17 @@ static std::string const data[Button::BUTTON_COUNT] =
 Skin *Button::button[BUTTON_COUNT];
 
 Button::Button(const Widget2 *const widget) :
-    gcn::Button(widget),
+    Widget(widget),
+    MouseListener(),
+    KeyListener(),
+    FocusListener(),
     WidgetListener(),
+    mCaption(),
+    mHasMouse(false),
+    mKeyPressed(false),
+    mMousePressed(false),
+    mAlignment(Graphics::CENTER),
+    mSpacing(4),
     mDescription(),
     mVertexes2(new ImageCollection),
     mEnabledColor(getThemeColor(Theme::BUTTON)),
@@ -86,8 +138,17 @@ Button::Button(const Widget2 *const widget,
                const std::string &restrict caption,
                const std::string &restrict actionEventId,
                ActionListener *const listener) :
-    gcn::Button(widget, caption),
+    Widget(widget),
+    MouseListener(),
+    KeyListener(),
+    FocusListener(),
     WidgetListener(),
+    mCaption(caption),
+    mHasMouse(false),
+    mKeyPressed(false),
+    mMousePressed(false),
+    mAlignment(Graphics::CENTER),
+    mSpacing(4),
     mDescription(),
     mVertexes2(new ImageCollection),
     mEnabledColor(getThemeColor(Theme::BUTTON)),
@@ -125,8 +186,17 @@ Button::Button(const Widget2 *const widget,
                const int imageWidth, const int imageHeight,
                const std::string &restrict actionEventId,
                ActionListener *const listener) :
-    gcn::Button(widget, caption),
+    Widget(widget),
+    MouseListener(),
+    KeyListener(),
+    FocusListener(),
     WidgetListener(),
+    mCaption(caption),
+    mHasMouse(false),
+    mKeyPressed(false),
+    mMousePressed(false),
+    mAlignment(Graphics::CENTER),
+    mSpacing(4),
     mDescription(),
     mVertexes2(new ImageCollection),
     mEnabledColor(getThemeColor(Theme::BUTTON)),
@@ -150,6 +220,7 @@ Button::Button(const Widget2 *const widget,
     mStick(false),
     mPressed(false)
 {
+
     init();
     loadImageSet(imageName);
     adjustSize();
@@ -164,8 +235,17 @@ Button::Button(const Widget2 *const widget,
                const int imageWidth, const int imageHeight,
                const std::string &restrict actionEventId,
                ActionListener *const listener) :
-    gcn::Button(widget),
+    Widget(widget),
+    MouseListener(),
+    KeyListener(),
+    FocusListener(),
     WidgetListener(),
+    mCaption(),
+    mHasMouse(false),
+    mKeyPressed(false),
+    mMousePressed(false),
+    mAlignment(Graphics::CENTER),
+    mSpacing(4),
     mDescription(),
     mVertexes2(new ImageCollection),
     mEnabledColor(getThemeColor(Theme::BUTTON)),
@@ -203,8 +283,17 @@ Button::Button(const Widget2 *const widget,
                const std::string &restrict imageName,
                const std::string &restrict actionEventId,
                ActionListener *const listener) :
-    gcn::Button(widget, caption),
+    Widget(widget),
+    MouseListener(),
+    KeyListener(),
+    FocusListener(),
     WidgetListener(),
+    mCaption(caption),
+    mHasMouse(false),
+    mKeyPressed(false),
+    mMousePressed(false),
+    mAlignment(Graphics::CENTER),
+    mSpacing(4),
     mDescription(),
     mVertexes2(new ImageCollection),
     mEnabledColor(getThemeColor(Theme::BUTTON)),
@@ -239,10 +328,14 @@ Button::Button(const Widget2 *const widget,
 
 void Button::init()
 {
-    setFrameSize(0);
-
+    addMouseListener(this);
+    addKeyListener(this);
+    addFocusListener(this);
     addWidgetListener(this);
 
+    setFocusable(true);
+    setFrameSize(0);
+
     if (mInstances == 0)
     {
         if (Theme::instance())
@@ -584,11 +677,6 @@ void Button::adjustSize()
     }
 }
 
-void Button::setCaption(const std::string& caption)
-{
-    mCaption = caption;
-}
-
 void Button::keyPressed(KeyEvent& keyEvent)
 {
     const int action = keyEvent.getActionId();
@@ -614,8 +702,45 @@ void Button::keyReleased(KeyEvent& keyEvent)
     }
 }
 
-
 bool Button::isPressed2() const
 {
     return (mPressed || isPressed());
 }
+
+bool Button::isPressed() const
+{
+    if (mMousePressed)
+        return mHasMouse;
+    else
+        return mKeyPressed;
+}
+
+void Button::focusLost(const Event& event A_UNUSED)
+{
+    mMousePressed = false;
+    mKeyPressed = false;
+}
+
+void Button::mousePressed(MouseEvent& mouseEvent)
+{
+    if (mouseEvent.getButton() == MouseEvent::LEFT)
+    {
+        mMousePressed = true;
+        mouseEvent.consume();
+    }
+}
+
+void Button::mouseEntered(MouseEvent& mouseEvent A_UNUSED)
+{
+    mHasMouse = true;
+}
+
+void Button::mouseExited(MouseEvent& mouseEvent A_UNUSED)
+{
+    mHasMouse = false;
+}
+
+void Button::mouseDragged(MouseEvent& mouseEvent)
+{
+    mouseEvent.consume();
+}
diff --git a/src/gui/widgets/button.h b/src/gui/widgets/button.h
index 039475150..6eba9b3c0 100644
--- a/src/gui/widgets/button.h
+++ b/src/gui/widgets/button.h
@@ -20,10 +20,57 @@
  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+/*      _______   __   __   __   ______   __   __   _______   __   __
+ *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
+ *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
+ *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
+ *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
+ * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
+ * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
+ *
+ * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
+ *
+ *
+ * Per Larsson a.k.a finalman
+ * Olof Naessén a.k.a jansem/yakslem
+ *
+ * Visit: http://guichan.sourceforge.net
+ *
+ * License: (BSD)
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name of Guichan nor the names of its contributors may
+ *    be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
 #ifndef GUI_WIDGETS_BUTTON_H
 #define GUI_WIDGETS_BUTTON_H
 
-#include "gui/base/widgets/button.hpp"
+#include "gui/widgets/widget.h"
+
+#include "listeners/focuslistener.h"
+#include "listeners/keylistener.h"
+#include "listeners/mouselistener.h"
 #include "listeners/widgetlistener.h"
 
 #include "localconsts.h"
@@ -40,7 +87,10 @@ const std::string BUTTON_PLAY = "buttonplay.png";
  *
  * \ingroup GUI
  */
-class Button final : public gcn::Button,
+class Button final : public Widget,
+                     public MouseListener,
+                     public KeyListener,
+                     public FocusListener,
                      public WidgetListener
 {
     public:
@@ -139,14 +189,79 @@ class Button final : public gcn::Button,
 
         void adjustSize();
 
-        void setCaption(const std::string& caption);
-
         void keyPressed(KeyEvent &keyEvent) override final;
 
         void keyReleased(KeyEvent &keyEvent) override final;
 
         bool isPressed2() const A_WARN_UNUSED;
 
+        /**
+         * Sets the caption of the button. It's advisable to call
+         * adjustSize after setting of the caption to adjust the
+         * button's size to fit the caption.
+         *
+         * @param caption The caption of the button.
+         * @see getCaption, adjustSize
+         */
+        void setCaption(const std::string& caption)
+        { mCaption = caption; }
+
+        /**
+         * Gets the caption of the button.
+         *
+         * @return The caption of the button.
+         */
+        const std::string& getCaption() const
+        { return mCaption; }
+
+        /**
+         * Sets the alignment of the caption. The alignment is relative
+         * to the center of the button.
+         *
+         * @param alignment The alignment of the caption.
+         * @see getAlignment, Graphics
+         */
+        void setAlignment(Graphics::Alignment alignment)
+        { mAlignment = alignment; }
+
+        /**
+         * Gets the alignment of the caption.
+         *
+         * @return The alignment of the caption.
+         * @see setAlignment, Graphics
+         */
+        Graphics::Alignment getAlignment() const
+        { return mAlignment; }
+
+        /**
+         * Sets the spacing between the border of the button and its caption.
+         *
+         * @param spacing The default value for spacing is 4 and can be changed 
+         *                using this method.
+         * @see getSpacing
+         */
+        void setSpacing(unsigned int spacing)
+        { mSpacing = spacing; }
+
+        /**
+         * Gets the spacing between the border of the button and its caption.
+         *
+         * @return spacing.
+         * @see setSpacing
+         */
+        unsigned int getSpacing() const
+        { return mSpacing; }
+
+        void focusLost(const Event& event) override final;
+
+        void mousePressed(MouseEvent& mouseEvent) override final;
+
+        void mouseEntered(MouseEvent& mouseEvent) override final;
+
+        void mouseExited(MouseEvent& mouseEvent) override final;
+
+        void mouseDragged(MouseEvent& mouseEvent) override final;
+
         enum
         {
             BUTTON_STANDARD = 0,  // 0
@@ -157,12 +272,50 @@ class Button final : public gcn::Button,
         };
 
     private:
+        /**
+         * Checks if the button is pressed. Convenient method to use
+         * when overloading the draw method of the button.
+         *
+         * @return True if the button is pressed, false otherwise.
+         */
+        bool isPressed() const;
+
         void init();
 
         static Skin *button[BUTTON_COUNT];  /**< Button state graphics */
         static int mInstances;              /**< Number of button instances */
         static float mAlpha;
 
+        /**
+         * Holds the caption of the button.
+         */
+        std::string mCaption;
+
+        /**
+         * True if the mouse is ontop of the button, false otherwise.
+         */
+        bool mHasMouse;
+
+        /**
+         * True if a key has been pressed, false otherwise.
+         */
+        bool mKeyPressed;
+
+        /**
+         * True if a mouse has been pressed, false otherwise.
+         */
+        bool mMousePressed;
+
+        /**
+         * Holds the alignment of the caption.
+         */
+        Graphics::Alignment mAlignment;
+
+        /**
+         * Holds the spacing between the border and the caption.
+         */
+        unsigned int mSpacing;
+
         std::string mDescription;
         ImageCollection *mVertexes2;
         Color mEnabledColor;