diff options
Diffstat (limited to 'graphics/font.h')
| -rw-r--r-- | graphics/font.h | 65 |
1 files changed, 60 insertions, 5 deletions
diff --git a/graphics/font.h b/graphics/font.h index 6819b42f52..35f6792d7f 100644 --- a/graphics/font.h +++ b/graphics/font.h @@ -17,12 +17,15 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * */ #ifndef GRAPHICS_FONT_H #define GRAPHICS_FONT_H #include "common/str.h" +#include "common/ustr.h" +#include "common/rect.h" namespace Common { template<class T> class Array; @@ -70,7 +73,7 @@ public: * @param chr The character to query the width of. * @return The character's width. */ - virtual int getCharWidth(byte chr) const = 0; + virtual int getCharWidth(uint32 chr) const = 0; /** * Query the kerning offset between two characters. @@ -79,13 +82,54 @@ public: * @param right The right character. May be 0. * @return The horizontal displacement. */ - virtual int getKerningOffset(byte left, byte right) const; + virtual int getKerningOffset(uint32 left, uint32 right) const; + + /** + * Calculate the bounding box of a character. It is assumed that + * the character shall be drawn at position (0, 0). + * + * The idea here is that the character might be drawn outside the + * rect (0, 0) to (getCharWidth(chr), getFontHeight()) for some fonts. + * This is common among TTF fonts. + * + * The default implementation simply returns the rect with a width + * of getCharWidth(chr) and height of getFontHeight(). + * + * @param chr The character to draw. + * @return The bounding box of the drawn glyph. + */ + virtual Common::Rect getBoundingBox(uint32 chr) const; + + /** + * Return the bounding box of a string drawn with drawString. + * + * @param x The x position where to start drawing + * @param y The y position where to start drawing + * @param w The width of the text area. This can be 0 to allow for + * obtaining the whole bounding box for a string. Note that this + * does not work with an align different from kTextAlignLeft or + * with useEllipsis. + * @param align The text alignment. This can be used to center a string + * in the given area or to align it to the right. + * @param delatx Offset to the x starting position of the string. + * @param useEllipsis Try to fit the string in the area by inserting an + * ellipsis. Be ware that the default is false for this + * one unlike for drawString! + * @return The actual area where the string is drawn. + */ + Common::Rect getBoundingBox(const Common::String &str, int x = 0, int y = 0, const int w = 0, TextAlign align = kTextAlignLeft, int deltax = 0, bool useEllipsis = false) const; + Common::Rect getBoundingBox(const Common::U32String &str, int x = 0, int y = 0, const int w = 0, TextAlign align = kTextAlignLeft) const; /** * Draw a character at a specific point on a surface. * - * Note that the point describes the top left edge point of the - * character's bounding box. + * Note that the point describes the top left edge point where to draw + * the character. This can be different from top left edge point of the + * character's bounding box! For example, TTF fonts sometimes move + * characters like 't' one (or more) pixels to the left to create better + * visual results. To query the actual bounding box of a character use + * getBoundingBox. + * @see getBoundingBox * * The Font implemenation should take care of not drawing outside of the * specified surface. @@ -96,15 +140,22 @@ public: * @param y The y coordinate where to draw the character. * @param color The color of the character. */ - virtual void drawChar(Surface *dst, byte chr, int x, int y, uint32 color) const = 0; + virtual void drawChar(Surface *dst, uint32 chr, int x, int y, uint32 color) const = 0; // TODO: Add doxygen comments to this void drawString(Surface *dst, const Common::String &str, int x, int y, int w, uint32 color, TextAlign align = kTextAlignLeft, int deltax = 0, bool useEllipsis = true) const; + void drawString(Surface *dst, const Common::U32String &str, int x, int y, int w, uint32 color, TextAlign align = kTextAlignLeft) const; /** * Compute and return the width the string str has when rendered using this font. + * This describes the logical width of the string when drawn at (0, 0). + * This can be different from the actual bounding box of the string. Use + * getBoundingBox when you need the bounding box of a drawn string. + * @see getBoundingBox + * @see drawChar */ int getStringWidth(const Common::String &str) const; + int getStringWidth(const Common::U32String &str) const; /** * Take a text (which may contain newline characters) and word wrap it so that @@ -120,6 +171,10 @@ public: * @return the maximal width of any of the lines added to lines */ int wordWrapText(const Common::String &str, int maxWidth, Common::Array<Common::String> &lines) const; + int wordWrapText(const Common::U32String &str, int maxWidth, Common::Array<Common::U32String> &lines) const; + +private: + Common::String handleEllipsis(const Common::String &str, int w) const; }; } // End of namespace Graphics |