4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Matthias Ettrich
8 * \author Lars Gullik Bjønnes
9 * \author Jean-Marc Lasgouttes
12 * Full author contact details are available in file CREDITS.
21 * LyXLength - Represents latex length measurement
27 SP, ///< Scaled point (65536sp = 1pt) TeX's smallest unit.
28 PT, ///< Point = 1/72.27in = 0.351mm
29 BP, ///< Big point (72bp = 1in), also PostScript point
30 DD, ///< Didot point = 1/72 of a French inch, = 0.376mm
31 MM, ///< Millimeter = 2.845pt
32 PC, ///< Pica = 12pt = 4.218mm
33 CC, ///< Cicero = 12dd = 4.531mm
34 CM, ///< Centimeter = 10mm = 2.371pc
35 IN, ///< Inch = 25.4mm = 72.27pt = 6.022pc
36 EX, ///< Height of a small "x" for the current font.
37 EM, ///< Width of capital "M" in current font.
38 MU, ///< Math unit (18mu = 1em) for positioning in math mode
39 PTW, //< Percent of TextWidth
40 PCW, //< Percent of ColumnWidth
41 PPW, //< Percent of PageWidth
42 PLW, //< Percent of LineWidth
43 PTH, //< Percent of TextHeight // Herbert 2002-05-16
44 PPH, //< Percent of PaperHeight // Herbert 2002-05-16
45 UNIT_NONE ///< no unit
51 LyXLength(double v, LyXLength::UNIT u);
53 /// "data" must be a decimal number, followed by a unit
54 explicit LyXLength(std::string const & data);
56 void swap(LyXLength & rhs)
58 std::swap(val_, rhs.val_);
59 std::swap(unit_, rhs.unit_);
65 LyXLength::UNIT unit() const;
69 void unit(LyXLength::UNIT unit);
74 /// return string representation
75 std::string const asString() const;
76 /// return string representation for LaTeX
77 std::string const asLatexString() const;
78 /// return the on-screen size of this length
79 int inPixels(int text_width, int em_width = 0) const;
80 /// return the on-screen size of this length of an image
83 friend bool isValidLength(std::string const & data, LyXLength * result);
89 LyXLength::UNIT unit_;
93 bool operator==(LyXLength const & l1, LyXLength const & l2);
95 bool operator!=(LyXLength const & l1, LyXLength const & l2);
96 /** If "data" is valid, the length represented by it is
97 stored into "result", if that is not 0. */
98 bool isValidLength(std::string const & data, LyXLength * result = 0);
99 /// return the name of the given unit number
100 char const * stringFromUnit(int unit);
102 #endif // LYXLENGTH_H