FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
ifont.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2017 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 
43  class IFont {
44  public:
45  virtual ~IFont() {}
46 
53  virtual void setRowSpacing (int32_t spacing) = 0;
54 
60  virtual int32_t getRowSpacing() const = 0;
61 
68  virtual void setGlyphSpacing(int32_t spacing) = 0;
69 
75  virtual int32_t getGlyphSpacing() const = 0;
76 
82  virtual void setAntiAlias(bool antiAlias) = 0;
83 
89  virtual bool isAntiAlias() const = 0;
90 
96  virtual void setBoldStyle(bool style) = 0;
97 
103  virtual bool isBoldStyle() const = 0;
104 
110  virtual void setItalicStyle(bool style) = 0;
111 
117  virtual bool isItalicStyle() const = 0;
118 
124  virtual void setUnderlineStyle(bool style) = 0;
125 
131  virtual bool isUnderlineStyle() const = 0;
132 
138  virtual void setStrikethroughStyle(bool style) = 0;
139 
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 
156  virtual Image* getAsImage(const std::string& text) = 0;
157 
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 
167  virtual void setColor(uint8_t r,uint8_t g,uint8_t b, uint8_t a = 255) = 0;
168 
171  virtual SDL_Color getColor() const = 0;
172 
175  virtual int32_t getWidth(const std::string& text) const = 0;
176 
179  virtual int32_t getHeight() const = 0;
180 
181  virtual void invalidate() = 0;
182  };
183 }
184 
185 #endif
virtual void setItalicStyle(bool style)=0
Sets the use of italic style.
virtual bool isDynamicColoring() const =0
Base Class for Images.
Definition: image.h:48
virtual bool isUnderlineStyle() const =0
Checks if underline style is used.
virtual bool isBoldStyle() const =0
Checks if bold style is used.
virtual Image * getAsImage(const std::string &text)=0
Gets given text as Image The rsulting image is pooled, so it&#39;s not that time critical.
virtual Image * getAsImageMultiline(const std::string &text)=0
Gets given text as Image.
virtual void setColor(uint8_t r, uint8_t g, uint8_t b, uint8_t a=255)=0
Set the color the text should be rendered in.
virtual std::string splitTextToWidth(const std::string &text, int32_t render_width)=0
virtual int32_t getRowSpacing() const =0
Gets the spacing between rows in pixels.
virtual bool isStrikethroughStyle() const =0
Checks if strikethrough style is used.
virtual void invalidate()=0
virtual void setUnderlineStyle(bool style)=0
Sets the use of underline style.
virtual SDL_Color getColor() const =0
Get the color the text was rendered in.
virtual ~IFont()
Definition: ifont.h:45
unsigned char uint8_t
Definition: core.h:38
virtual int32_t getStringIndexAt(const std::string &text, int32_t x) const =0
virtual void setStrikethroughStyle(bool style)=0
Sets the use of strikethrough style.
virtual int32_t getHeight() const =0
gets height of this font
virtual void setGlyphSpacing(int32_t spacing)=0
Sets the spacing between letters in pixels.
virtual void setBoldStyle(bool style)=0
Sets the use of bold style.
virtual int32_t getGlyphSpacing() const =0
Gets the spacing between letters in pixels.
virtual bool isAntiAlias() const =0
Checks if anti aliasing is used.
Pure abstract Font interface.
Definition: ifont.h:43
virtual void setRowSpacing(int32_t spacing)=0
Sets the spacing between rows in pixels.
virtual bool isItalicStyle() const =0
Checks if italic style is used.
virtual int32_t getWidth(const std::string &text) const =0
gets width of given text
virtual void setAntiAlias(bool antiAlias)=0
Sets the use of anti aliasing.
virtual void setDynamicColoring(bool coloring)=0