ifont.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_IFONT_H
#define FIFE_IFONT_H

// Standard C++ library includes
#include <string>

// Platform specific includes

// 3rd party library includes
#include <SDL.h>

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder

namespace FIFE {
    class Image;

    class IFont {
    public:
        virtual ~IFont() {}

        virtual void setRowSpacing (int32_t spacing) = 0;

        virtual int32_t getRowSpacing() const = 0;

        virtual void setGlyphSpacing(int32_t spacing) = 0;

        virtual int32_t getGlyphSpacing() const = 0;

        virtual void setAntiAlias(bool antiAlias) = 0;

        virtual bool isAntiAlias() const = 0;

        virtual void setBoldStyle(bool style) = 0;

        virtual bool isBoldStyle() const = 0;

        virtual void setItalicStyle(bool style) = 0;

        virtual bool isItalicStyle() const = 0;

        virtual void setUnderlineStyle(bool style) = 0;

        virtual bool isUnderlineStyle() const = 0;

        virtual void setStrikethroughStyle(bool style) = 0;

        virtual bool isStrikethroughStyle() const = 0;

        virtual void setDynamicColoring(bool coloring) = 0;

        virtual bool isDynamicColoring() const = 0;

        virtual int32_t getStringIndexAt(const std::string &text, int32_t x) const = 0;

        virtual Image* getAsImage(const std::string& text) = 0;

        virtual Image* getAsImageMultiline(const std::string& text) = 0;

        virtual std::string splitTextToWidth (const std::string& text, int32_t render_width) = 0;

        virtual void setColor(uint8_t r,uint8_t g,uint8_t b, uint8_t a = 255) = 0;

        virtual SDL_Color getColor() const = 0;

        virtual int32_t getWidth(const std::string& text) const = 0;

        virtual int32_t getHeight() const = 0;

        virtual void invalidate() = 0;
    };
}

#endif