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.
18 #include "support/strfwd.h"
23 // Solaris/x86 version 9 and earlier define these
27 /////////////////////////////////////////////////////////////////////
31 /////////////////////////////////////////////////////////////////////
35 * Length - Represents latex length measurement
41 BP, ///< Big point (72bp = 1in), also PostScript point
42 CC, ///< Cicero = 12dd = 4.531mm
43 CM, ///< Centimeter = 10mm = 2.371pc
44 DD, ///< Didot point = 1/72 of a French inch, = 0.376mm
45 EM, ///< Width of capital "M" in current font.
46 EX, ///< Height of a small "x" for the current font.
47 IN, ///< Inch = 25.4mm = 72.27pt = 6.022pc
48 MM, ///< Millimeter = 2.845pt
49 MU, ///< Math unit (18mu = 1em) for positioning in math mode
50 PC, ///< Pica = 12pt = 4.218mm
51 PT, ///< Point = 1/72.27in = 0.351mm
52 SP, ///< Scaled point (65536sp = 1pt) TeX's smallest unit.
53 PTW, //< Percent of TextWidth
54 PCW, //< Percent of ColumnWidth
55 PPW, //< Percent of PageWidth
56 PLW, //< Percent of LineWidth
57 PTH, //< Percent of TextHeight // Herbert 2002-05-16
58 PPH, //< Percent of PaperHeight // Herbert 2002-05-16
59 UNIT_NONE ///< no unit
65 Length(double v, Length::UNIT u);
67 /// "data" must be a decimal number, followed by a unit
68 explicit Length(std::string const & data);
73 Length::UNIT unit() const;
77 void unit(Length::UNIT unit);
82 /// return string representation
83 std::string const asString() const;
84 /// return string representation
85 docstring const asDocstring() const;
86 /// return string representation for LaTeX
87 std::string const asLatexString() const;
88 /// return string representation for HTML
89 std::string const asHTMLString() const;
90 /// return the on-screen size of this length
91 int inPixels(int text_width, int em_width = 0) const;
92 /// return the value in Big Postscript points.
95 /// return the default unit (centimeter or inch)
96 static UNIT defaultUnit();
98 friend bool isValidLength(std::string const & data, Length * result);
108 bool operator==(Length const & l1, Length const & l2);
110 bool operator!=(Length const & l1, Length const & l2);
111 /** Test whether \p data represents a valid length.
113 * \returns whether \p data is a valid length
114 * \param data Length in LyX format. Since the only difference between LyX
115 * and LaTeX format is the representation of length variables as units (e.g.
116 * \c text% vs. \c \\textwidth) you can actually use this function as well
117 * for testing LaTeX lengths as long as they only contain real units like pt.
118 * \param result Pointer to a Length variable. If \p result is not 0 and
119 * \p data is valid, the length represented by it is stored into \p result.
121 bool isValidLength(std::string const & data, Length * result = 0);
122 /// return the LyX name of the given unit number
123 char const * stringFromUnit(int unit);
126 /////////////////////////////////////////////////////////////////////
130 /////////////////////////////////////////////////////////////////////
137 explicit GlueLength(Length const & len);
139 GlueLength(Length const & len,
141 Length const & minus);
143 /** "data" must be a decimal number, followed by a unit, and
144 optional "glue" indicated by "+" and "-". You may abbreviate
145 reasonably. Examples:
146 1.2 cm // 4mm +2pt // 2cm -4mm +2mm // 4+0.1-0.2cm
147 The traditional Latex format is also accepted, like
148 4cm plus 10pt minus 10pt */
149 explicit GlueLength(std::string const & data);
152 Length const & len() const;
154 Length const & plus() const;
156 Length const & minus() const;
160 std::string const asString() const;
162 std::string const asLatexString() const;
164 friend bool isValidGlueLength(std::string const & data,
177 bool operator==(GlueLength const & l1, GlueLength const & l2);
179 bool operator!=(GlueLength const & l1, GlueLength const & l2);
180 /** If "data" is valid, the length represented by it is
181 stored into "result", if that is not 0. */
182 bool isValidGlueLength(std::string const & data, GlueLength * result = 0);
184 /// the number of units possible
185 extern int const num_units;
188 * array of unit names
190 * FIXME: I am not sure if "mu" should be possible to select (Lgb)
192 extern char const * const unit_name[];
193 extern char const * const unit_name_gui[];
195 /// return the unit given a string representation such as "cm"
196 Length::UNIT unitFromString(std::string const & data);