4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * \author Abdelrazak Younes
11 * Full author contact details are available in file CREDITS.
14 #ifndef FONT_METRICS_H
15 #define FONT_METRICS_H
17 #include "support/docstring.h"
20 * A class holding helper functions for determining
21 * the screen dimensions of fonts.
23 * The geometry is the standard typographical geometry,
26 * --------------+------------------<maxAscent
28 * <-------> (right bearing)
32 * origin>____ | oo oo | oo oo
34 * --------------+---ooooo--|--oooo-<baseline
37 * descent>______| oooo |
39 * --------------+----------+-------<maxDescent
41 * Caution: All char_type and docstring arguments of any method of this class
42 * are no UCS4 chars or strings if the font is a symbol font. They simply
43 * denote the code points of the font instead. You have to keep this in mind
44 * when you implement the methods in a frontend. You must not pass these
45 * parameters to a unicode conversion function in particular.
55 virtual ~FontMetrics() {}
57 /// return the maximum ascent of the font
58 virtual int maxAscent() const = 0;
59 /// return the maximum descent of the font
60 virtual int maxDescent() const = 0;
61 /// return the ascent of the char in the font
62 virtual int ascent(char_type c) const = 0;
63 /// return the descent of the char in the font
64 virtual int descent(char_type c) const = 0;
65 /// return the left bearing of the char in the font
66 virtual int lbearing(char_type c) const = 0;
67 /// return the right bearing of the char in the font
68 virtual int rbearing(char_type c) const = 0;
69 /// return the width of the string in the font
70 virtual int width(char_type const * s, size_t n) const = 0;
72 virtual int signedWidth(docstring const & s) const = 0;
74 * fill in width,ascent,descent with the values for the
75 * given string in the font.
77 virtual void rectText(docstring const & str,
80 int & descent) const = 0;
82 * fill in width,ascent,descent with the values for the
83 * given string in the font for a button.
85 virtual void buttonText(docstring const & str,
88 int & descent) const = 0;
90 /// return the maximum descent of the font
91 inline int maxHeight() const {
92 return maxAscent() + maxDescent();
95 /// return the descent of the char in the font
96 inline int height(char_type c) const
98 return ascent(c) + descent(c);
101 /// return the inner width of the char in the font
102 inline int center(char_type c) const {
103 return (rbearing(c) - lbearing(c)) / 2;
106 /// return the width of the char in the font
107 inline int width(char_type c) const
109 char_type tmp[2] = { c, L'\0'};
110 return width(tmp, 1);
113 /// return the width of the string in the font
114 inline int width(docstring const & s) const
116 return s.empty() ? 0 : width(s.data(), s.length());
121 } // namespace frontend
125 /// Implementation is in Application.C
126 frontend::FontMetrics const & theFontMetrics(LyXFont const & f);
130 #endif // FONT_METRICS_H