text.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_TEXT_HPP_
#define INCLUDE_FIFECHAN_TEXT_HPP_
 
// Standard library includes
#include <string>
#include <vector>
 
// Platform config include
#include "fifechan/platform.hpp"
 
// Project headers (subdirs before local)
#include "fifechan/rectangle.hpp"
 
namespace fcn
{
    class Font;

    class FIFEGUI_API Text
    {
        public:
            Text();

            explicit Text(std::string const & content);

            virtual ~Text();

            Text(Text const &) = default;

            Text& operator=(Text const &) = default;

            Text(Text&&) = default;

            Text& operator=(Text&&) = default;

            virtual void setContent(std::string const & content);

            virtual std::string getContent() const;

            virtual void setRow(unsigned int row, std::string const & content);

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

            virtual void insertRow(std::string const & row, unsigned int position);

            virtual void eraseRow(unsigned int row);

            virtual std::string& getRow(unsigned int row);

            virtual void insert(int character);

            virtual void remove(int numberOfCharacters);

            virtual int getCaretPosition() const;

            virtual void setCaretPosition(int position);

            virtual void setCaretPosition(int x, int y, Font* font);

            virtual int getCaretColumn() const;

            virtual int getCaretRow() const;

            virtual void setCaretColumn(int column);

            virtual void setCaretRow(int row);

            virtual int getCaretX(Font* font) const;

            virtual int getCaretY(Font* font) const;

            virtual Rectangle getDimension(Font* font) const;

            virtual Rectangle getCaretDimension(Font* font) const;

            virtual int getWidth(int row, Font* font) const;

            virtual unsigned int getMaximumCaretRow() const;

            virtual unsigned int getMaximumCaretRow(unsigned int row) const;

            virtual unsigned int getNumberOfRows() const;

            virtual unsigned int getNumberOfCharacters() const;

            virtual unsigned int getNumberOfCharacters(unsigned int row) const;
 
        protected:
            void calculateCaretPositionFromRowAndColumn();

            std::vector<std::string> mRows;

            unsigned int mCaretPosition{0};

            unsigned int mCaretRow{0};

            unsigned int mCaretColumn{0};
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_TEXT_HPP_