path: root/src/gui/widgets/textfield.h

/*
 *  The ManaPlus Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *  Copyright (C) 2011-2014  The ManaPlus Developers
 *
 *  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/>.
 */

#ifndef GUI_WIDGETS_TEXTFIELD_H
#define GUI_WIDGETS_TEXTFIELD_H

#include "gui/widgets/widget2.h"

#include "listeners/focuslistener.h"

#include "gui/base/widgets/textfield.hpp"

#include "localconsts.h"

class PopupMenu;

/**
 * A text field.
 *
 * \ingroup GUI
 */
class TextField : public gcn::TextField,
                  public FocusListener,
                  public Widget2
{
    public:
        /**
         * Constructor, initializes the text field with the given string.
         */
        explicit TextField(const Widget2 *restrict const widget,
                           const std::string &restrict text = "",
                           const bool loseFocusOnTab = true,
                           ActionListener *restrict
                           const listener = nullptr,
                           const std::string &restrict eventId = "",
                           const bool sendAlwaysEvents = false);

        A_DELETE_COPY(TextField)

        virtual ~TextField();

        /**
         * Draws the text field.
         */
        virtual void draw(Graphics *graphics) override;

        /**
         * Update the alpha value to the graphic components.
         */
        void updateAlpha();

        /**
         * Draws the background and border.
         */
        void drawFrame(Graphics *graphics) override final;

        /**
         * Determine whether the field should be numeric or not
         */
        void setNumeric(const bool numeric);

        /**
         * Set the range on the field if it is numeric
         */
        void setRange(const int min, const int max)
        {
            mMinimum = min;
            mMaximum = max;
        }

        /**
         * Processes one keypress.
         */
        void keyPressed(gcn::KeyEvent &keyEvent) override;

        /**
         * Set the minimum value for a range
         */
        void setMinimum(const int min)
        { mMinimum = min; }

        /**
         * Set the maximum value for a range
         */
        void setMaximum(const int max)
        { mMaximum = max; }

        /**
         * Return the value for a numeric field
         */
        int getValue() const A_WARN_UNUSED;

        void setSendAlwaysEvents(const bool b)
        { mSendAlwaysEvents = b; }

        void adjustSize();

        void adjustHeight();

        void setCaretPosition(unsigned int position);

        void mousePressed(gcn::MouseEvent &mouseEvent) override final;

        void handlePaste();

        void handleCopy() const;

        void focusGained(const gcn::Event &event) override final;

        void focusLost(const gcn::Event &event) override;

        void moveCaretBack();

        void moveCaretForward();

        void moveCaretWordBack();

        void moveCaretWordForward();

        void caretDelete();

        void caretDeleteToStart();

        void caretDeleteWord();

    protected:
        void drawCaret(Graphics* graphics, int x) override final;

        void fixScroll();

        void fontChanged();

        bool mSendAlwaysEvents;

        bool handleNormalKeys(const int action, bool &consumed);

        void handleCtrlKeys(const int action, bool &consumed);

#ifndef USE_SDL2
        void handleSDLKeys(const int val, bool &consumed);
#endif

        static Skin *mSkin;

    private:
        const gcn::Color *mCaretColor;
        PopupMenu *mPopupMenu;
        static int instances;
        static float mAlpha;
        static ImageRect skin;
        int mMinimum;
        unsigned int mMaximum;
        int mLastEventPaste;
        int mPadding;
        bool mNumeric;
        bool mLoseFocusOnTab;
};

#endif  // GUI_WIDGETS_TEXTFIELD_H