3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Matthias Ettrich
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
9 * \author Angus Leeming
13 * Full author contact details are available in file CREDITS.
18 #include "lyxlength.h"
19 #include "lengthcommon.h"
22 #include "support/lstrings.h"
30 LyXLength::LyXLength()
31 : val_(0), unit_(LyXLength::UNIT_NONE)
35 LyXLength::LyXLength(double v, LyXLength::UNIT u)
40 LyXLength::LyXLength(string const & data)
41 : val_(0), unit_(LyXLength::PT)
45 if (!isValidLength(data, &tmp))
46 return; // should raise an exception
53 string const LyXLength::asString() const
56 buffer << val_ << unit_name[unit_]; // setw?
57 return STRCONV(buffer.str());
61 string const LyXLength::asLatexString() const
66 buffer << abs(static_cast<int>(val_/100)) << '.'
67 << abs(static_cast<int>(val_)%100) << "\\textwidth";
70 buffer << abs(static_cast<int>(val_/100)) << '.'
71 << abs(static_cast<int>(val_)%100) << "\\columnwidth";
74 buffer << abs(static_cast<int>(val_/100)) << '.'
75 << abs(static_cast<int>(val_)%100) << "\\paperwidth";
78 buffer << abs(static_cast<int>(val_/100)) << '.'
79 << abs(static_cast<int>(val_)%100) << "\\linewidth";
82 buffer << abs(static_cast<int>(val_/100)) << '.'
83 << abs(static_cast<int>(val_)%100) << "\\paperheight";
86 buffer << abs(static_cast<int>(val_/100)) << '.'
87 << abs(static_cast<int>(val_)%100) << "\\textheight";
90 buffer << val_ << unit_name[unit_]; // setw?
93 return STRCONV(buffer.str());
97 double LyXLength::value() const
103 LyXLength::UNIT LyXLength::unit() const
109 void LyXLength::value(double v)
115 void LyXLength::unit(LyXLength::UNIT u)
121 bool LyXLength::zero() const
127 bool LyXLength::empty() const
129 return unit_ == LyXLength::UNIT_NONE;
133 int LyXLength::inPixels(int text_width, int em_width_base) const
135 // Zoom factor specified by user in percent
136 double const zoom = lyxrc.zoom / 100.0; // [percent]
138 // DPI setting for monitor: pixels/inch
139 double const dpi = lyxrc.dpi; // screen resolution [pixels/inch]
141 double const em_width = (em_width_base > 0)
143 : 10*(dpi/72.27)*zoom;
144 // A different estimate for em_width is
145 // font_metrics::width('M', LyXFont(LyXFont::ALL_SANE))
146 // but this estimate might not be more accurate as the screen font
147 // is different then the latex font.
149 // Pixel values are scaled so that the ratio
150 // between lengths and font sizes on the screen
151 // is the same as on paper.
154 #warning if you don't care than either call this function differently or let it return negative values and call abs() explicitly when needed (Andre')
161 // Scaled point: sp = 1/65536 pt
162 result = zoom * dpi * val_
163 / (72.27 * 65536); // 4736286.7
166 // Point: 1 pt = 1/72.27 inch
167 result = zoom * dpi * val_
171 // Big point: 1 bp = 1/72 inch
172 result = zoom * dpi * val_
176 // Didot: 1157dd = 1238 pt?
177 result = zoom * dpi * val_
178 / (72.27 / (0.376 * 2.845)); // 67.559735
181 // Millimeter: 1 mm = 1/25.4 inch
182 result = zoom * dpi * val_
186 // Pica: 1 pc = 12 pt
187 result = zoom * dpi * val_
188 / (72.27 / 12); // 6.0225
191 // Cicero: 1 cc = 12 dd
192 result = zoom * dpi * val_
193 / (72.27 / (12 * 0.376 * 2.845)); // 5.6299779
196 // Centimeter: 1 cm = 1/2.54 inch
197 result = zoom * dpi * val_
202 result = zoom * dpi * val_;
205 // Ex: The height of an "x"
206 // 0.4305 is the ration between 1ex and 1em in cmr10
207 result = val_ * em_width * 0.4305;
210 // Em: The width of an "m"
211 result = val_ * em_width;
214 // math unit = 1/18em
215 result = val_ * em_width / 18;
217 case LyXLength::PCW: // Always % of workarea
220 result = val_ * text_width / 100;
223 // paperwidth/textwidth is 1.7 for A4 paper with default margins
224 result = val_ * text_width * 1.7 / 100;
227 result = val_ * text_width * 1.787 / 100;
230 result = val_ * text_width * 2.2 / 100;
232 case LyXLength::UNIT_NONE:
233 result = 0; // this cannot happen
236 return static_cast<int>(result + ((result >= 0) ? 0.5 : -0.5));
240 int LyXLength::inBP() const
242 // return any LyXLength value as a one with
243 // the PostScript point, called bp (big points)
248 result = val_ * 28.346;
252 result = val_ * 2.8346;
256 result = val_ * 72.0;
259 // no other than bp possible
263 return static_cast<int>(result + 0.5);
267 bool operator==(LyXLength const & l1, LyXLength const & l2)
269 return l1.value() == l2.value() && l1.unit() == l2.unit();
273 bool operator!=(LyXLength const & l1, LyXLength const & l2)