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"
23 #include "support/std_sstream.h"
26 using std::ostringstream;
29 LyXLength::LyXLength()
30 : val_(0), unit_(LyXLength::UNIT_NONE)
34 LyXLength::LyXLength(double v, LyXLength::UNIT u)
39 LyXLength::LyXLength(string const & data)
40 : val_(0), unit_(LyXLength::PT)
44 if (!isValidLength(data, &tmp))
45 return; // should raise an exception
52 string const LyXLength::asString() const
55 buffer << val_ << unit_name[unit_]; // setw?
56 return STRCONV(buffer.str());
60 string const LyXLength::asLatexString() const
65 buffer << abs(static_cast<int>(val_/100)) << '.'
66 << abs(static_cast<int>(val_)%100) << "\\textwidth";
69 buffer << abs(static_cast<int>(val_/100)) << '.'
70 << abs(static_cast<int>(val_)%100) << "\\columnwidth";
73 buffer << abs(static_cast<int>(val_/100)) << '.'
74 << abs(static_cast<int>(val_)%100) << "\\paperwidth";
77 buffer << abs(static_cast<int>(val_/100)) << '.'
78 << abs(static_cast<int>(val_)%100) << "\\linewidth";
81 buffer << abs(static_cast<int>(val_/100)) << '.'
82 << abs(static_cast<int>(val_)%100) << "\\paperheight";
85 buffer << abs(static_cast<int>(val_/100)) << '.'
86 << abs(static_cast<int>(val_)%100) << "\\textheight";
89 buffer << val_ << unit_name[unit_]; // setw?
92 return STRCONV(buffer.str());
96 double LyXLength::value() const
102 LyXLength::UNIT LyXLength::unit() const
108 void LyXLength::value(double v)
114 void LyXLength::unit(LyXLength::UNIT u)
120 bool LyXLength::zero() const
126 bool LyXLength::empty() const
128 return unit_ == LyXLength::UNIT_NONE;
132 int LyXLength::inPixels(int text_width, int em_width_base) const
134 // Zoom factor specified by user in percent
135 double const zoom = lyxrc.zoom / 100.0; // [percent]
137 // DPI setting for monitor: pixels/inch
138 double const dpi = lyxrc.dpi; // screen resolution [pixels/inch]
140 double const em_width = (em_width_base > 0)
142 : 10*(dpi/72.27)*zoom;
143 // A different estimate for em_width is
144 // font_metrics::width('M', LyXFont(LyXFont::ALL_SANE))
145 // but this estimate might not be more accurate as the screen font
146 // is different then the latex font.
148 // Pixel values are scaled so that the ratio
149 // between lengths and font sizes on the screen
150 // is the same as on paper.
153 #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')
160 // Scaled point: sp = 1/65536 pt
161 result = zoom * dpi * val_
162 / (72.27 * 65536); // 4736286.7
165 // Point: 1 pt = 1/72.27 inch
166 result = zoom * dpi * val_
170 // Big point: 1 bp = 1/72 inch
171 result = zoom * dpi * val_
175 // Didot: 1157dd = 1238 pt?
176 result = zoom * dpi * val_
177 / (72.27 / (0.376 * 2.845)); // 67.559735
180 // Millimeter: 1 mm = 1/25.4 inch
181 result = zoom * dpi * val_
185 // Pica: 1 pc = 12 pt
186 result = zoom * dpi * val_
187 / (72.27 / 12); // 6.0225
190 // Cicero: 1 cc = 12 dd
191 result = zoom * dpi * val_
192 / (72.27 / (12 * 0.376 * 2.845)); // 5.6299779
195 // Centimeter: 1 cm = 1/2.54 inch
196 result = zoom * dpi * val_
201 result = zoom * dpi * val_;
204 // Ex: The height of an "x"
205 // 0.4305 is the ration between 1ex and 1em in cmr10
206 result = val_ * em_width * 0.4305;
209 // Em: The width of an "m"
210 result = val_ * em_width;
213 // math unit = 1/18em
214 result = val_ * em_width / 18;
216 case LyXLength::PCW: // Always % of workarea
219 result = val_ * text_width / 100;
222 // paperwidth/textwidth is 1.7 for A4 paper with default margins
223 result = val_ * text_width * 1.7 / 100;
226 result = val_ * text_width * 1.787 / 100;
229 result = val_ * text_width * 2.2 / 100;
231 case LyXLength::UNIT_NONE:
232 result = 0; // this cannot happen
235 return static_cast<int>(result + ((result >= 0) ? 0.5 : -0.5));
239 int LyXLength::inBP() const
241 // return any LyXLength value as a one with
242 // the PostScript point, called bp (big points)
247 result = val_ * 28.346;
251 result = val_ * 2.8346;
255 result = val_ * 72.0;
258 // no other than bp possible
262 return static_cast<int>(result + 0.5);
266 bool operator==(LyXLength const & l1, LyXLength const & l2)
268 return l1.value() == l2.value() && l1.unit() == l2.unit();
272 bool operator!=(LyXLength const & l1, LyXLength const & l2)