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
15 #pragma implementation
19 #include "ControlGraphics.h"
20 #include "FormGraphics.h"
21 #include "forms/form_graphics.h"
25 #include "xforms_helpers.h"
26 #include "helper_funcs.h"
27 #include "input_validators.h"
28 #include "debug.h" // for lyxerr
29 #include "support/lstrings.h" // for strToDbl & tostr
30 #include "support/filetools.h" // for MakeAbsPath etc
31 #include "insets/insetgraphicsParams.h"
32 #include "lyxrc.h" // for lyxrc.display_graphics
33 #include FORMS_H_LOCATION
40 // Bound the number of input characters
41 int const SIZE_MAXDIGITS = 10;
42 int const FILENAME_MAXCHARS = 1024;
44 string defaultUnit("cm");
46 /// Given input and choice widgets, create a LyXLength
47 LyXLength getLyXLengthFromWidgets(FL_OBJECT * input, FL_OBJECT * choice)
49 return LyXLength(getLengthFromWidgets(input, choice));
55 typedef FormCB<ControlGraphics, FormDB<FD_graphics> > base_class;
57 FormGraphics::FormGraphics()
58 : base_class(_("Graphics"), false)
62 void FormGraphics::redraw()
64 if (form() && form()->visible)
65 fl_redraw_form(form());
68 FL_FORM * outer_form = fl_get_active_folder(dialog_->tabfolder);
69 if (outer_form && outer_form->visible)
70 fl_redraw_form(outer_form);
74 void FormGraphics::build()
76 dialog_.reset(build_graphics(this));
78 // Allow the base class to control messages
79 setMessageWidget(dialog_->text_warning);
81 // Manage the ok, apply, restore and cancel/close buttons
82 bc().setOK(dialog_->button_ok);
83 bc().setApply(dialog_->button_apply);
84 bc().setCancel(dialog_->button_close);
85 bc().setRestore(dialog_->button_restore);
88 file_.reset(build_graphics_file(this));
90 fl_set_input_return (file_->input_filename, FL_RETURN_CHANGED);
91 fl_set_input_return (file_->input_lyxscale, FL_RETURN_CHANGED);
92 fl_set_input_return (file_->input_width, FL_RETURN_CHANGED);
93 fl_set_input_return (file_->input_height, FL_RETURN_CHANGED);
95 setPrehandler(file_->input_filename);
96 setPrehandler(file_->input_lyxscale);
97 setPrehandler(file_->input_width);
98 setPrehandler(file_->input_height);
100 fl_set_input_maxchars(file_->input_filename, FILENAME_MAXCHARS);
101 fl_set_input_filter(file_->input_lyxscale, fl_unsigned_int_filter);
103 // width default is scaling, thus unsigned integer input
104 fl_set_input_filter(file_->input_width, fl_unsigned_int_filter);
105 fl_set_input_maxchars(file_->input_height, SIZE_MAXDIGITS);
107 string const display_List = _("Default|Monochrome|Grayscale|Color|Do not display");
108 fl_addto_choice(file_->choice_display, display_List.c_str());
110 string const width_list = _("Scale%%|") + choice_Length_All;
111 fl_addto_choice(file_->choice_width, width_list.c_str());
113 fl_addto_choice(file_->choice_height, choice_Length_All.c_str());
115 bc().addReadOnly(file_->button_browse);
116 bc().addReadOnly(file_->check_aspectratio);
117 bc().addReadOnly(file_->check_draft);
118 bc().addReadOnly(file_->check_nounzip);
120 // set up the tooltips for the filesection
121 string str = _("The file you want to insert.");
122 tooltips().init(file_->input_filename, str);
123 str = _("Browse the directories.");
124 tooltips().init(file_->button_browse, str);
126 str = _("Scale the image to inserted percentage value.");
127 tooltips().init(file_->input_lyxscale, str);
128 str = _("Select display mode for this image.");
129 tooltips().init(file_->choice_display, str);
131 str = _("Set the image width to the inserted value.");
132 tooltips().init(file_->input_width, str);
133 str = _("Select unit for width; Scale% for scaling whole image.");
134 tooltips().init(file_->choice_width, str);
135 str = _("Set the image height to the inserted value.");
136 tooltips().init(file_->input_height, str);
137 str = _("Select unit for height");
138 tooltips().init(file_->choice_height, str);
139 str = _("Do not distort the image. "
140 "Keep image within \"width\" by \"height\" and obey aspect ratio.");
141 tooltips().init(file_->check_aspectratio, str);
143 str = _("Pass a filename like \"file.eps.gz\" to the LaTeX output. "
144 "Useful when LaTeX should unzip the file. Needs an additional file "
145 "like \"file.eps.bb\" which holds the values for the bounding box.");
146 tooltips().init(file_->check_nounzip, str);
148 str = _("Show image only as a rectangle of the original size.");
149 tooltips().init(file_->check_draft, str);
151 // the bounding box selection
152 bbox_.reset(build_graphics_bbox(this));
153 fl_set_input_return (bbox_->input_bb_x0, FL_RETURN_CHANGED);
154 fl_set_input_return (bbox_->input_bb_y0, FL_RETURN_CHANGED);
155 fl_set_input_return (bbox_->input_bb_x1, FL_RETURN_CHANGED);
156 fl_set_input_return (bbox_->input_bb_y1, FL_RETURN_CHANGED);
158 fl_set_input_filter(bbox_->input_bb_x0, fl_unsigned_float_filter);
159 fl_set_input_filter(bbox_->input_bb_y0, fl_unsigned_float_filter);
160 fl_set_input_filter(bbox_->input_bb_x1, fl_unsigned_float_filter);
161 fl_set_input_filter(bbox_->input_bb_y1, fl_unsigned_float_filter);
163 setPrehandler(bbox_->input_bb_x0);
164 setPrehandler(bbox_->input_bb_y0);
165 setPrehandler(bbox_->input_bb_x1);
166 setPrehandler(bbox_->input_bb_y1);
168 string const bb_units = "bp|cm|mm|in";
169 fl_addto_choice(bbox_->choice_bb_units, bb_units.c_str());
170 bc().addReadOnly(bbox_->button_getBB);
171 bc().addReadOnly(bbox_->check_clip);
173 // set up the tooltips for the bounding-box-section
174 str = _("The lower left x-value of the bounding box");
175 tooltips().init(bbox_->input_bb_x0, str);
176 str = _("The lower left y-value of the bounding box");
177 tooltips().init(bbox_->input_bb_y0, str);
178 str = _("The upper right x-value of the bounding box");
179 tooltips().init(bbox_->input_bb_x1, str);
180 str = _("The upper right y-value of the bounding box");
181 tooltips().init(bbox_->input_bb_y1, str);
182 str = _("Select unit for the bounding box values");
183 tooltips().init(bbox_->choice_bb_units, str);
185 str = _("Read the image coordinates new from file. If it's an (e)ps-file "
186 "then the bounding box is read otherwise the imagesize in pixels. "
187 "Default unit is \"bp\", the PostScript's b(ig) p(oint).");
188 tooltips().init(bbox_->button_getBB, str);
190 str = _("Clip image to the bounding box values.");
191 tooltips().init(bbox_->check_clip, str);
194 extra_.reset(build_graphics_extra(this));
196 fl_set_input_return (extra_->input_rotate_angle, FL_RETURN_CHANGED);
197 fl_set_input_return (extra_->input_subcaption, FL_RETURN_CHANGED);
198 fl_set_input_return (extra_->input_special, FL_RETURN_CHANGED);
200 fl_set_input_filter(extra_->input_rotate_angle, fl_float_filter);
202 setPrehandler(extra_->input_rotate_angle);
203 setPrehandler(extra_->input_subcaption);
204 setPrehandler(extra_->input_special);
206 bc().addReadOnly(extra_->check_subcaption);
208 using namespace frnt;
209 vector<RotationOriginPair> origindata = getRotationOriginData();
211 // Store the identifiers for later
212 origins_ = getSecond(origindata);
214 string const choice = "Default|" + getStringFromVector(getFirst(origindata), "|");
215 fl_addto_choice(extra_->choice_origin, choice.c_str());
217 // set up the tooltips for the extra section
218 str = _("Insert the rotation angle in degrees. "
219 "Positive value rotates anti-clockwise, negative value clockwise.");
220 tooltips().init(extra_->input_rotate_angle, str);
221 str = _("Insert the point of origin for rotation.");
222 tooltips().init(extra_->choice_origin, str);
223 str = _("Enables use of subfigure with its own caption.");
224 tooltips().init(extra_->check_subcaption, str);
225 str = _("Insert the optional subfigure caption.");
226 tooltips().init(extra_->input_subcaption, str);
227 str = _("Add any additional latex option, which is defined in the "
228 "graphicx-package and not mentioned in the gui's tabfolders.");
229 tooltips().init(extra_->input_special, str);
231 // add the different tabfolders
232 fl_addto_tabfolder(dialog_->tabfolder, _("File"), file_->form);
233 fl_addto_tabfolder(dialog_->tabfolder, _("Bounding Box"), bbox_->form);
234 fl_addto_tabfolder(dialog_->tabfolder, _("Extra"), extra_->form);
236 // work-around xforms bug re update of folder->x, folder->y coords.
237 setPrehandler(dialog_->tabfolder);
239 // set the right default unit
240 switch (lyxrc.default_papersize) {
241 case BufferParams::PAPER_DEFAULT: break;
242 case BufferParams::PAPER_USLETTER:
243 case BufferParams::PAPER_LEGALPAPER:
244 case BufferParams::PAPER_EXECUTIVEPAPER: defaultUnit = "in"; break;
245 case BufferParams::PAPER_A3PAPER:
246 case BufferParams::PAPER_A4PAPER:
247 case BufferParams::PAPER_A5PAPER:
248 case BufferParams::PAPER_B5PAPER: defaultUnit = "cm"; break;
253 void FormGraphics::apply()
255 // Create the parameters structure and fill the data from the dialog.
256 InsetGraphicsParams & igp = controller().params();
259 igp.filename = getString(file_->input_filename);
261 igp.lyxscale = strToInt(getString(file_->input_lyxscale));
262 if (igp.lyxscale == 0) {
266 switch (fl_get_choice(file_->choice_display)) {
267 case 5: igp.display = grfx::NoDisplay; break;
268 case 4: igp.display = grfx::ColorDisplay; break;
269 case 3: igp.display = grfx::GrayscaleDisplay; break;
270 case 2: igp.display = grfx::MonochromeDisplay; break;
272 default: igp.display = grfx::DefaultDisplay;
275 // first item in choice_width means scaling
276 if (fl_get_choice(file_->choice_width) == 1) {
277 igp.scale = strToInt(getString(file_->input_width));
278 if (igp.scale == 0) {
281 igp.width = LyXLength();
284 igp.width = getLyXLengthFromWidgets(file_->input_width,
285 file_->choice_width);
287 igp.height = getLyXLengthFromWidgets(file_->input_height,
288 file_->choice_height);
289 igp.keepAspectRatio = fl_get_button(file_->check_aspectratio);
291 igp.draft = fl_get_button(file_->check_draft);
292 igp.noUnzip = fl_get_button(file_->check_nounzip);
295 if (!controller().bbChanged) { // different to the original one?
296 igp.bb = string(); // don't write anything
299 if (getString(bbox_->input_bb_x0).empty())
302 bb = getLengthFromWidgets(bbox_->input_bb_x0,
303 bbox_->choice_bb_units)+" ";
304 if (getString(bbox_->input_bb_y0).empty())
307 bb += (getLengthFromWidgets(bbox_->input_bb_y0,
308 bbox_->choice_bb_units)+" ");
309 if (getString(bbox_->input_bb_x1).empty())
312 bb += (getLengthFromWidgets(bbox_->input_bb_x1,
313 bbox_->choice_bb_units)+" ");
314 if (getString(bbox_->input_bb_y1).empty())
317 bb += (getLengthFromWidgets(bbox_->input_bb_y1,
318 bbox_->choice_bb_units)+" ");
321 igp.clip = fl_get_button(bbox_->check_clip);
324 igp.rotateAngle = strToDbl(getString(extra_->input_rotate_angle));
326 // map angle into -360 (clock-wise) to +360 (counter clock-wise)
327 while (igp.rotateAngle <= -360.0) {
328 igp.rotateAngle += 360.0;
330 while (igp.rotateAngle >= 360.0) {
331 igp.rotateAngle -= 360.0;
333 fl_set_input(extra_->input_rotate_angle, tostr(igp.rotateAngle).c_str());
335 int const origin_pos = fl_get_choice(extra_->choice_origin);
336 if (origin_pos == 1) {
337 igp.rotateOrigin.erase();
339 igp.rotateOrigin = origins_[origin_pos - 2];
342 igp.subcaption = fl_get_button(extra_->check_subcaption);
343 igp.subcaptionText = getString(extra_->input_subcaption);
345 igp.special = getString(extra_->input_special);
349 void FormGraphics::update() {
350 // Update dialog with details from inset
351 InsetGraphicsParams & igp = controller().params();
354 fl_set_input(file_->input_filename, igp.filename.c_str());
355 fl_set_input(file_->input_lyxscale, tostr(igp.lyxscale).c_str());
357 switch (igp.display) {
358 case grfx::NoDisplay: fl_set_choice(file_->choice_display, 5); break;
359 case grfx::ColorDisplay: fl_set_choice(file_->choice_display, 4); break;
360 case grfx::GrayscaleDisplay: fl_set_choice(file_->choice_display, 3); break;
361 case grfx::MonochromeDisplay: fl_set_choice(file_->choice_display, 2); break;
362 case grfx::DefaultDisplay:
363 default: fl_set_choice(file_->choice_display, 1);
366 // disable height input in case of scaling
367 setEnabled(file_->input_height, !igp.scale);
368 setEnabled(file_->choice_height, !igp.scale);
370 // set width input fields according to scaling or width/height input
372 fl_set_input_filter(file_->input_width, fl_unsigned_int_filter);
373 fl_set_input_maxchars(file_->input_width, 0);
374 fl_set_input(file_->input_width, tostr(igp.scale).c_str());
375 fl_set_choice(file_->choice_width, 1);
377 fl_set_input_filter(file_->input_width, NULL);
378 fl_set_input_maxchars(file_->input_width, SIZE_MAXDIGITS);
379 updateWidgetsFromLength(file_->input_width,
380 file_->choice_width, igp.width, defaultUnit);
383 updateWidgetsFromLength(file_->input_height,
384 file_->choice_height, igp.height, defaultUnit);
386 fl_set_button(file_->check_aspectratio, igp.keepAspectRatio);
387 fl_set_button(file_->check_draft, igp.draft);
388 fl_set_button(file_->check_nounzip, igp.noUnzip);
390 // disable aspectratio button in case of scaling or one of width/height is empty
391 bool const disable_aspectRatio = igp.scale ||
392 getString(file_->input_width).empty() ||
393 getString(file_->input_height).empty();
394 setEnabled(file_->check_aspectratio, !disable_aspectRatio);
397 // set the bounding box values, if exists. First we need the whole
398 // path, because the controller knows nothing about the doc-dir
399 updateBB(igp.filename, igp.bb);
400 fl_set_button(bbox_->check_clip, igp.clip);
404 fl_set_input(extra_->input_rotate_angle,
405 tostr(igp.rotateAngle).c_str());
408 if (igp.rotateOrigin.empty()) {
411 origin_pos = 2 + findPos(origins_, igp.rotateOrigin);
413 fl_set_choice(extra_->choice_origin, origin_pos);
415 fl_set_button(extra_->check_subcaption, igp.subcaption);
416 fl_set_input(extra_->input_subcaption, igp.subcaptionText.c_str());
417 setEnabled(extra_->input_subcaption,
418 fl_get_button(extra_->check_subcaption));
419 fl_set_input(extra_->input_special, igp.special.c_str());
421 // open dialog in the file-tab, whenever filename is empty
422 if (igp.filename.empty()) {
423 fl_set_folder(dialog_->tabfolder, file_->form);
428 void FormGraphics::updateBB(string const & filename, string const & bb_inset)
430 // Update dialog with details from inset
431 // set the bounding box values, if exists. First we need the whole
432 // path, because the controller knows nothing about the doc-dir
433 controller().bbChanged = false;
434 if (bb_inset.empty()) {
435 lyxerr[Debug::GRAPHICS] << "FormGraphics::updateBB() [no BoundingBox]" << endl;
436 string const bb = controller().readBB(filename);
438 // get the values from the file
439 // in this case we always have the point-unit
440 fl_set_input(bbox_->input_bb_x0,
441 token(bb,' ',0).c_str());
442 fl_set_input(bbox_->input_bb_y0,
443 token(bb,' ',1).c_str());
444 fl_set_input(bbox_->input_bb_x1,
445 token(bb,' ',2).c_str());
446 fl_set_input(bbox_->input_bb_y1,
447 token(bb,' ',3).c_str());
451 fl_set_input(bbox_->input_bb_x0, bb.c_str());
452 fl_set_input(bbox_->input_bb_y0, bb.c_str());
453 fl_set_input(bbox_->input_bb_x1, bb.c_str());
454 fl_set_input(bbox_->input_bb_y1, bb.c_str());
457 fl_set_choice(bbox_->choice_bb_units, 1);
460 // get the values from the inset
461 lyxerr[Debug::GRAPHICS] << "FormGraphics::updateBB(): igp has BoundingBox"
462 << " ["<< bb_inset << "]"
464 controller().bbChanged = true;
467 anyLength = LyXLength(token(bb_inset,' ',0));
468 updateWidgetsFromLength(bbox_->input_bb_x0,
469 bbox_->choice_bb_units,anyLength,"bp");
470 anyLength = LyXLength(token(bb_inset,' ',1));
471 updateWidgetsFromLength(bbox_->input_bb_y0,
472 bbox_->choice_bb_units,anyLength,"bp");
473 anyLength = LyXLength(token(bb_inset,' ',2));
474 updateWidgetsFromLength(bbox_->input_bb_x1,
475 bbox_->choice_bb_units,anyLength,"bp");
476 anyLength = LyXLength(token(bb_inset,' ',3));
477 updateWidgetsFromLength(bbox_->input_bb_y1,
478 bbox_->choice_bb_units,anyLength,"bp");
485 bool isValid(FL_OBJECT * ob)
487 string const input = getString(ob);
488 return input.empty() || isValidLength(input) || isStrDbl(input);
495 ButtonPolicy::SMInput FormGraphics::input(FL_OBJECT * ob, long)
498 if (ob == file_->button_browse) {
499 // Get the filename from the dialog
500 string const in_name = getString(file_->input_filename);
501 string const out_name = controller().Browse(in_name);
502 lyxerr[Debug::GRAPHICS] << "[FormGraphics]out_name: " << out_name << endl;
503 if (out_name != in_name && !out_name.empty()) {
504 fl_set_input(file_->input_filename, out_name.c_str());
506 if (controller().isFilenameValid(out_name) &&
507 !controller().bbChanged) {
508 updateBB(out_name, string());
510 } else if (ob == file_->input_width || ob == file_->input_height) {
511 // disable aspectratio button in case of scaling or one of width/height is empty
512 bool const disable = fl_get_choice(file_->choice_width) == 1 ||
513 getString(file_->input_width).empty() ||
514 getString(file_->input_height).empty();
515 setEnabled(file_->check_aspectratio, !disable);
516 } else if (ob == file_->choice_width) {
517 // disable height input in case of scaling
518 bool const scaling = fl_get_choice(file_->choice_width) == 1;
519 setEnabled(file_->input_height, !scaling);
520 setEnabled(file_->choice_height, !scaling);
522 // allow only integer intput for scaling; float otherwise
524 fl_set_input_filter(file_->input_width, fl_unsigned_int_filter);
525 fl_set_input_maxchars(file_->input_width, 0);
527 fl_set_input_filter(file_->input_width, NULL);
528 fl_set_input_maxchars(file_->input_width, SIZE_MAXDIGITS);
531 // disable aspectratio button in case of scaling or height input is empty
532 bool const disable_aspectratio = scaling || getString(file_->input_height).empty();
533 setEnabled(file_->check_aspectratio, !disable_aspectratio);
535 } else if (!controller().bbChanged &&
536 (ob == bbox_->check_clip || ob == bbox_->choice_bb_units ||
537 ob == bbox_->input_bb_x0 || ob == bbox_->input_bb_y0 ||
538 ob == bbox_->input_bb_x1 || ob == bbox_->input_bb_y1)) {
539 controller().bbChanged = true;
540 } else if (ob == bbox_->button_getBB) {
541 string const filename = getString(file_->input_filename);
542 if (!filename.empty()) {
543 string bb = controller().readBB(filename);
545 fl_set_input(bbox_->input_bb_x0, token(bb,' ',0).c_str());
546 fl_set_input(bbox_->input_bb_y0, token(bb,' ',1).c_str());
547 fl_set_input(bbox_->input_bb_x1, token(bb,' ',2).c_str());
548 fl_set_input(bbox_->input_bb_y1, token(bb,' ',3).c_str());
549 fl_set_choice_text(bbox_->choice_bb_units, "bp");
551 controller().bbChanged = false;
553 fl_set_input(bbox_->input_bb_x0, "");
554 fl_set_input(bbox_->input_bb_y0, "");
555 fl_set_input(bbox_->input_bb_x1, "");
556 fl_set_input(bbox_->input_bb_y1, "");
557 fl_set_choice_text(bbox_->choice_bb_units, "bp");
560 } else if (ob == extra_->check_subcaption) {
561 setEnabled(extra_->input_subcaption,
562 fl_get_button(extra_->check_subcaption));
566 // check if the input is valid
567 bool const invalid = !isValid(file_->input_width) || !isValid(file_->input_height);
569 // deactivate OK / Apply buttons and spit out warnings if invalid
571 postWarning(_("Invalid Length in Output size!"));
572 return ButtonPolicy::SMI_INVALID;
575 return ButtonPolicy::SMI_VALID;