textbox.h

Go to the documentation of this file.

/*
 *  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_TEXTBOX_H
#define GUI_WIDGETS_TEXTBOX_H
 
#include "gui/widgets/widget.h"
 
#include "enums/simpletypes/opaque.h"
 
#include "listeners/keylistener.h"
#include "listeners/mouselistener.h"
 
#include "localconsts.h"
 
class TextBox final : public Widget,
                      public MouseListener,
                      public KeyListener
{
    public:
        explicit TextBox(const Widget2 *const widget);
 
        A_DELETE_COPY(TextBox)
 
        ~TextBox() override final;
 
        void setTextWrapped(const std::string &text, const int minDimension);
 
        int getMinWidth() const noexcept2 A_WARN_UNUSED
        { return mMinWidth; }
 
        void keyPressed(KeyEvent& event) override final;
 
        void draw(Graphics *const graphics) override final A_NONNULL(2);
 
        void safeDraw(Graphics *const graphics) override final A_NONNULL(2);
 
        void setForegroundColor(const Color &color);
 
        void setForegroundColorAll(const Color &color1,
                                   const Color &color2);
 
        void setText(const std::string& text);
 
        std::string getText() const;
 
        const std::string& getTextRow(const int row) const
        { return mTextRows[row]; }
 
        void setTextRow(const int row, const std::string& text);
 
        unsigned int getNumberOfRows() const
        { return CAST_S32(mTextRows.size()); }
 
        unsigned int getCaretPosition() const;
 
        void setCaretPosition(unsigned int position);
 
        unsigned int getCaretRow() const
        { return mCaretRow; }
 
        void setCaretRow(const int row);
 
        unsigned int getCaretColumn() const;
 
        void setCaretColumn(const int column);
 
        void setCaretRowColumn(const int row, const int column);
 
        void scrollToCaret();
 
        bool isEditable() const
        { return mEditable; }
 
        void setEditable(const bool editable);
 
        void addRow(const std::string &row);
 
        bool isOpaque() const noexcept2
        { return mOpaque == Opaque_true; }
 
        void setOpaque(const Opaque opaque) noexcept2
        { mOpaque = opaque; }
 
        void fontChanged() override final
        { adjustSize(); }
 
        void mousePressed(MouseEvent& event) override final;
 
        void mouseDragged(MouseEvent& event) override final;
 
    private:
        void drawCaret(Graphics *const graphics,
                       const int x,
                       const int y) const A_NONNULL(2);
 
        void adjustSize();
 
        STD_VECTOR<std::string> mTextRows;
 
        int mCaretColumn;
 
        int mCaretRow;
 
        int mMinWidth;
 
        bool mEditable;
 
        Opaque mOpaque;
};
 
#endif  // GUI_WIDGETS_TEXTBOX_H