/*

 *  The ManaPlus Client

 *  Copyright (C) 2004-2009  The Mana World Development Team

 *  Copyright (C) 2009-2010  The Mana Developers

 *  Copyright (C) 2011-2019  The ManaPlus Developers

 *  Copyright (C) 2019-2021  Andrei Karas

 *

 *  This file is part of The ManaPlus Client.

 *

 *  This program 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.

 *

 *  This program 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 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/fonts/textchunk.h"

#include "gui/widgets/widget.h"

#include "listeners/focuslistener.h"

#include "listeners/keylistener.h"

#include "listeners/mouselistener.h"

#include "listeners/widgetlistener.h"

#include "render/graphics.h"

#include "localconsts.h"

class Image;

class ImageCollection;

class ImageSet;

class Skin;

/**

 * Button widget. Same as the Guichan button but with custom look.

 *

 * \ingroup GUI

 */

class Button final : public Widget,

                     public MouseListener,

                     public KeyListener,

                     public FocusListener,

                     public WidgetListener

{

    public:

        /**

         * Default constructor.

         */

        Button(const Widget2 *const widget,

               const std::string &restrict skinName);

        /**

         * Constructor, sets the caption of the button to the given string and

         * adds the given action listener.

         */

        Button(const Widget2 *const widget,

               const std::string &restrict caption,

               const std::string &restrict actionEventId,

               const std::string &restrict skinName,

               ActionListener *const listener);

        /**

         * Constructor, sets the caption of the button to the given string and

         * adds the given action listener.

         */

        Button(const Widget2 *const widget,

               const std::string &restrict caption,

               const std::string &restrict imageName,

               const int imageWidth, const int imageHeight,

               const std::string &restrict actionEventId,

               const std::string &restrict skinName,

               ActionListener *const listener);

        /**

         * Constructor, sets the caption of the button to the given string and

         * adds the given action listener.

         */

        Button(const Widget2 *const widget,

               const std::string &restrict imageName,

               const int imageWidth,

               const int imageHeight,

               const std::string &restrict actionEventId,

               const std::string &restrict skinName,

               ActionListener *const listener);

        A_DELETE_COPY(Button)

        /**

         * Destructor.

         */

        ~Button() override final;

        /**

         * Draws the button.

         */

        void draw(Graphics *const graphics) override final A_NONNULL(2);

        void safeDraw(Graphics *const graphics) override final A_NONNULL(2);

        /**

         * Update the alpha value to the button components.

         */

        void updateAlpha();

        void mouseReleased(MouseEvent& event) override final;

        void setDescription(const std::string &text)

        std::string getDescription() const noexcept2 A_WARN_UNUSED

        int getClickCount() const noexcept2 A_WARN_UNUSED

        void setTag(int tag)

        int getTag() const noexcept2 A_WARN_UNUSED

        void setStick(bool b)

        void setPressed(bool b)

        void widgetResized(const Event &event) override final;

        void widgetMoved(const Event &event) override final;

        void widgetHidden(const Event &event) override final;

        void loadImage(const std::string &imageName);

        void loadImageSet(const std::string &imageName);

        void setImage(Image *const image);

        void adjustSize();

        void keyPressed(KeyEvent &event) override final;

        void keyReleased(KeyEvent &event) 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)

        /**

         * Gets the caption of the button.

         *

         * @return The caption of the button.

         */

        const std::string& getCaption() const noexcept2 A_WARN_UNUSED

        { 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) noexcept2

        { mAlignment = alignment; }

        /**

         * Gets the alignment of the caption.

         *

         * @return The alignment of the caption.

         * @see setAlignment, Graphics

         */

        Graphics::Alignment getAlignment() const noexcept2 A_WARN_UNUSED

        { return mAlignment; }

        void focusLost(const Event& event) override final;

        void mousePressed(MouseEvent& event) override final;

        void mouseEntered(MouseEvent& event) override final;

        void mouseExited(MouseEvent& event) override final;

        void mouseDragged(MouseEvent& event) override final;

        void setParent(Widget *widget) override final;

        void setWindow(Widget *const widget) override final;

        void setImageWidth(const int width) noexcept2

        void setImageHeight(const int height) noexcept2

        enum

        {

            BUTTON_STANDARD = 0,  // 0

            BUTTON_HIGHLIGHTED,   // 1

            BUTTON_PRESSED,       // 2

            BUTTON_DISABLED,      // 3

            BUTTON_COUNT          // 4 - Must be last.

        };

    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 float mAlpha;

        Skin *mSkin[BUTTON_COUNT];  /**< Button state graphics */

        /**

         * Holds the caption of the button.

         */

        std::string mCaption;

        std::string mDescription;

        std::string mSkinName;

        TextChunk mTextChunk;

        ImageCollection *mVertexes2 A_NONNULLPOINTER;

        Color mEnabledColor;

        Color mEnabledColor2;

        Color mDisabledColor;

        Color mDisabledColor2;

        Color mHighlightedColor;

        Color mHighlightedColor2;

        Color mPressedColor;

        Color mPressedColor2;

        Image **mImages;

        ImageSet *mImageSet;

        /**

         * Holds the alignment of the caption.

         */

        Graphics::Alignment mAlignment;

        int mClickCount;

        /**

         * Holds the spacing between the border and the caption.

         */

        int mSpacing[BUTTON_COUNT];

        int mTag;

        int mMode;

        int mXOffset;

        int mYOffset;

        int mImageWidth;

        int mImageHeight;

        /**

         * 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;

        bool mStick;

        bool mPressed;

        bool mTextChanged;

};

#endif  // GUI_WIDGETS_BUTTON_H