Correct white space.

[features.git] / src / frontends / FontMetrics.h

diff --git a/src/frontends/FontMetrics.h b/src/frontends/FontMetrics.h
index 0807a22dbb232774ef028313cad194afa6b35ed0..b78bc2dbcd083c6c62443133173bf7b3c5809e5e 100644 (file)
--- a/src/frontends/FontMetrics.h
+++ b/src/frontends/FontMetrics.h
@@ -16,6 +16,8 @@
 
 #include "support/strfwd.h"
 
+#include <vector>
+
 /**
  * A class holding helper functions for determining
  * the screen dimensions of fonts.
@@ -77,21 +79,33 @@ public:
        virtual int strikeoutPos() const = 0;
        /// return true if font is not upright (italic or oblique)
        virtual bool italic() const = 0;
+       /// return slope for italic font
+       virtual double italicSlope() const = 0;
 
-       /// return the width of the char in the font
-       virtual int width(char_type c) const = 0;
        /// return the ascent of the char in the font
        virtual int ascent(char_type c) const = 0;
        /// return the descent of the char in the font
        virtual int descent(char_type c) const = 0;
+       /// return the maximum height of the font
+       inline int maxHeight() const { return maxAscent() + maxDescent(); }
+       /// return the height of the char in the font
+       inline int height(char_type c) const { return ascent(c) + descent(c); }
+
        /// return the left bearing of the char in the font
        virtual int lbearing(char_type c) const = 0;
        /// return the right bearing of the char in the font
        virtual int rbearing(char_type c) const = 0;
+       /// return the width of the char in the font
+       virtual int width(char_type c) const = 0;
        /// return the width of the string in the font
        virtual int width(docstring const & s) const = 0;
        /// FIXME ??
        virtual int signedWidth(docstring const & s) const = 0;
+       /// return the inner width of the char in the font
+       inline int center(char_type c) const {
+               return (rbearing(c) - lbearing(c)) / 2;
+       }
+
        /**
         * return the x offset of a position in the string. The
         * direction of the string is forced, and the returned value
@@ -109,14 +123,27 @@ public:
         * \param ws is the amount of extra inter-word space applied text justification.
         */
        virtual int x2pos(docstring const & s, int & x, bool rtl, double ws) const = 0;
+
+       // The places where to break a string and the width of the resulting lines.
+       struct Break {
+               Break(int l, int w) : len(l), wid(w) {}
+               int len = 0;
+               int wid = 0;
+       };
+       typedef std::vector<Break> Breaks;
        /**
-        * Break string at width at most x.
-        * \return true if successful
-        * \param rtl is true for right-to-left layout
+        * Break a string in multiple fragments according to width limits.
+        * \return a sequence of Break elements.
+        * \param s is the string to break.
+        * \param first_wid is the available width for first line.
+        * \param wid is the available width for the next lines.
+        * \param rtl is true for right-to-left layout.
         * \param force is false for breaking at word separator, true for
         *   arbitrary position.
         */
-       virtual bool breakAt(docstring & s, int & x, bool rtl, bool force) const = 0;
+       virtual Breaks
+       breakString(docstring const & s, int first_wid, int wid, bool rtl, bool force) const = 0;
+
        /// return char dimension for the font.
        virtual Dimension const dimension(char_type c) const = 0;
        /**
@@ -137,17 +164,6 @@ public:
                int & ascent,
                int & descent) const = 0;
 
-       /// return the maximum descent of the font
-       inline int maxHeight() const { return maxAscent() + maxDescent(); }
-
-       /// return the descent of the char in the font
-       inline int height(char_type c) const { return ascent(c) + descent(c); }
-
-       /// return the inner width of the char in the font
-       inline int center(char_type c) const {
-               return (rbearing(c) - lbearing(c)) / 2;
-       }
-
        /// return the number of expanding characters taken into account for
        /// increased inter-word spacing during justification
        virtual int countExpanders(docstring const & str) const = 0;