namespace lyx {
+class MetricsBase;
+
// Solaris/x86 version 9 and earlier define these
#undef PC
#undef SP
public:
/// length units
enum UNIT {
- SP, ///< Scaled point (65536sp = 1pt) TeX's smallest unit.
- PT, ///< Point = 1/72.27in = 0.351mm
BP, ///< Big point (72bp = 1in), also PostScript point
- DD, ///< Didot point = 1/72 of a French inch, = 0.376mm
- MM, ///< Millimeter = 2.845pt
- PC, ///< Pica = 12pt = 4.218mm
CC, ///< Cicero = 12dd = 4.531mm
CM, ///< Centimeter = 10mm = 2.371pc
- IN, ///< Inch = 25.4mm = 72.27pt = 6.022pc
- EX, ///< Height of a small "x" for the current font.
+ DD, ///< Didot point = 1/72 of a French inch, = 0.376mm
EM, ///< Width of capital "M" in current font.
+ EX, ///< Height of a small "x" for the current font.
+ IN, ///< Inch = 25.4mm = 72.27pt = 6.022pc
+ MM, ///< Millimeter = 2.845pt
MU, ///< Math unit (18mu = 1em) for positioning in math mode
+ PC, ///< Pica = 12pt = 4.218mm
+ PT, ///< Point = 1/72.27in = 0.351mm
+ SP, ///< Scaled point (65536sp = 1pt) TeX's smallest unit.
PTW, //< Percent of TextWidth
PCW, //< Percent of ColumnWidth
PPW, //< Percent of PageWidth
PLW, //< Percent of LineWidth
- PTH, //< Percent of TextHeight // Herbert 2002-05-16
- PPH, //< Percent of PaperHeight // Herbert 2002-05-16
+ PTH, //< Percent of TextHeight // Herbert 2002-05-16
+ PPH, //< Percent of PaperHeight // Herbert 2002-05-16
+ BLS, //< Percent of BaselineSkip // uwestoehr 2017-04-01
UNIT_NONE ///< no unit
};
/// "data" must be a decimal number, followed by a unit
explicit Length(std::string const & data);
- ///
- void swap(Length & rhs);
///
double value() const;
///
docstring const asDocstring() const;
/// return string representation for LaTeX
std::string const asLatexString() const;
- /// return the on-screen size of this length
+ /// return string representation for HTML
+ std::string const asHTMLString() const;
+ /** return the on-screen size of this length.
+ *
+ * If the second argument is not provided, then the unit EM will
+ * only be approximated. It is better if possible to use
+ * FontMetrics::em() to get this value.
+ */
int inPixels(int text_width, int em_width = 0) const;
+ /** return the on-screen size of this length
+ *
+ * This version of the function uses the right EM definition.
+ */
+ int inPixels(MetricsBase const &) const;
/// return the value in Big Postscript points.
+ /// Caution: Inaccurate for em, ex, mu and percent units.
int inBP() const;
+ /// return the default unit (centimeter or inch)
+ static UNIT defaultUnit();
+
friend bool isValidLength(std::string const & data, Length * result);
private:
+ /// Convert value to inch for text width and em width given in inch
+ double inInch(double text_width, double em_width) const;
///
double val_;
///