/*

 *  The ManaPlus Client

 *  Copyright (C) 2009  Aethyra Development Team

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

#define GUI_WIDGETS_LABEL_H

#include "gui/fonts/textchunk.h"

#include "gui/widgets/widget.h"

#include "listeners/tooltiplistener.h"

#include "listeners/widgetlistener.h"

#include "render/graphics.h"

#include "localconsts.h"

class Skin;

/**

 * Label widget. Same as the Guichan label but modified to use the palette

 * system.

 *

 * \ingroup GUI

 */

class Label final : public Widget,

                    public WidgetListener,

                    public ToolTipListener

{

    public:

        /**

         * Constructor.

         */

        explicit Label(const Widget2 *const widget);

        /**

         * Constructor. This version of the constructor sets the label with an

         * inintialization string.

         */

        Label(const Widget2 *const widget,

              const std::string &caption);

        A_DELETE_COPY(Label)

        ~Label() override final;

        void init();

        /**

         * Draws the label.

         */

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

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

        void adjustSize();

        void setForegroundColor(const Color &color);

        void setForegroundColorAll(const Color &color1,

                                   const Color &color2);

        void resizeTo(const int maxSize, const int minSize);

        /**

         * Gets the caption of the label.

         *

         * @return The caption of the label.

         * @see setCaption

         */

        const std::string &getCaption() const

        /**

         * Sets the caption of the label. It's advisable to call

         * adjustSize after setting of the caption to adjust the

         * label's size to fit the caption.

         *

         * @param caption The caption of the label.

         * @see getCaption, adjustSize

         */

        void setCaption(const std::string& caption);

        /**

         * Sets the alignment of the caption. The alignment is relative

         * to the center of the label.

         *

         * @param alignment The alignment of the caption of the label.

         * @see getAlignment, Graphics

         */

        void setAlignment(Graphics::Alignment alignment)

        /**

         * Gets the alignment of the caption. The alignment is relative to

         * the center of the label.

         *

         * @return The alignment of caption of the label.

         * @see setAlignmentm Graphics

         */

        Graphics::Alignment getAlignment() const

        { return mAlignment; }

        void setParent(Widget *const widget) override final;

        void setWindow(Widget *const widget) override final;

        void widgetHidden(const Event &event) override final;

        static Skin *mSkin;

        static int mInstances;

        static void finalCleanup();

    private:

        /**

         * Holds the caption of the label.

         */

        std::string mCaption;

        TextChunk mTextChunk;

        /**

         * Holds the alignment of the caption.

         */

        Graphics::Alignment mAlignment;

        int mPadding;

        bool mTextChanged;

};

#endif  // GUI_WIDGETS_LABEL_H