| 1 |
/*************************************************************************** |
| 2 |
* Copyright (C) 2005-2019 by the FIFE team * |
| 3 |
* http://www.fifengine.net * |
| 4 |
* This file is part of FIFE. * |
| 5 |
* * |
| 6 |
* FIFE is free software; you can redistribute it and/or * |
| 7 |
* modify it under the terms of the GNU Lesser General Public * |
| 8 |
* License as published by the Free Software Foundation; either * |
| 9 |
* version 2.1 of the License, or (at your option) any later version. * |
| 10 |
* * |
| 11 |
* This library is distributed in the hope that it will be useful, * |
| 12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of * |
| 13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * |
| 14 |
* Lesser General Public License for more details. * |
| 15 |
* * |
| 16 |
* You should have received a copy of the GNU Lesser General Public * |
| 17 |
* License along with this library; if not, write to the * |
| 18 |
* Free Software Foundation, Inc., * |
| 19 |
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * |
| 20 |
***************************************************************************/ |
| 21 |
|
| 22 |
#ifndef FIFE_IFONT_H |
| 23 |
#define FIFE_IFONT_H |
| 24 |
|
| 25 |
// Standard C++ library includes |
| 26 |
#include <string> |
| 27 |
|
| 28 |
// Platform specific includes |
| 29 |
|
| 30 |
// 3rd party library includes |
| 31 |
#include <SDL.h> |
| 32 |
|
| 33 |
// FIFE includes |
| 34 |
// These includes are split up in two parts, separated by one empty line |
| 35 |
// First block: files included from the FIFE root src directory |
| 36 |
// Second block: files included from the same folder |
| 37 |
|
| 38 |
namespace FIFE { |
| 39 |
class Image; |
| 40 |
|
| 41 |
/** Pure abstract Font interface |
| 42 |
*/ |
| 43 |
class IFont { |
| 44 |
public: |
| 45 |
virtual ~IFont() {} |
| 46 |
|
| 47 |
/** |
| 48 |
* Sets the spacing between rows in pixels. Default is 0 pixels. |
| 49 |
* The spacing can be negative. |
| 50 |
* |
| 51 |
* @param spacing the spacing in pixels. |
| 52 |
*/ |
| 53 |
virtual void setRowSpacing (int32_t spacing) = 0; |
| 54 |
|
| 55 |
/** |
| 56 |
* Gets the spacing between rows in pixels. |
| 57 |
* |
| 58 |
* @return the spacing. |
| 59 |
*/ |
| 60 |
virtual int32_t getRowSpacing() const = 0; |
| 61 |
|
| 62 |
/** |
| 63 |
* Sets the spacing between letters in pixels. Default is 0 pixels. |
| 64 |
* The spacing can be negative. |
| 65 |
* |
| 66 |
* @param spacing the spacing in pixels. |
| 67 |
*/ |
| 68 |
virtual void setGlyphSpacing(int32_t spacing) = 0; |
| 69 |
|
| 70 |
/** |
| 71 |
* Gets the spacing between letters in pixels. |
| 72 |
* |
| 73 |
* @return the spacing. |
| 74 |
*/ |
| 75 |
virtual int32_t getGlyphSpacing() const = 0; |
| 76 |
|
| 77 |
/** |
| 78 |
* Sets the use of anti aliasing. |
| 79 |
* |
| 80 |
* @param antiAlias true for use of anti aliasing. |
| 81 |
*/ |
| 82 |
virtual void setAntiAlias(bool antiAlias) = 0; |
| 83 |
|
| 84 |
/** |
| 85 |
* Checks if anti aliasing is used. |
| 86 |
* |
| 87 |
* @return true if anti aliasing is used. |
| 88 |
*/ |
| 89 |
virtual bool isAntiAlias() const = 0; |
| 90 |
|
| 91 |
/** |
| 92 |
* Sets the use of bold style. |
| 93 |
* |
| 94 |
* @param stlye True for use of bold style. |
| 95 |
*/ |
| 96 |
virtual void setBoldStyle(bool style) = 0; |
| 97 |
|
| 98 |
/** |
| 99 |
* Checks if bold style is used. |
| 100 |
* |
| 101 |
* @return true if bold style is used. |
| 102 |
*/ |
| 103 |
virtual bool isBoldStyle() const = 0; |
| 104 |
|
| 105 |
/** |
| 106 |
* Sets the use of italic style. |
| 107 |
* |
| 108 |
* @param stlye True for use of italic style. |
| 109 |
*/ |
| 110 |
virtual void setItalicStyle(bool style) = 0; |
| 111 |
|
| 112 |
/** |
| 113 |
* Checks if italic style is used. |
| 114 |
* |
| 115 |
* @return true if italic style is used. |
| 116 |
*/ |
| 117 |
virtual bool isItalicStyle() const = 0; |
| 118 |
|
| 119 |
/** |
| 120 |
* Sets the use of underline style. |
| 121 |
* |
| 122 |
* @param stlye True for use of underline style. |
| 123 |
*/ |
| 124 |
virtual void setUnderlineStyle(bool style) = 0; |
| 125 |
|
| 126 |
/** |
| 127 |
* Checks if underline style is used. |
| 128 |
* |
| 129 |
* @return true if underline style is used. |
| 130 |
*/ |
| 131 |
virtual bool isUnderlineStyle() const = 0; |
| 132 |
|
| 133 |
/** |
| 134 |
* Sets the use of strikethrough style. |
| 135 |
* |
| 136 |
* @param stlye True for use of strikethrough style. |
| 137 |
*/ |
| 138 |
virtual void setStrikethroughStyle(bool style) = 0; |
| 139 |
|
| 140 |
/** |
| 141 |
* Checks if strikethrough style is used. |
| 142 |
* |
| 143 |
* @return true if strikethrough style is used. |
| 144 |
*/ |
| 145 |
virtual bool isStrikethroughStyle() const = 0; |
| 146 |
|
| 147 |
virtual void setDynamicColoring(bool coloring) = 0; |
| 148 |
|
| 149 |
virtual bool isDynamicColoring() const = 0; |
| 150 |
|
| 151 |
virtual int32_t getStringIndexAt(const std::string &text, int32_t x) const = 0; |
| 152 |
|
| 153 |
/** Gets given text as Image |
| 154 |
* The rsulting image is pooled, so it's not that time critical |
| 155 |
*/ |
| 156 |
virtual Image* getAsImage(const std::string& text) = 0; |
| 157 |
|
| 158 |
/** Gets given text as Image. Text is splitted on multiple lines based "\n" marks |
| 159 |
* The rsulting image is pooled, so it's not that time critical |
| 160 |
*/ |
| 161 |
virtual Image* getAsImageMultiline(const std::string& text) = 0; |
| 162 |
|
| 163 |
virtual std::string splitTextToWidth (const std::string& text, int32_t render_width) = 0; |
| 164 |
|
| 165 |
/** Set the color the text should be rendered in |
| 166 |
*/ |
| 167 |
virtual void setColor(uint8_t r,uint8_t g,uint8_t b, uint8_t a = 255) = 0; |
| 168 |
|
| 169 |
/** Get the color the text was rendered in |
| 170 |
*/ |
| 171 |
virtual SDL_Color getColor() const = 0; |
| 172 |
|
| 173 |
/** gets width of given text |
| 174 |
*/ |
| 175 |
virtual int32_t getWidth(const std::string& text) const = 0; |
| 176 |
|
| 177 |
/** gets height of this font |
| 178 |
*/ |
| 179 |
virtual int32_t getHeight() const = 0; |
| 180 |
|
| 181 |
virtual void invalidate() = 0; |
| 182 |
}; |
| 183 |
} |
| 184 |
|
| 185 |
#endif |