3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
10 * Full author contact details are available in file CREDITS
16 #include "ControlGraphics.h"
17 #include "FormGraphics.h"
18 #include "forms/form_graphics.h"
20 #include "checkedwidgets.h"
21 #include "input_validators.h"
23 #include "xforms_helpers.h"
25 #include "debug.h" // for lyxerr
26 #include "lyxrc.h" // for lyxrc.display_graphics
28 #include "insets/insetgraphicsParams.h"
30 #include "controllers/helper_funcs.h" // for getStringFromVector
32 #include "frontends/Alert.h"
34 #include "support/tostr.h"
35 #include "support/lstrings.h" // for strToDbl
36 #include "support/lyxlib.h" // for float_equal
37 #include "support/filetools.h" // for MakeAbsPath etc
39 #include "support/BoostFormat.h"
41 #include "lyx_forms.h"
43 using namespace lyx::support;
51 // Bound the number of input characters
52 int const SIZE_MAXDIGITS = 10;
53 int const FILENAME_MAXCHARS = 1024;
55 string defaultUnit("cm");
57 #if FL_VERSION == 0 || (FL_REVISION == 0 && FL_FIXLEVEL < 2)
58 bool const scalableTabfolders = false;
60 bool const scalableTabfolders = true;
66 typedef FormController<ControlGraphics, FormView<FD_graphics> > base_class;
68 FormGraphics::FormGraphics(Dialog & parent)
69 : base_class(parent, _("Graphics"), scalableTabfolders)
73 void FormGraphics::redraw()
75 if (form() && form()->visible)
76 fl_redraw_form(form());
79 FL_FORM * outer_form = fl_get_active_folder(dialog_->tabfolder);
80 if (outer_form && outer_form->visible)
81 fl_redraw_form(outer_form);
85 void FormGraphics::build()
87 dialog_.reset(build_graphics(this));
89 // Manage the ok, apply, restore and cancel/close buttons
90 bcview().setOK(dialog_->button_ok);
91 bcview().setApply(dialog_->button_apply);
92 bcview().setCancel(dialog_->button_close);
93 bcview().setRestore(dialog_->button_restore);
96 file_.reset(build_graphics_file(this));
98 // Disable for read-only documents.
99 bcview().addReadOnly(file_->button_browse);
100 bcview().addReadOnly(file_->check_aspectratio);
101 bcview().addReadOnly(file_->check_draft);
102 bcview().addReadOnly(file_->check_nounzip);
104 // Check validity of "length + unit" input.
105 addCheckedGlueLength(bcview(), file_->input_width);
106 addCheckedGlueLength(bcview(), file_->input_height);
108 // Trigger an input event for cut&paste with middle mouse button.
109 setPrehandler(file_->input_filename);
110 setPrehandler(file_->input_lyxscale);
111 setPrehandler(file_->input_width);
112 setPrehandler(file_->input_height);
114 // Activate ok/apply immediately upon input.
115 fl_set_input_return(file_->input_filename, FL_RETURN_CHANGED);
116 fl_set_input_return(file_->input_lyxscale, FL_RETURN_CHANGED);
117 fl_set_input_return(file_->input_width, FL_RETURN_CHANGED);
118 fl_set_input_return(file_->input_height, FL_RETURN_CHANGED);
120 fl_set_input_maxchars(file_->input_filename, FILENAME_MAXCHARS);
121 fl_set_input_filter(file_->input_lyxscale, fl_unsigned_int_filter);
123 // Width default is scaling: use unsigned float filter.
124 fl_set_input_filter(file_->input_width, fl_unsigned_float_filter);
125 fl_set_input_maxchars(file_->input_height, SIZE_MAXDIGITS);
127 string const display_List =
128 _("Default|Monochrome|Grayscale|Color|Do not display");
129 fl_addto_choice(file_->choice_display, display_List.c_str());
131 string const width_list = bformat(_("Scale%%%%|%1$s"), choice_Length_All);
132 fl_addto_choice(file_->choice_width, width_list.c_str());
134 fl_addto_choice(file_->choice_height, choice_Length_All.c_str());
136 // set up the tooltips for the filesection
137 string str = _("The file you want to insert.");
138 tooltips().init(file_->input_filename, str);
139 str = _("Browse the directories.");
140 tooltips().init(file_->button_browse, str);
142 str = _("Scale the image to inserted percentage value.");
143 tooltips().init(file_->input_lyxscale, str);
144 str = _("Select display mode for this image.");
145 tooltips().init(file_->choice_display, str);
147 str = _("Set the image width to the inserted value.");
148 tooltips().init(file_->input_width, str);
149 // xgettext:no-c-format
150 str = _("Select unit for width; Scale% for scaling whole image.");
151 tooltips().init(file_->choice_width, str);
152 str = _("Set the image height to the inserted value.");
153 tooltips().init(file_->input_height, str);
154 str = _("Select unit for height.");
155 tooltips().init(file_->choice_height, str);
156 str = _("Do not distort the image. "
157 "Keep image within \"width\" by \"height\" and obey "
159 tooltips().init(file_->check_aspectratio, str);
160 str = _("Pass a filename like \"file.eps.gz\" to the LaTeX output. "
161 "Useful when LaTeX should unzip the file. Needs an additional "
162 "file like \"file.eps.bb\" which holds the values for "
163 "the bounding box.");
164 tooltips().init(file_->check_nounzip, str);
165 str = _("Show image only as a rectangle of the original size.");
166 tooltips().init(file_->check_draft, str);
168 // the bounding box selection
169 bbox_.reset(build_graphics_bbox(this));
171 // disable for read-only documents
172 bcview().addReadOnly(bbox_->button_getBB);
173 bcview().addReadOnly(bbox_->check_clip);
175 // check validity of "length + unit" input
176 addCheckedLyXLength(bcview(), bbox_->input_bb_x1, bbox_->text_X);
178 // trigger an input event for cut&paste with middle mouse button.
179 setPrehandler(bbox_->input_bb_x0);
180 setPrehandler(bbox_->input_bb_y0);
181 setPrehandler(bbox_->input_bb_x1);
182 setPrehandler(bbox_->input_bb_y1);
184 // for activate ok/apply immediately upon input
185 fl_set_input_return(bbox_->input_bb_x0, FL_RETURN_CHANGED);
186 fl_set_input_return(bbox_->input_bb_y0, FL_RETURN_CHANGED);
187 fl_set_input_return(bbox_->input_bb_x1, FL_RETURN_CHANGED);
188 fl_set_input_return(bbox_->input_bb_y1, FL_RETURN_CHANGED);
190 fl_set_input_filter(bbox_->input_bb_x0, fl_unsigned_float_filter);
191 fl_set_input_filter(bbox_->input_bb_y0, fl_unsigned_float_filter);
192 fl_set_input_filter(bbox_->input_bb_y1, fl_unsigned_float_filter);
194 string const bb_units = getStringFromVector(frnt::getBBUnits(), "|");
195 fl_addto_choice(bbox_->choice_bb_units, bb_units.c_str());
197 // set up the tooltips for the bounding-box-section
198 str = _("The lower left x-value of the bounding box.");
199 tooltips().init(bbox_->input_bb_x0, str);
200 str = _("The lower left y-value of the bounding box.");
201 tooltips().init(bbox_->input_bb_y0, str);
202 str = _("The upper right x-value of the bounding box; "
203 "only this input field allows length + unit, e.g. 5cm "
204 "and sets the unit for the other input fields.");
205 tooltips().init(bbox_->input_bb_x1, str);
206 str = _("The upper right y-value of the bounding box.");
207 tooltips().init(bbox_->input_bb_y1, str);
208 str = _("Select unit for the bounding box values.");
209 tooltips().init(bbox_->choice_bb_units, str);
211 str = _("Read the image coordinates new from file. For (e)ps-file "
212 "the bounding box is read, otherwise the imagesize in pixels. "
213 "Default unit is \"bp\", the PostScript's b(ig) p(oint).");
214 tooltips().init(bbox_->button_getBB, str);
216 str = _("Clip image to the bounding box values.");
217 tooltips().init(bbox_->check_clip, str);
220 extra_.reset(build_graphics_extra(this));
222 // disable for read-only documents
223 bcview().addReadOnly(extra_->input_rotate_angle);
224 bcview().addReadOnly(extra_->choice_origin);
225 bcview().addReadOnly(extra_->check_subcaption);
226 bcview().addReadOnly(extra_->input_special);
228 // trigger an input event for cut&paste with middle mouse button.
229 setPrehandler(extra_->input_rotate_angle);
230 setPrehandler(extra_->input_subcaption);
231 setPrehandler(extra_->input_special);
233 fl_set_input_return(extra_->input_rotate_angle, FL_RETURN_CHANGED);
234 fl_set_input_return(extra_->input_subcaption, FL_RETURN_CHANGED);
235 fl_set_input_return(extra_->input_special, FL_RETURN_CHANGED);
237 fl_set_input_filter(extra_->input_rotate_angle, fl_float_filter);
239 using namespace frnt;
240 vector<RotationOriginPair> origindata = getRotationOriginData();
242 // Store the identifiers for later
243 origins_ = getSecond(origindata);
245 string const choice = getStringFromVector(getFirst(origindata), "|");
246 fl_addto_choice(extra_->choice_origin, choice.c_str());
248 // set up the tooltips for the extra section
249 str = _("Insert the rotation angle in degrees. "
250 "Positive value rotates anti-clockwise, "
251 "negative value clockwise.");
252 tooltips().init(extra_->input_rotate_angle, str);
253 str = _("Insert the point of origin for rotation.");
254 tooltips().init(extra_->choice_origin, str);
255 str = _("Enables use of subfigure with its own caption.");
256 tooltips().init(extra_->check_subcaption, str);
257 str = _("Insert the optional subfigure caption.");
258 tooltips().init(extra_->input_subcaption, str);
259 str = _("Add any additional LaTeX option, which is defined in the "
260 "graphicx-package and not mentioned in the gui's tabfolders.");
261 tooltips().init(extra_->input_special, str);
263 // Enable the tabfolder to be rescaled correctly.
264 if (scalableTabfolders)
265 fl_set_tabfolder_autofit(dialog_->tabfolder, FL_FIT);
268 fl_addto_tabfolder(dialog_->tabfolder, _("File").c_str(),
270 fl_addto_tabfolder(dialog_->tabfolder, _("Bounding Box").c_str(),
272 fl_addto_tabfolder(dialog_->tabfolder, _("Extra").c_str(),
275 // set the right default unit
276 switch (lyxrc.default_papersize) {
277 case BufferParams::PAPER_DEFAULT: break;
278 case BufferParams::PAPER_USLETTER:
279 case BufferParams::PAPER_LEGALPAPER:
280 case BufferParams::PAPER_EXECUTIVEPAPER: defaultUnit = "in"; break;
281 case BufferParams::PAPER_A3PAPER:
282 case BufferParams::PAPER_A4PAPER:
283 case BufferParams::PAPER_A5PAPER:
284 case BufferParams::PAPER_B5PAPER: defaultUnit = "cm"; break;
289 void FormGraphics::apply()
291 // Create the parameters structure and fill the data from the dialog.
292 InsetGraphicsParams & igp = controller().params();
295 igp.filename = getString(file_->input_filename);
297 igp.lyxscale = strToInt(getString(file_->input_lyxscale));
298 if (igp.lyxscale == 0) {
302 switch (fl_get_choice(file_->choice_display)) {
304 igp.display = grfx::NoDisplay;
307 igp.display = grfx::ColorDisplay;
310 igp.display = grfx::GrayscaleDisplay;
313 igp.display = grfx::MonochromeDisplay;
316 igp.display = grfx::DefaultDisplay;
319 // first item in choice_width means scaling
320 if (fl_get_choice(file_->choice_width) == 1) {
321 igp.scale = strToDbl(getString(file_->input_width));
322 if (float_equal(igp.scale, 0.0, 0.05)) {
325 igp.width = LyXLength();
328 igp.width = LyXLength(getLengthFromWidgets(file_->input_width,
329 file_->choice_width));
331 igp.height = LyXLength(getLengthFromWidgets(file_->input_height,
332 file_->choice_height));
333 igp.keepAspectRatio = fl_get_button(file_->check_aspectratio);
335 igp.draft = fl_get_button(file_->check_draft);
336 igp.noUnzip = fl_get_button(file_->check_nounzip);
339 if (!controller().bbChanged) {
340 // don't write anything
343 // allow length + unit input only for x1 input field
345 if (!getString(bbox_->input_bb_x1).empty()) {
346 x1_str = getLengthFromWidgets(bbox_->input_bb_x1,
347 bbox_->choice_bb_units);
348 LyXLength x1 = LyXLength(x1_str);
349 x1_str = x1.asString();
366 fl_set_choice_text(bbox_->choice_bb_units, unit.c_str());
370 if (getString(bbox_->input_bb_x0).empty())
373 bb = getLengthFromWidgets(bbox_->input_bb_x0,
374 bbox_->choice_bb_units);
378 if (getString(bbox_->input_bb_y0).empty())
381 bb += getLengthFromWidgets(bbox_->input_bb_y0,
382 bbox_->choice_bb_units);
384 bb += ' ' + x1_str + ' ';
386 if (getString(bbox_->input_bb_y1).empty())
389 bb += getLengthFromWidgets(bbox_->input_bb_y1,
390 bbox_->choice_bb_units);
394 igp.clip = fl_get_button(bbox_->check_clip);
397 igp.rotateAngle = strToDbl(getString(extra_->input_rotate_angle));
399 // map angle into -360 (clock-wise) to +360 (counter clock-wise)
400 while (igp.rotateAngle <= -360.0) {
401 igp.rotateAngle += 360.0;
403 while (igp.rotateAngle >= 360.0) {
404 igp.rotateAngle -= 360.0;
406 fl_set_input(extra_->input_rotate_angle, tostr(igp.rotateAngle).c_str());
408 int const origin_pos = fl_get_choice(extra_->choice_origin);
409 if (origin_pos == 0) {
410 igp.rotateOrigin.erase();
412 igp.rotateOrigin = origins_[origin_pos - 1];
415 igp.subcaption = fl_get_button(extra_->check_subcaption);
416 igp.subcaptionText = getString(extra_->input_subcaption);
418 igp.special = getString(extra_->input_special);
422 void FormGraphics::update() {
423 // Update dialog with details from inset
424 InsetGraphicsParams & igp = controller().params();
427 fl_set_input(file_->input_filename, igp.filename.c_str());
428 fl_set_input(file_->input_lyxscale, tostr(igp.lyxscale).c_str());
430 switch (igp.display) {
431 case grfx::NoDisplay:
432 fl_set_choice(file_->choice_display, 5);
434 case grfx::ColorDisplay:
435 fl_set_choice(file_->choice_display, 4);
437 case grfx::GrayscaleDisplay:
438 fl_set_choice(file_->choice_display, 3);
440 case grfx::MonochromeDisplay:
441 fl_set_choice(file_->choice_display, 2);
443 case grfx::DefaultDisplay:
444 fl_set_choice(file_->choice_display, 1);
447 // set width input fields according to scaling or width/height input
448 if (!float_equal(igp.scale, 0.0, 0.05)) {
449 fl_set_input_filter(file_->input_width, fl_unsigned_float_filter);
450 fl_set_input_maxchars(file_->input_width, 0);
451 fl_set_input(file_->input_width, tostr(igp.scale).c_str());
452 fl_set_choice(file_->choice_width, 1);
454 fl_set_input_filter(file_->input_width, NULL);
455 fl_set_input_maxchars(file_->input_width, SIZE_MAXDIGITS);
456 updateWidgetsFromLength(file_->input_width, file_->choice_width,
457 igp.width, defaultUnit);
460 updateWidgetsFromLength(file_->input_height, file_->choice_height,
461 igp.height, defaultUnit);
463 // disable height input in case of scaling
464 bool const disable_height = !float_equal(igp.scale, 0.0, 0.05);
465 setEnabled(file_->input_height, !disable_height);
466 setEnabled(file_->choice_height, !disable_height);
468 fl_set_button(file_->check_aspectratio, igp.keepAspectRatio);
469 fl_set_button(file_->check_draft, igp.draft);
470 fl_set_button(file_->check_nounzip, igp.noUnzip);
472 // disable aspectratio button in case of scaling or one of width/height
474 bool const disable_aspectRatio = disable_height ||
475 getString(file_->input_width).empty() ||
476 getString(file_->input_height).empty();
477 setEnabled(file_->check_aspectratio, !disable_aspectRatio);
480 // set the bounding box values, if exists. First we need the whole
481 // path, because the controller knows nothing about the doc-dir
482 updateBB(igp.filename, igp.bb);
483 fl_set_button(bbox_->check_clip, igp.clip);
486 fl_set_input(extra_->input_rotate_angle,
487 tostr(igp.rotateAngle).c_str());
490 if (igp.rotateOrigin.empty()) {
493 origin_pos = 1 + findPos(origins_, igp.rotateOrigin);
495 fl_set_choice(extra_->choice_origin, origin_pos);
497 fl_set_button(extra_->check_subcaption, igp.subcaption);
498 fl_set_input(extra_->input_subcaption, igp.subcaptionText.c_str());
499 setEnabled(extra_->input_subcaption,
500 fl_get_button(extra_->check_subcaption));
501 fl_set_input(extra_->input_special, igp.special.c_str());
503 // open dialog in the file-tab, whenever filename is empty
504 if (igp.filename.empty()) {
505 fl_set_folder(dialog_->tabfolder, file_->form);
510 void FormGraphics::updateBB(string const & filename, string const & bb_inset)
512 // Update dialog with details from inset
513 // set the bounding box values, if exists. First we need the whole
514 // path, because the controller knows nothing about the doc-dir
515 controller().bbChanged = false;
516 if (bb_inset.empty()) {
517 lyxerr[Debug::GRAPHICS]
518 << "FormGraphics::updateBB() [no BoundingBox]" << endl;
519 string const bb = controller().readBB(filename);
521 // get the values from the file
522 // in this case we always have the point-unit
523 fl_set_input(bbox_->input_bb_x0,
524 token(bb,' ',0).c_str());
525 fl_set_input(bbox_->input_bb_y0,
526 token(bb,' ',1).c_str());
527 fl_set_input(bbox_->input_bb_x1,
528 token(bb,' ',2).c_str());
529 fl_set_input(bbox_->input_bb_y1,
530 token(bb,' ',3).c_str());
534 fl_set_input(bbox_->input_bb_x0, bb.c_str());
535 fl_set_input(bbox_->input_bb_y0, bb.c_str());
536 fl_set_input(bbox_->input_bb_x1, bb.c_str());
537 fl_set_input(bbox_->input_bb_y1, bb.c_str());
540 fl_set_choice(bbox_->choice_bb_units, 1);
543 // get the values from the inset
544 lyxerr[Debug::GRAPHICS]
545 << "FormGraphics::updateBB(): igp has BoundingBox"
546 << " ["<< bb_inset << "]" << endl;
547 controller().bbChanged = true;
550 anyLength = LyXLength(token(bb_inset,' ',0));
551 updateWidgetsFromLength(bbox_->input_bb_x0,
552 bbox_->choice_bb_units,anyLength,"bp");
553 anyLength = LyXLength(token(bb_inset,' ',1));
554 updateWidgetsFromLength(bbox_->input_bb_y0,
555 bbox_->choice_bb_units,anyLength,"bp");
556 anyLength = LyXLength(token(bb_inset,' ',2));
557 updateWidgetsFromLength(bbox_->input_bb_x1,
558 bbox_->choice_bb_units,anyLength,"bp");
559 anyLength = LyXLength(token(bb_inset,' ',3));
560 updateWidgetsFromLength(bbox_->input_bb_y1,
561 bbox_->choice_bb_units,anyLength,"bp");
566 ButtonPolicy::SMInput FormGraphics::input(FL_OBJECT * ob, long)
569 if (ob == file_->button_browse) {
570 // Get the filename from the dialog
571 string const in_name = getString(file_->input_filename);
572 string const out_name = controller().Browse(in_name);
573 lyxerr[Debug::GRAPHICS]
574 << "[FormGraphics]out_name: " << out_name << endl;
575 if (out_name != in_name && !out_name.empty()) {
576 fl_set_input(file_->input_filename, out_name.c_str());
578 if (controller().isFilenameValid(out_name) &&
579 !controller().bbChanged) {
580 updateBB(out_name, string());
582 } else if (ob == file_->input_width || ob == file_->input_height) {
583 // disable aspectratio button in case of scaling or one of
584 // width/height is empty
585 bool const disable = fl_get_choice(file_->choice_width) == 1 ||
586 getString(file_->input_width).empty() ||
587 getString(file_->input_height).empty();
588 setEnabled(file_->check_aspectratio, !disable);
589 } else if (ob == file_->choice_width) {
590 // disable height input in case of scaling
591 bool const scaling = fl_get_choice(file_->choice_width) == 1;
592 setEnabled(file_->input_height, !scaling);
593 setEnabled(file_->choice_height, !scaling);
595 // allow only integer intput for scaling; float otherwise
597 fl_set_input_filter(file_->input_width, fl_unsigned_float_filter);
598 fl_set_input_maxchars(file_->input_width, 0);
600 fl_set_input_filter(file_->input_width, NULL);
601 fl_set_input_maxchars(file_->input_width, SIZE_MAXDIGITS);
604 // disable aspectratio button in case of scaling or height
606 bool const disable_aspectratio =
607 scaling || getString(file_->input_height).empty();
608 setEnabled(file_->check_aspectratio, !disable_aspectratio);
610 } else if (!controller().bbChanged &&
611 (ob == bbox_->check_clip || ob == bbox_->choice_bb_units ||
612 ob == bbox_->input_bb_x0 || ob == bbox_->input_bb_y0 ||
613 ob == bbox_->input_bb_x1 || ob == bbox_->input_bb_y1)) {
614 controller().bbChanged = true;
615 } else if (ob == bbox_->button_getBB) {
616 string const filename = getString(file_->input_filename);
617 if (!filename.empty()) {
618 string bb = controller().readBB(filename);
620 fl_set_input(bbox_->input_bb_x0, token(bb,' ',0).c_str());
621 fl_set_input(bbox_->input_bb_y0, token(bb,' ',1).c_str());
622 fl_set_input(bbox_->input_bb_x1, token(bb,' ',2).c_str());
623 fl_set_input(bbox_->input_bb_y1, token(bb,' ',3).c_str());
624 fl_set_choice_text(bbox_->choice_bb_units, "bp");
626 controller().bbChanged = false;
628 fl_set_input(bbox_->input_bb_x0, "");
629 fl_set_input(bbox_->input_bb_y0, "");
630 fl_set_input(bbox_->input_bb_x1, "");
631 fl_set_input(bbox_->input_bb_y1, "");
632 fl_set_choice_text(bbox_->choice_bb_units, "bp");
635 } else if (ob == extra_->check_subcaption) {
636 setEnabled(extra_->input_subcaption,
637 fl_get_button(extra_->check_subcaption));
641 return ButtonPolicy::SMI_VALID;