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"
26 using std::ostringstream;
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 os << val_ << unit_name[unit_]; // setw?
61 string const LyXLength::asLatexString() const
66 snprintf(buffer, 78, "%.2f\\textwidth", val_/100.0);
69 snprintf(buffer, 78, "%.2f\\columnwidth", val_/100.0);
72 snprintf(buffer, 78, "%.2f\\paperwidth", val_/100.0);
75 snprintf(buffer, 78, "%.2f\\linewidth", val_/100.0);
78 snprintf(buffer, 78, "%.2f\\paperheight", val_/100.0);
81 snprintf(buffer, 78, "%.2f\\textheight", val_/100.0);
84 snprintf(buffer, 78, "%f%s", val_, unit_name[unit_]);
93 double LyXLength::value() const
99 LyXLength::UNIT LyXLength::unit() const
105 void LyXLength::value(double v)
111 void LyXLength::unit(LyXLength::UNIT u)
117 bool LyXLength::zero() const
123 bool LyXLength::empty() const
125 return unit_ == LyXLength::UNIT_NONE;
129 int LyXLength::inPixels(int text_width, int em_width_base) const
131 // Zoom factor specified by user in percent
132 double const zoom = lyxrc.zoom / 100.0; // [percent]
134 // DPI setting for monitor: pixels/inch
135 double const dpi = lyxrc.dpi; // screen resolution [pixels/inch]
137 double const em_width = (em_width_base > 0)
139 : 10*(dpi/72.27)*zoom;
140 // A different estimate for em_width is
141 // font_metrics::width('M', LyXFont(LyXFont::ALL_SANE))
142 // but this estimate might not be more accurate as the screen font
143 // is different then the latex font.
145 // Pixel values are scaled so that the ratio
146 // between lengths and font sizes on the screen
147 // is the same as on paper.
150 #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')
157 // Scaled point: sp = 1/65536 pt
158 result = zoom * dpi * val_
159 / (72.27 * 65536); // 4736286.7
162 // Point: 1 pt = 1/72.27 inch
163 result = zoom * dpi * val_
167 // Big point: 1 bp = 1/72 inch
168 result = zoom * dpi * val_
172 // Didot: 1157dd = 1238 pt?
173 result = zoom * dpi * val_
174 / (72.27 / (0.376 * 2.845)); // 67.559735
177 // Millimeter: 1 mm = 1/25.4 inch
178 result = zoom * dpi * val_
182 // Pica: 1 pc = 12 pt
183 result = zoom * dpi * val_
184 / (72.27 / 12); // 6.0225
187 // Cicero: 1 cc = 12 dd
188 result = zoom * dpi * val_
189 / (72.27 / (12 * 0.376 * 2.845)); // 5.6299779
192 // Centimeter: 1 cm = 1/2.54 inch
193 result = zoom * dpi * val_
198 result = zoom * dpi * val_;
201 // Ex: The height of an "x"
202 // 0.4305 is the ration between 1ex and 1em in cmr10
203 result = val_ * em_width * 0.4305;
206 // Em: The width of an "m"
207 result = val_ * em_width;
210 // math unit = 1/18em
211 result = val_ * em_width / 18;
213 case LyXLength::PCW: // Always % of workarea
216 result = val_ * text_width / 100;
219 // paperwidth/textwidth is 1.7 for A4 paper with default margins
220 result = val_ * text_width * 1.7 / 100;
223 result = val_ * text_width * 1.787 / 100;
226 result = val_ * text_width * 2.2 / 100;
228 case LyXLength::UNIT_NONE:
229 result = 0; // this cannot happen
232 return static_cast<int>(result + ((result >= 0) ? 0.5 : -0.5));
236 int LyXLength::inBP() const
238 // return any LyXLength value as a one with
239 // the PostScript point, called bp (big points)
244 result = val_ * 28.346;
248 result = val_ * 2.8346;
252 result = val_ * 72.0;
255 // no other than bp possible
259 return static_cast<int>(result + 0.5);
263 bool operator==(LyXLength const & l1, LyXLength const & l2)
265 return l1.value() == l2.value() && l1.unit() == l2.unit();
269 bool operator!=(LyXLength const & l1, LyXLength const & l2)