2 * \file InsetGraphicsParams.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
14 #include "InsetGraphicsParams.h"
17 #include "LyX.h" // for use_gui
21 #include "graphics/epstools.h"
22 #include "graphics/GraphicsTypes.h"
24 #include "support/convert.h"
25 #include "support/debug.h"
26 #include "support/lyxlib.h"
27 #include "support/lstrings.h"
28 #include "support/Translator.h"
33 using namespace lyx::support;
38 InsetGraphicsParams::InsetGraphicsParams()
44 InsetGraphicsParams::InsetGraphicsParams(InsetGraphicsParams const & igp)
46 // I decided to skip the initialization since the copy will overwrite
53 InsetGraphicsParams & InsetGraphicsParams::operator=(InsetGraphicsParams const & params)
55 // Are we assigning the object into itself?
63 void InsetGraphicsParams::init()
66 lyxscale = 100; // lyx scaling in percentage
67 display = true; // may be overriden by display mode in preferences
68 scale = string("100"); // output scaling in percentage
71 keepAspectRatio = false; // for LaTeX output
72 draft = false; // draft mode
73 scaleBeforeRotation = false; // scale image before rotating
75 bbox = graphics::BoundingBox(); // bounding box
76 clip = false; // clip image
78 rotateAngle = "0"; // angle of rotation in degrees
79 rotateOrigin.erase(); // Origin of rotation
80 special.erase(); // additional userdefined stuff
85 void InsetGraphicsParams::copy(InsetGraphicsParams const & igp)
87 filename = igp.filename;
88 lyxscale = igp.lyxscale;
89 display = igp.display;
93 keepAspectRatio = igp.keepAspectRatio;
95 scaleBeforeRotation = igp.scaleBeforeRotation;
100 rotateAngle = igp.rotateAngle;
101 rotateOrigin = igp.rotateOrigin;
102 special = igp.special;
103 groupId = igp.groupId;
107 bool operator==(InsetGraphicsParams const & left,
108 InsetGraphicsParams const & right)
110 return left.filename == right.filename &&
111 left.lyxscale == right.lyxscale &&
112 left.display == right.display &&
113 left.scale == right.scale &&
114 left.width == right.width &&
115 left.height == right.height &&
116 left.keepAspectRatio == right.keepAspectRatio &&
117 left.draft == right.draft &&
118 left.scaleBeforeRotation == right.scaleBeforeRotation &&
120 left.bbox == right.bbox &&
121 left.clip == right.clip &&
123 left.rotateAngle == right.rotateAngle &&
124 left.rotateOrigin == right.rotateOrigin &&
125 left.special == right.special &&
126 left.groupId == right.groupId;
130 bool operator!=(InsetGraphicsParams const & left,
131 InsetGraphicsParams const & right)
133 return !(left == right);
137 void InsetGraphicsParams::Write(ostream & os, Buffer const & buffer) const
139 // Do not write the default values
140 if (!filename.empty())
141 os << "\tfilename " << filename.outputFileName(buffer.filePath()) << '\n';
143 os << "\tlyxscale " << lyxscale << '\n';
145 os << "\tdisplay false\n";
146 if (!scale.empty() && !float_equal(convert<double>(scale), 0.0, 0.05)) {
147 if (!float_equal(convert<double>(scale), 100.0, 0.05))
148 os << "\tscale " << scale << '\n';
151 os << "\twidth " << width.asString() << '\n';
153 os << "\theight " << height.asString() << '\n';
157 os << "\tkeepAspectRatio\n";
158 if (draft) // draft mode
160 if (scaleBeforeRotation)
161 os << "\tscaleBeforeRotation\n";
163 if (!bbox.empty()) // bounding box
164 os << "\tBoundingBox " << bbox << '\n';
165 if (clip) // clip image
168 if (!rotateAngle.empty()
169 && !float_equal(convert<double>(rotateAngle), 0.0, 0.001))
170 os << "\trotateAngle " << rotateAngle << '\n';
171 if (!rotateOrigin.empty())
172 os << "\trotateOrigin " << rotateOrigin << '\n';
173 if (!special.empty())
174 os << "\tspecial " << special << '\n';
175 if (!groupId.empty())
176 os << "\tgroupId "<< groupId << '\n';
180 bool InsetGraphicsParams::Read(Lexer & lex, string const & token,
181 Buffer const & buf, bool allowOrigin)
183 if (token == "filename") {
186 filename = buf.getReferencedFileName(lex.getString());
188 filename.set(lex.getString(), buf.filePath());
189 } else if (token == "lyxscale") {
191 lyxscale = lex.getInteger();
192 } else if (token == "display") {
194 display = lex.getString() != "false";
195 } else if (token == "scale") {
197 scale = lex.getString();
198 } else if (token == "width") {
200 width = Length(lex.getString());
202 } else if (token == "height") {
204 height = Length(lex.getString());
206 } else if (token == "keepAspectRatio") {
207 keepAspectRatio = true;
208 } else if (token == "draft") {
210 } else if (token == "scaleBeforeRotation") {
211 scaleBeforeRotation = true;
212 } else if (token == "BoundingBox") {
214 bbox.xl = Length(lex.getString());
216 bbox.yb = Length(lex.getString());
218 bbox.xr = Length(lex.getString());
220 bbox.yt = Length(lex.getString());
221 } else if (token == "clip") {
223 } else if (token == "rotateAngle") {
225 rotateAngle = lex.getString();
226 } else if (token == "rotateOrigin") {
228 rotateOrigin=lex.getString();
229 } else if (token == "special") {
231 special = lex.getString();
232 } else if (token == "groupId") {
234 groupId = lex.getString();
236 // catch and ignore following two old-format tokens and their arguments.
237 // e.g. "size_kind scale" clashes with the setting of the
238 // "scale <value>" keyword.
239 } else if (token == "size_kind" || token == "lyxsize_kind") {
244 // If it's none of the above, it's not ours.
251 graphics::Params InsetGraphicsParams::as_grfxParams() const
253 graphics::Params pars;
254 pars.filename = filename;
255 pars.scale = lyxscale;
256 pars.angle = convert<double>(rotateAngle);
261 // Get the original Bounding Box from the file
262 string const tmp = graphics::readBB_from_PSFile(filename);
263 LYXERR(Debug::GRAPHICS, "BB_from_File: " << tmp);
265 unsigned int const bb_orig_xl = convert<unsigned int>(token(tmp, ' ', 0));
266 unsigned int const bb_orig_yb = convert<unsigned int>(token(tmp, ' ', 1));
268 // new pars.bb values must be >= zero
269 if (pars.bb.xl.inBP() > static_cast<int>(bb_orig_xl))
270 pars.bb.xl = Length(pars.bb.xl.inBP() - bb_orig_xl, Length::BP);
272 pars.bb.xl = Length();
274 if (pars.bb.xr.inBP() > static_cast<int>(bb_orig_xl))
275 pars.bb.xr = Length(pars.bb.xr.inBP() - bb_orig_xl, Length::BP);
277 pars.bb.xr = Length();
279 if (pars.bb.yb.inBP() > static_cast<int>(bb_orig_yb))
280 pars.bb.yb = Length(pars.bb.yb.inBP() - bb_orig_yb, Length::BP);
282 pars.bb.yb = Length();
284 if (pars.bb.yt.inBP() > static_cast<int>(bb_orig_yb))
285 pars.bb.yt = Length(pars.bb.yt.inBP() - bb_orig_yb, Length::BP);
287 pars.bb.yt = Length();
291 if (pars.bb.xr.inBP() < pars.bb.xl.inBP()
292 || pars.bb.yt.inBP() < pars.bb.yb.inBP()) {
293 pars.bb.xl = Length();
294 pars.bb.xr = Length();
295 pars.bb.yb = Length();
296 pars.bb.yt = Length();
300 pars.display = display;
302 // Override the above if we're not using a gui
304 pars.display = false;