]> git.lyx.org Git - lyx.git/blob - src/frontends/xforms/FormGraphics.C
Yet more dialog tweaking from Rob.
[lyx.git] / src / frontends / xforms / FormGraphics.C
1 /**
2  * \file FormGraphics.C
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Baruch Even
7  * \author Herbert Voss
8  *
9  * Full author contact details are available in file CREDITS
10  */
11
12 #include <config.h>
13
14 #ifdef __GNUG__
15 #pragma implementation
16 #endif
17
18 #include "xformsBC.h"
19 #include "ControlGraphics.h"
20 #include "FormGraphics.h"
21 #include "forms/form_graphics.h"
22 #include "Alert.h"
23 #include "Tooltips.h"
24
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
34
35 using std::endl;
36 using std::vector;
37
38 namespace {
39
40 // Bound the number of input characters
41 int const SIZE_MAXDIGITS = 10;
42 int const FILENAME_MAXCHARS = 1024;
43
44 string defaultUnit("cm");
45
46 /// Given input and choice widgets, create a LyXLength
47 LyXLength getLyXLengthFromWidgets(FL_OBJECT * input, FL_OBJECT * choice)
48 {
49         return LyXLength(getLengthFromWidgets(input, choice));
50 }
51
52 } // namespace anon
53
54
55 typedef FormCB<ControlGraphics, FormDB<FD_graphics> > base_class;
56
57 FormGraphics::FormGraphics()
58         : base_class(_("Graphics"), false)
59 {}
60
61
62 void FormGraphics::redraw()
63 {
64         if (form() && form()->visible)
65                 fl_redraw_form(form());
66         else
67                 return;
68         FL_FORM * outer_form = fl_get_active_folder(dialog_->tabfolder);
69         if (outer_form && outer_form->visible)
70                 fl_redraw_form(outer_form);
71 }
72
73
74 void FormGraphics::build()
75 {
76         dialog_.reset(build_graphics(this));
77
78         // Allow the base class to control messages
79         setMessageWidget(dialog_->text_warning);
80
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);
86
87         // the file section
88         file_.reset(build_graphics_file(this));
89
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);
94
95         setPrehandler(file_->input_filename);
96         setPrehandler(file_->input_lyxscale);
97         setPrehandler(file_->input_width);
98         setPrehandler(file_->input_height);
99
100         fl_set_input_maxchars(file_->input_filename, FILENAME_MAXCHARS);
101         fl_set_input_filter(file_->input_lyxscale, fl_unsigned_int_filter);
102
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);
106         
107         string const display_List = _("Default|Monochrome|Grayscale|Color|Do not display");
108         fl_addto_choice(file_->choice_display, display_List.c_str());
109         
110         string const width_list = _("Scale%%|") + choice_Length_All;
111         fl_addto_choice(file_->choice_width, width_list.c_str());
112
113         fl_addto_choice(file_->choice_height, choice_Length_All.c_str());
114
115         bc().addReadOnly(file_->button_browse);   
116         bc().addReadOnly(file_->check_aspectratio);
117         bc().addReadOnly(file_->check_draft);
118         bc().addReadOnly(file_->check_nounzip);
119
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);
125
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);
130
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);
142
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);
147
148         str = _("Show image only as a rectangle of the original size.");
149         tooltips().init(file_->check_draft, str);
150
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);
157
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);
162
163         setPrehandler(bbox_->input_bb_x0);
164         setPrehandler(bbox_->input_bb_y0);
165         setPrehandler(bbox_->input_bb_x1);
166         setPrehandler(bbox_->input_bb_y1);
167
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);
172
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);
184
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);
189
190         str = _("Clip image to the bounding box values.");
191         tooltips().init(bbox_->check_clip, str);
192
193         // the extra section
194         extra_.reset(build_graphics_extra(this));
195
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);
199
200         fl_set_input_filter(extra_->input_rotate_angle, fl_float_filter);
201
202         setPrehandler(extra_->input_rotate_angle);
203         setPrehandler(extra_->input_subcaption);
204         setPrehandler(extra_->input_special);
205
206         bc().addReadOnly(extra_->check_subcaption);
207
208         using namespace frnt;
209         vector<RotationOriginPair> origindata = getRotationOriginData();
210
211         // Store the identifiers for later
212         origins_ = getSecond(origindata);
213
214         string const choice = "Default|" + getStringFromVector(getFirst(origindata), "|");
215         fl_addto_choice(extra_->choice_origin, choice.c_str());
216
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);
230
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);
235
236         // set the right default unit
237         switch (lyxrc.default_papersize) {
238         case BufferParams::PAPER_DEFAULT: break;
239         case BufferParams::PAPER_USLETTER:
240         case BufferParams::PAPER_LEGALPAPER:
241         case BufferParams::PAPER_EXECUTIVEPAPER: defaultUnit = "in"; break;
242         case BufferParams::PAPER_A3PAPER:
243         case BufferParams::PAPER_A4PAPER:
244         case BufferParams::PAPER_A5PAPER:
245         case BufferParams::PAPER_B5PAPER: defaultUnit = "cm"; break;
246         }
247 }
248
249
250 void FormGraphics::apply()
251 {
252         // Create the parameters structure and fill the data from the dialog.
253         InsetGraphicsParams & igp = controller().params();
254
255         // the file section
256         igp.filename = getString(file_->input_filename);
257
258         igp.lyxscale = strToInt(getString(file_->input_lyxscale));
259         if (igp.lyxscale == 0) {
260                 igp.lyxscale = 100;
261         }
262         
263         switch (fl_get_choice(file_->choice_display)) {
264                 case 5: igp.display = grfx::NoDisplay; break;
265                 case 4: igp.display = grfx::ColorDisplay; break;
266                 case 3: igp.display = grfx::GrayscaleDisplay; break;
267                 case 2: igp.display = grfx::MonochromeDisplay; break;
268                 case 1:
269                 default: igp.display = grfx::DefaultDisplay;
270         }
271
272         // first item in choice_width means scaling
273         if (fl_get_choice(file_->choice_width) == 1) {
274                 igp.scale = strToInt(getString(file_->input_width));
275                 if (igp.scale == 0) {
276                         igp.scale = 100;
277                 }
278                 igp.width = LyXLength();
279         } else {
280                 igp.scale = 0;
281                 igp.width = getLyXLengthFromWidgets(file_->input_width,
282                                                     file_->choice_width);
283         }
284         igp.height = getLyXLengthFromWidgets(file_->input_height,
285                                              file_->choice_height);
286         igp.keepAspectRatio = fl_get_button(file_->check_aspectratio);
287
288         igp.draft = fl_get_button(file_->check_draft);
289         igp.noUnzip = fl_get_button(file_->check_nounzip);
290
291         // the bb section
292         if (!controller().bbChanged) { // different to the original one?
293                 igp.bb = string();     // don't write anything
294         } else {
295                 string bb;
296                 if (getString(bbox_->input_bb_x0).empty())
297                         bb = "0 ";
298                 else
299                         bb = getLengthFromWidgets(bbox_->input_bb_x0,
300                                                   bbox_->choice_bb_units)+" ";
301                 if (getString(bbox_->input_bb_y0).empty())
302                         bb += "0 ";
303                 else
304                         bb += (getLengthFromWidgets(bbox_->input_bb_y0,
305                                                     bbox_->choice_bb_units)+" ");
306                 if (getString(bbox_->input_bb_x1).empty())
307                         bb += "0 ";
308                 else
309                         bb += (getLengthFromWidgets(bbox_->input_bb_x1,
310                                                     bbox_->choice_bb_units)+" ");
311                 if (getString(bbox_->input_bb_y1).empty())
312                         bb += "0 ";
313                 else
314                         bb += (getLengthFromWidgets(bbox_->input_bb_y1,
315                                                     bbox_->choice_bb_units)+" ");
316                 igp.bb = bb;
317         }
318         igp.clip = fl_get_button(bbox_->check_clip);
319
320         // the extra section
321         igp.rotateAngle = strToDbl(getString(extra_->input_rotate_angle));
322         
323         // map angle into -360 (clock-wise) to +360 (counter clock-wise)
324         while (igp.rotateAngle <= -360.0) {
325                 igp.rotateAngle += 360.0;
326         }
327         while (igp.rotateAngle >=  360.0) {
328                 igp.rotateAngle -= 360.0;
329         }
330         fl_set_input(extra_->input_rotate_angle, tostr(igp.rotateAngle).c_str());
331
332         int const origin_pos = fl_get_choice(extra_->choice_origin);
333         if (origin_pos == 1) {
334                 igp.rotateOrigin.erase();
335         } else {
336                 igp.rotateOrigin = origins_[origin_pos - 2];
337         }
338
339         igp.subcaption = fl_get_button(extra_->check_subcaption);
340         igp.subcaptionText = getString(extra_->input_subcaption);
341
342         igp.special = getString(extra_->input_special);
343 }
344
345
346 void FormGraphics::update() {
347         // Update dialog with details from inset
348         InsetGraphicsParams & igp = controller().params();
349
350         // the file section
351         fl_set_input(file_->input_filename, igp.filename.c_str());
352         fl_set_input(file_->input_lyxscale, tostr(igp.lyxscale).c_str());
353
354         switch (igp.display) {
355                 case grfx::NoDisplay:           fl_set_choice(file_->choice_display, 5); break;
356                 case grfx::ColorDisplay:        fl_set_choice(file_->choice_display, 4); break;
357                 case grfx::GrayscaleDisplay:    fl_set_choice(file_->choice_display, 3); break;
358                 case grfx::MonochromeDisplay:   fl_set_choice(file_->choice_display, 2); break;
359                 case grfx::DefaultDisplay:
360                 default:                        fl_set_choice(file_->choice_display, 1);
361         }
362
363         // disable height input in case of scaling
364         setEnabled(file_->input_height, !igp.scale);
365         setEnabled(file_->choice_height, !igp.scale);
366
367         // set width input fields according to scaling or width/height input
368         if (igp.scale) {
369                 fl_set_input_filter(file_->input_width, fl_unsigned_int_filter);
370                 fl_set_input_maxchars(file_->input_width, 0);
371                 fl_set_input(file_->input_width, tostr(igp.scale).c_str());
372                 fl_set_choice(file_->choice_width, 1);
373         } else {
374                 fl_set_input_filter(file_->input_width, NULL);
375                 fl_set_input_maxchars(file_->input_width, SIZE_MAXDIGITS);
376                 updateWidgetsFromLength(file_->input_width,
377                                         file_->choice_width, igp.width, defaultUnit);
378         }
379
380         updateWidgetsFromLength(file_->input_height,
381                                 file_->choice_height, igp.height, defaultUnit);
382         
383         fl_set_button(file_->check_aspectratio, igp.keepAspectRatio);
384         fl_set_button(file_->check_draft, igp.draft);
385         fl_set_button(file_->check_nounzip, igp.noUnzip);
386
387         // disable aspectratio button in case of scaling or one of width/height is empty
388         bool const disable_aspectRatio = igp.scale ||
389                                 getString(file_->input_width).empty() ||
390                                 getString(file_->input_height).empty();
391         setEnabled(file_->check_aspectratio, !disable_aspectRatio);
392
393         // the bb section
394         // set the bounding box values, if exists. First we need the whole
395         // path, because the controller knows nothing about the doc-dir
396         updateBB(igp.filename, igp.bb);
397         fl_set_button(bbox_->check_clip, igp.clip);
398
399
400         // the extra section
401         fl_set_input(extra_->input_rotate_angle,
402                      tostr(igp.rotateAngle).c_str());
403
404         int origin_pos;
405         if (igp.rotateOrigin.empty()) {
406                 origin_pos = 1;
407         } else {
408                 origin_pos = 2 + findPos(origins_, igp.rotateOrigin);
409         }
410         fl_set_choice(extra_->choice_origin, origin_pos);
411
412         fl_set_button(extra_->check_subcaption, igp.subcaption);
413         fl_set_input(extra_->input_subcaption, igp.subcaptionText.c_str());
414         setEnabled(extra_->input_subcaption,
415                    fl_get_button(extra_->check_subcaption));
416         fl_set_input(extra_->input_special, igp.special.c_str());
417
418         // open dialog in the file-tab, whenever filename is empty
419         if (igp.filename.empty()) {
420                 fl_set_folder(dialog_->tabfolder, file_->form);
421         }
422 }
423
424
425 void FormGraphics::updateBB(string const & filename, string const & bb_inset)
426 {
427         // Update dialog with details from inset
428         // set the bounding box values, if exists. First we need the whole
429         // path, because the controller knows nothing about the doc-dir
430         controller().bbChanged = false;
431         if (bb_inset.empty()) {
432                 lyxerr[Debug::GRAPHICS] << "FormGraphics::updateBB() [no BoundingBox]" << endl;
433                 string const bb = controller().readBB(filename);
434                 if (!bb.empty()) {
435                         // get the values from the file
436                         // in this case we always have the point-unit
437                         fl_set_input(bbox_->input_bb_x0,
438                                      token(bb,' ',0).c_str());
439                         fl_set_input(bbox_->input_bb_y0,
440                                      token(bb,' ',1).c_str());
441                         fl_set_input(bbox_->input_bb_x1,
442                                      token(bb,' ',2).c_str());
443                         fl_set_input(bbox_->input_bb_y1,
444                                      token(bb,' ',3).c_str());
445
446                 } else {
447                         // no bb from file
448                         fl_set_input(bbox_->input_bb_x0, bb.c_str());
449                         fl_set_input(bbox_->input_bb_y0, bb.c_str());
450                         fl_set_input(bbox_->input_bb_x1, bb.c_str());
451                         fl_set_input(bbox_->input_bb_y1, bb.c_str());
452                 }
453                 // "bp"
454                 fl_set_choice(bbox_->choice_bb_units, 1);
455
456         } else {
457                 // get the values from the inset
458                 lyxerr[Debug::GRAPHICS] << "FormGraphics::updateBB(): igp has BoundingBox"
459                                         << " ["<< bb_inset << "]"
460                                         << endl;
461                 controller().bbChanged = true;
462
463                 LyXLength anyLength;
464                 anyLength = LyXLength(token(bb_inset,' ',0));
465                 updateWidgetsFromLength(bbox_->input_bb_x0,
466                                         bbox_->choice_bb_units,anyLength,"bp");
467                 anyLength = LyXLength(token(bb_inset,' ',1));
468                 updateWidgetsFromLength(bbox_->input_bb_y0,
469                                         bbox_->choice_bb_units,anyLength,"bp");
470                 anyLength = LyXLength(token(bb_inset,' ',2));
471                 updateWidgetsFromLength(bbox_->input_bb_x1,
472                                         bbox_->choice_bb_units,anyLength,"bp");
473                 anyLength = LyXLength(token(bb_inset,' ',3));
474                 updateWidgetsFromLength(bbox_->input_bb_y1,
475                                         bbox_->choice_bb_units,anyLength,"bp");
476         }
477 }
478
479
480 namespace {
481
482 bool isValid(FL_OBJECT * ob)
483 {
484         string const input = getString(ob);
485         return input.empty() || isValidLength(input) || isStrDbl(input);
486 }
487
488 } // namespace anon
489
490
491
492 ButtonPolicy::SMInput FormGraphics::input(FL_OBJECT * ob, long)
493 {
494         // the file section
495         if (ob == file_->button_browse) {
496                 // Get the filename from the dialog
497                 string const in_name = getString(file_->input_filename);
498                 string const out_name = controller().Browse(in_name);
499                 lyxerr[Debug::GRAPHICS] << "[FormGraphics]out_name: " << out_name << endl;
500                 if (out_name != in_name && !out_name.empty()) {
501                         fl_set_input(file_->input_filename, out_name.c_str());
502                 }
503                 if (controller().isFilenameValid(out_name) &&
504                     !controller().bbChanged) {
505                         updateBB(out_name, string());
506                 }
507         } else if (ob == file_->input_width || ob == file_->input_height) {
508                 // disable aspectratio button in case of scaling or one of width/height is empty
509                 bool const disable = fl_get_choice(file_->choice_width) == 1 ||
510                                     getString(file_->input_width).empty() ||
511                                     getString(file_->input_height).empty();
512                 setEnabled(file_->check_aspectratio, !disable);
513         } else if (ob == file_->choice_width) {
514                 // disable height input in case of scaling
515                 bool const scaling = fl_get_choice(file_->choice_width) == 1;
516                 setEnabled(file_->input_height, !scaling);
517                 setEnabled(file_->choice_height, !scaling);
518                 
519                 // allow only integer intput for scaling; float otherwise
520                 if (scaling) {
521                         fl_set_input_filter(file_->input_width, fl_unsigned_int_filter);
522                         fl_set_input_maxchars(file_->input_width, 0);
523                 } else {
524                         fl_set_input_filter(file_->input_width, NULL);
525                         fl_set_input_maxchars(file_->input_width, SIZE_MAXDIGITS);
526                 }
527
528                 // disable aspectratio button in case of scaling or height input is empty
529                 bool const disable_aspectratio = scaling || getString(file_->input_height).empty();
530                 setEnabled(file_->check_aspectratio, !disable_aspectratio);
531         // the bb section
532         } else if (!controller().bbChanged &&
533                    (ob == bbox_->check_clip  || ob == bbox_->choice_bb_units ||
534                     ob == bbox_->input_bb_x0 || ob == bbox_->input_bb_y0 ||
535                     ob == bbox_->input_bb_x1 || ob == bbox_->input_bb_y1)) {
536                 controller().bbChanged = true;
537         } else if (ob == bbox_->button_getBB) {
538                 string const filename = getString(file_->input_filename);
539                 if (!filename.empty()) {
540                         string bb = controller().readBB(filename);
541                         if (!bb.empty()) {
542                                 fl_set_input(bbox_->input_bb_x0, token(bb,' ',0).c_str());
543                                 fl_set_input(bbox_->input_bb_y0, token(bb,' ',1).c_str());
544                                 fl_set_input(bbox_->input_bb_x1, token(bb,' ',2).c_str());
545                                 fl_set_input(bbox_->input_bb_y1, token(bb,' ',3).c_str());
546                                 fl_set_choice_text(bbox_->choice_bb_units, "bp");
547                         }
548                         controller().bbChanged = false;
549                 } else {
550                         fl_set_input(bbox_->input_bb_x0, "");
551                         fl_set_input(bbox_->input_bb_y0, "");
552                         fl_set_input(bbox_->input_bb_x1, "");
553                         fl_set_input(bbox_->input_bb_y1, "");
554                         fl_set_choice_text(bbox_->choice_bb_units, "bp");
555                 }
556         // the extra section
557         } else if (ob == extra_->check_subcaption) {
558                 setEnabled(extra_->input_subcaption,
559                            fl_get_button(extra_->check_subcaption));
560
561         }
562
563         // check if the input is valid
564         bool const invalid = !isValid(file_->input_width) || !isValid(file_->input_height);
565
566         // deactivate OK / Apply buttons and spit out warnings if invalid
567         if (invalid) {
568                 postWarning(_("Invalid Length in Output size!"));
569                 return ButtonPolicy::SMI_INVALID;
570         } else {
571                 clearMessage();
572                 return ButtonPolicy::SMI_VALID;
573         }
574 }