textbox.hpp

// SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause
// SPDX-FileCopyrightText: 2004 - 2008 Olof Naessén and Per Larsson
// SPDX-FileCopyrightText: 2013 - 2026 Fifengine contributors
 
#ifndef INCLUDE_FIFECHAN_WIDGETS_TEXTBOX_HPP_
#define INCLUDE_FIFECHAN_WIDGETS_TEXTBOX_HPP_
 
#include <ctime>
#include <string>
#include <vector>
 
#include "fifechan/keylistener.hpp"
#include "fifechan/mouselistener.hpp"
#include "fifechan/platform.hpp"
#include "fifechan/widget.hpp"
 
namespace fcn
{
    class Text;
    class UTF8StringEditor;

    class FIFEGUI_API TextBox : public Widget, public MouseListener, public KeyListener
    {
    public:
        explicit TextBox(std::string const & text = "");
 
        TextBox(TextBox const &)            = delete;
        TextBox& operator=(TextBox const &) = delete;
        TextBox(TextBox&&)                  = delete;
        TextBox& operator=(TextBox&&)       = delete;
 
        ~TextBox() override;

        void setText(std::string const & text);

        std::string getText() const;

        std::string getTextRow(int row) const;

        void setTextRow(int row, std::string const & text);

        unsigned int getNumberOfRows() const;

        unsigned int getCaretPosition() const;

        void setCaretPosition(unsigned int position);

        unsigned int getCaretRow() const;

        void setCaretRow(int row);

        unsigned int getCaretColumn() const;

        void setCaretColumn(int column);

        void setCaretRowColumn(int row, int column);

        virtual void scrollToCaret();

        bool isEditable() const;

        void setEditable(bool editable);

        virtual void addRow(std::string const & row);

        bool isOpaque() const;

        void setOpaque(bool opaque);
 
        // Inherited from Widget
 
        void draw(Graphics* graphics) override;
 
        void fontChanged() override;
 
        using Widget::resizeToContent;
 
        void resizeToContent(bool recursion) override;
        void adjustSize() override;
 
        // Inherited from KeyListener
 
        void keyPressed(KeyEvent& keyEvent) override;
 
        // Inherited from MouseListener
 
        void mousePressed(MouseEvent& mouseEvent) override;
 
        void mouseDragged(MouseEvent& mouseEvent) override;
 
    protected:
        void adjustSizeImpl();

        void setCaretColumnUTF8(int column);

        void setCaretRowUTF8(int row);

        void setCaretRowColumnUTF8(int row, int column);

        virtual void drawCaret(Graphics* graphics, int x, int y);

        Text* mText;

        bool mEditable{true};

        bool mOpaque{true};

        UTF8StringEditor* mStringEditor;
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_WIDGETS_TEXTBOX_HPP_