2 * \file GuiExternal.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Angus Leeming
9 * Full author contact details are available in file CREDITS.
14 #include "lengthcommon.h"
17 #include "controllers/ButtonController.h"
19 #include "insets/ExternalTemplate.h"
20 #include "insets/InsetExternal.h"
22 #include "support/lstrings.h"
23 #include "support/convert.h"
24 #include "support/os.h"
25 #include "support/lyxlib.h"
27 #include "GuiExternal.h"
30 #include "LengthCombo.h"
31 #include "qt_helpers.h"
32 #include "Validator.h"
35 #include <QPushButton>
38 #include <QTextBrowser>
40 namespace external = lyx::external;
42 using lyx::support::isStrDbl;
43 using lyx::support::token;
44 using lyx::support::trim;
45 using lyx::support::float_equal;
47 using lyx::support::os::internal_path;
57 /////////////////////////////////////////////////////////////////////
61 /////////////////////////////////////////////////////////////////////
64 GuiExternalDialog::GuiExternalDialog(GuiExternal * form)
68 connect(okPB, SIGNAL(clicked()), form, SLOT(slotOK()));
69 connect(applyPB, SIGNAL(clicked()), form, SLOT(slotApply()));
70 connect(closePB, SIGNAL(clicked()), form, SLOT(slotClose()));
72 connect(displayCB, SIGNAL(toggled(bool)),
73 showCO, SLOT(setEnabled(bool)));
74 connect(displayCB, SIGNAL(toggled(bool)),
75 displayscaleED, SLOT(setEnabled(bool)));
76 connect(showCO, SIGNAL(activated(const QString&)),
77 this, SLOT(change_adaptor()));
78 connect(originCO, SIGNAL(activated(int)),
79 this, SLOT(change_adaptor()));
80 connect(aspectratioCB, SIGNAL(stateChanged(int)),
81 this, SLOT(change_adaptor()));
82 connect(browsePB, SIGNAL(clicked()),
83 this, SLOT(browseClicked()));
84 connect(editPB, SIGNAL(clicked()),
85 this, SLOT(editClicked()));
86 connect(externalCO, SIGNAL(activated(const QString &)),
87 this, SLOT(templateChanged()));
88 connect(extraED, SIGNAL(textChanged(const QString &)),
89 this, SLOT(extraChanged(const QString&)));
90 connect(extraFormatCO, SIGNAL(activated(const QString &)),
91 this, SLOT(formatChanged(const QString&)));
92 connect(widthUnitCO, SIGNAL(activated(int)),
93 this, SLOT(widthUnitChanged()));
94 connect(heightUnitCO, SIGNAL(selectionChanged(lyx::Length::UNIT)),
95 this, SLOT(change_adaptor()));
96 connect(displayCB, SIGNAL(stateChanged(int)),
97 this, SLOT(change_adaptor()));
98 connect(displayscaleED, SIGNAL(textChanged(const QString &)),
99 this, SLOT(change_adaptor()));
100 connect(angleED, SIGNAL(textChanged(const QString &)),
101 this, SLOT(change_adaptor()));
102 connect(widthED, SIGNAL(textChanged(const QString &)),
103 this, SLOT(sizeChanged()));
104 connect(heightED, SIGNAL(textChanged(const QString &)),
105 this, SLOT(sizeChanged()));
106 connect(fileED, SIGNAL(textChanged(const QString &)),
107 this, SLOT(change_adaptor()));
108 connect(clipCB, SIGNAL(stateChanged(int)),
109 this, SLOT(change_adaptor()));
110 connect(getbbPB, SIGNAL(clicked()), this, SLOT(getbbClicked()));
111 connect(xrED, SIGNAL(textChanged(const QString &)), this, SLOT(bbChanged()));
112 connect(ytED, SIGNAL(textChanged(const QString &)), this, SLOT(bbChanged()));
113 connect(xlED, SIGNAL(textChanged(const QString &)), this, SLOT(bbChanged()));
114 connect(ybED, SIGNAL(textChanged(const QString &)), this, SLOT(bbChanged()));
115 connect(draftCB, SIGNAL(clicked()), this, SLOT(change_adaptor()));
117 QIntValidator * validator = new QIntValidator(displayscaleED);
118 validator->setBottom(1);
119 displayscaleED->setValidator(validator);
121 angleED->setValidator(new QDoubleValidator(-360, 360, 2, angleED));
123 xlED->setValidator(new QIntValidator(xlED));
124 ybED->setValidator(new QIntValidator(ybED));
125 xrED->setValidator(new QIntValidator(xrED));
126 ytED->setValidator(new QIntValidator(ytED));
128 widthED->setValidator(unsignedLengthValidator(widthED));
129 heightED->setValidator(unsignedLengthValidator(heightED));
131 setFocusProxy(fileED);
135 void GuiExternalDialog::show()
142 bool GuiExternalDialog::activateAspectratio() const
144 if (widthUnitCO->currentIndex() == 0)
147 string const wstr = fromqstr(widthED->text());
150 bool const wIsDbl = isStrDbl(wstr);
151 if (wIsDbl && float_equal(convert<double>(wstr), 0.0, 0.05))
154 if (!wIsDbl && (!isValidLength(wstr, &l) || l.zero()))
157 string const hstr = fromqstr(heightED->text());
160 bool const hIsDbl = isStrDbl(hstr);
161 if (hIsDbl && float_equal(convert<double>(hstr), 0.0, 0.05))
163 if (!hIsDbl && (!isValidLength(hstr, &l) || l.zero()))
170 void GuiExternalDialog::bbChanged()
172 form_->controller().bbChanged(true);
177 void GuiExternalDialog::browseClicked()
179 int const choice = externalCO->currentIndex();
180 docstring const template_name =
181 from_utf8(form_->controller().getTemplate(choice).lyxName);
182 docstring const str =
183 form_->controller().browse(qstring_to_ucs4(fileED->text()),
186 fileED->setText(toqstr(str));
192 void GuiExternalDialog::change_adaptor()
198 void GuiExternalDialog::closeEvent(QCloseEvent * e)
205 void GuiExternalDialog::editClicked()
207 form_->controller().editExternal();
212 void GuiExternalDialog::extraChanged(const QString& text)
214 std::string const format = fromqstr(extraFormatCO->currentText());
215 form_->extra_[format] = text;
220 void GuiExternalDialog::formatChanged(const QString& format)
222 extraED->setText(form_->extra_[fromqstr(format)]);
226 void GuiExternalDialog::getbbClicked()
232 void GuiExternalDialog::sizeChanged()
234 aspectratioCB->setEnabled(activateAspectratio());
239 void GuiExternalDialog::templateChanged()
241 form_->updateTemplate();
246 void GuiExternalDialog::widthUnitChanged()
248 bool useHeight = (widthUnitCO->currentIndex() > 0);
251 widthED->setValidator(unsignedLengthValidator(widthED));
253 widthED->setValidator(new QDoubleValidator(0, 1000, 2, widthED));
255 heightED->setEnabled(useHeight);
256 heightUnitCO->setEnabled(useHeight);
261 /////////////////////////////////////////////////////////////////////
265 /////////////////////////////////////////////////////////////////////
269 Length::UNIT defaultUnit()
271 Length::UNIT default_unit = Length::CM;
272 switch (lyxrc.default_papersize) {
275 case PAPER_USEXECUTIVE:
276 default_unit = Length::IN;
285 void setDisplay(QCheckBox & displayCB, QComboBox & showCO, QLineEdit & scaleED,
286 external::DisplayType display, unsigned int scale,
291 case external::DefaultDisplay:
294 case external::MonochromeDisplay:
297 case external::GrayscaleDisplay:
300 case external::ColorDisplay:
303 case external::PreviewDisplay:
306 case external::NoDisplay:
311 showCO.setCurrentIndex(item);
312 bool const no_display = display == external::NoDisplay;
313 showCO.setEnabled(!no_display && !read_only);
314 displayCB.setChecked(!no_display);
315 scaleED.setEnabled(!no_display && !read_only);
316 scaleED.setText(toqstr(convert<string>(scale)));
320 void getDisplay(external::DisplayType & display,
321 unsigned int & scale,
322 QCheckBox const & displayCB,
323 QComboBox const & showCO,
324 QLineEdit const & scaleED)
326 switch (showCO.currentIndex()) {
328 display = external::DefaultDisplay;
331 display = external::MonochromeDisplay;
334 display = external::GrayscaleDisplay;
337 display = external::ColorDisplay;
340 display = external::PreviewDisplay;
344 if (!displayCB.isChecked())
345 display = external::NoDisplay;
347 scale = convert<int>(fromqstr(scaleED.text()));
351 void setRotation(QLineEdit & angleED, QComboBox & originCO,
352 external::RotationData const & data)
354 originCO.setCurrentIndex(int(data.origin()));
355 angleED.setText(toqstr(data.angle));
359 void getRotation(external::RotationData & data,
360 QLineEdit const & angleED, QComboBox const & originCO)
362 typedef external::RotationData::OriginType OriginType;
364 data.origin(static_cast<OriginType>(originCO.currentIndex()));
365 data.angle = fromqstr(angleED.text());
369 void setSize(QLineEdit & widthED, QComboBox & widthUnitCO,
370 QLineEdit & heightED, LengthCombo & heightUnitCO,
371 QCheckBox & aspectratioCB,
372 external::ResizeData const & data)
374 bool using_scale = data.usingScale();
375 std::string scale = data.scale;
376 if (data.no_resize()) {
377 // Everything is zero, so default to this!
383 widthED.setText(toqstr(scale));
384 widthUnitCO.setCurrentIndex(0);
386 widthED.setText(toqstr(convert<string>(data.width.value())));
387 // Because 'Scale' is position 0...
388 // Note also that width cannot be zero here, so
389 // we don't need to worry about the default unit.
390 widthUnitCO.setCurrentIndex(data.width.unit() + 1);
393 string const h = data.height.zero() ? string() : data.height.asString();
394 Length::UNIT default_unit = data.width.zero() ?
395 defaultUnit() : data.width.unit();
396 lengthToWidgets(&heightED, &heightUnitCO, h, default_unit);
398 heightED.setEnabled(!using_scale);
399 heightUnitCO.setEnabled(!using_scale);
401 aspectratioCB.setChecked(data.keepAspectRatio);
403 bool const disable_aspectRatio = using_scale ||
404 data.width.zero() || data.height.zero();
405 aspectratioCB.setEnabled(!disable_aspectRatio);
409 void getSize(external::ResizeData & data,
410 QLineEdit const & widthED, QComboBox const & widthUnitCO,
411 QLineEdit const & heightED, LengthCombo const & heightUnitCO,
412 QCheckBox const & aspectratioCB)
414 string const width = fromqstr(widthED.text());
416 if (widthUnitCO.currentIndex() > 0) {
417 // Subtract one, because scale is 0.
418 int const unit = widthUnitCO.currentIndex() - 1;
421 if (isValidLength(width, &w))
423 else if (isStrDbl(width))
424 data.width = Length(convert<double>(width),
425 static_cast<Length::UNIT>(unit));
427 data.width = Length();
429 data.scale = string();
432 // scaling instead of a width
434 data.width = Length();
437 data.height = Length(widgetsToLength(&heightED, &heightUnitCO));
439 data.keepAspectRatio = aspectratioCB.isChecked();
443 void setCrop(QCheckBox & clipCB,
444 QLineEdit & xlED, QLineEdit & ybED,
445 QLineEdit & xrED, QLineEdit & ytED,
446 external::ClipData const & data)
448 clipCB.setChecked(data.clip);
449 graphics::BoundingBox const & bbox = data.bbox;
450 xlED.setText(toqstr(convert<string>(bbox.xl)));
451 ybED.setText(toqstr(convert<string>(bbox.yb)));
452 xrED.setText(toqstr(convert<string>(bbox.xr)));
453 ytED.setText(toqstr(convert<string>(bbox.yt)));
457 void getCrop(external::ClipData & data,
458 QCheckBox const & clipCB,
459 QLineEdit const & xlED, QLineEdit const & ybED,
460 QLineEdit const & xrED, QLineEdit const & ytED,
463 data.clip = clipCB.isChecked();
468 data.bbox.xl = convert<int>(fromqstr(xlED.text()));
469 data.bbox.yb = convert<int>(fromqstr(ybED.text()));
470 data.bbox.xr = convert<int>(fromqstr(xrED.text()));
471 data.bbox.yt = convert<int>(fromqstr(ytED.text()));
475 void getExtra(external::ExtraData & data,
476 GuiExternal::MapType const & extra)
478 typedef GuiExternal::MapType MapType;
479 MapType::const_iterator it = extra.begin();
480 MapType::const_iterator const end = extra.end();
481 for (; it != end; ++it)
482 data.set(it->first, trim(fromqstr(it->second)));
488 GuiExternal::GuiExternal(Dialog & parent)
489 : GuiView<GuiExternalDialog>(parent, _("External Material"))
493 void GuiExternal::build_dialog()
495 dialog_.reset(new GuiExternalDialog(this));
497 bcview().setOK(dialog_->okPB);
498 bcview().setApply(dialog_->applyPB);
499 bcview().setCancel(dialog_->closePB);
501 bcview().addReadOnly(dialog_->fileED);
502 bcview().addReadOnly(dialog_->browsePB);
503 bcview().addReadOnly(dialog_->editPB);
504 bcview().addReadOnly(dialog_->externalCO);
505 bcview().addReadOnly(dialog_->draftCB);
506 bcview().addReadOnly(dialog_->displayscaleED);
507 bcview().addReadOnly(dialog_->showCO);
508 bcview().addReadOnly(dialog_->displayCB);
509 bcview().addReadOnly(dialog_->angleED);
510 bcview().addReadOnly(dialog_->originCO);
511 bcview().addReadOnly(dialog_->heightUnitCO);
512 bcview().addReadOnly(dialog_->heightED);
513 bcview().addReadOnly(dialog_->aspectratioCB);
514 bcview().addReadOnly(dialog_->widthUnitCO);
515 bcview().addReadOnly(dialog_->widthED);
516 bcview().addReadOnly(dialog_->clipCB);
517 bcview().addReadOnly(dialog_->getbbPB);
518 bcview().addReadOnly(dialog_->ytED);
519 bcview().addReadOnly(dialog_->xlED);
520 bcview().addReadOnly(dialog_->xrED);
521 bcview().addReadOnly(dialog_->ybED);
522 bcview().addReadOnly(dialog_->extraFormatCO);
523 bcview().addReadOnly(dialog_->extraED);
525 addCheckedLineEdit(bcview(), dialog_->angleED, dialog_->angleLA);
526 addCheckedLineEdit(bcview(), dialog_->displayscaleED, dialog_->scaleLA);
527 addCheckedLineEdit(bcview(), dialog_->heightED, dialog_->heightLA);
528 addCheckedLineEdit(bcview(), dialog_->widthED, dialog_->widthLA);
529 addCheckedLineEdit(bcview(), dialog_->xlED, dialog_->lbLA);
530 addCheckedLineEdit(bcview(), dialog_->ybED, dialog_->lbLA);
531 addCheckedLineEdit(bcview(), dialog_->xrED, dialog_->rtLA);
532 addCheckedLineEdit(bcview(), dialog_->ytED, dialog_->rtLA);
533 addCheckedLineEdit(bcview(), dialog_->fileED, dialog_->fileLA);
535 std::vector<string> templates(controller().getTemplates());
537 for (std::vector<string>::const_iterator cit = templates.begin();
538 cit != templates.end(); ++cit) {
539 dialog_->externalCO->addItem(qt_(*cit));
542 // Fill the origins combo
543 typedef vector<external::RotationDataType> Origins;
544 Origins const & all_origins = external::all_origins();
545 for (Origins::size_type i = 0; i != all_origins.size(); ++i)
546 dialog_->originCO->addItem(toqstr(external::origin_gui_str(i)));
548 // Fill the width combo
549 dialog_->widthUnitCO->addItem(qt_("Scale%"));
550 for (int i = 0; i < num_units; i++)
551 dialog_->widthUnitCO->addItem(qt_(unit_name_gui[i]));
555 void GuiExternal::update_contents()
557 dialog_->tab->setCurrentIndex(0);
558 InsetExternalParams const & params = controller().params();
561 params.filename.outputFilename(kernel().bufferFilepath());
562 dialog_->fileED->setText(toqstr(name));
564 dialog_->externalCO->setCurrentIndex(
565 controller().getTemplateNumber(params.templatename()));
568 dialog_->draftCB->setChecked(params.draft);
570 setDisplay(*dialog_->displayCB, *dialog_->showCO,
571 *dialog_->displayscaleED,
572 params.display, params.lyxscale, readOnly());
574 setRotation(*dialog_->angleED, *dialog_->originCO, params.rotationdata);
576 setSize(*dialog_->widthED, *dialog_->widthUnitCO,
577 *dialog_->heightED, *dialog_->heightUnitCO,
578 *dialog_->aspectratioCB,
581 setCrop(*dialog_->clipCB,
582 *dialog_->xlED, *dialog_->ybED,
583 *dialog_->xrED, *dialog_->ytED,
585 controller().bbChanged(!params.clipdata.bbox.empty());
591 void GuiExternal::updateTemplate()
593 external::Template templ =
594 controller().getTemplate(dialog_->externalCO->currentIndex());
595 dialog_->externalTB->setPlainText(qt_(templ.helpText));
597 // Ascertain which (if any) transformations the template supports
598 // and disable tabs hosting unsupported transforms.
599 typedef vector<external::TransformID> TransformIDs;
600 TransformIDs const transformIds = templ.transformIds;
601 TransformIDs::const_iterator tr_begin = transformIds.begin();
602 TransformIDs::const_iterator const tr_end = transformIds.end();
604 bool found = find(tr_begin, tr_end, external::Rotate) != tr_end;
605 dialog_->tab->setTabEnabled(
606 dialog_->tab->indexOf(dialog_->rotatetab), found);
607 found = find(tr_begin, tr_end, external::Resize) != tr_end;
608 dialog_->tab->setTabEnabled(
609 dialog_->tab->indexOf(dialog_->scaletab), found);
611 found = find(tr_begin, tr_end, external::Clip) != tr_end;
612 dialog_->tab->setTabEnabled(
613 dialog_->tab->indexOf(dialog_->croptab), found);
615 found = find(tr_begin, tr_end, external::Extra) != tr_end;
616 dialog_->tab->setTabEnabled(
617 dialog_->tab->indexOf(dialog_->optionstab), found);
622 // Ascertain whether the template has any formats supporting
623 // the 'Extra' option
624 QLineEdit * const extraED = dialog_->extraED;
625 QComboBox * const extraCB = dialog_->extraFormatCO;
631 external::Template::Formats::const_iterator it = templ.formats.begin();
632 external::Template::Formats::const_iterator end = templ.formats.end();
633 for (; it != end; ++it) {
634 if (it->second.option_transformers.find(external::Extra) ==
635 it->second.option_transformers.end())
637 string const format = it->first;
638 string const opt = controller().params().extradata.get(format);
639 extraCB->addItem(toqstr(format));
640 extra_[format] = toqstr(opt);
643 bool const enabled = extraCB->count() > 0;
645 dialog_->tab->setTabEnabled(
646 dialog_->tab->indexOf(dialog_->optionstab), enabled);
647 extraED->setEnabled(enabled && !kernel().isBufferReadonly());
648 extraCB->setEnabled(enabled);
651 extraCB->setCurrentIndex(0);
652 extraED->setText(extra_[fromqstr(extraCB->currentText())]);
657 void GuiExternal::apply()
659 InsetExternalParams params = controller().params();
661 params.filename.set(internal_path(fromqstr(dialog_->fileED->text())),
662 kernel().bufferFilepath());
664 params.settemplate(controller().getTemplate(
665 dialog_->externalCO->currentIndex()).lyxName);
667 params.draft = dialog_->draftCB->isChecked();
669 getDisplay(params.display, params.lyxscale,
670 *dialog_->displayCB, *dialog_->showCO,
671 *dialog_->displayscaleED);
673 if (dialog_->tab->isTabEnabled(
674 dialog_->tab->indexOf(dialog_->rotatetab)))
675 getRotation(params.rotationdata,
676 *dialog_->angleED, *dialog_->originCO);
678 if (dialog_->tab->isTabEnabled(
679 dialog_->tab->indexOf(dialog_->scaletab)))
680 getSize(params.resizedata,
681 *dialog_->widthED, *dialog_->widthUnitCO,
682 *dialog_->heightED, *dialog_->heightUnitCO,
683 *dialog_->aspectratioCB);
685 if (dialog_->tab->isTabEnabled(
686 dialog_->tab->indexOf(dialog_->croptab)))
687 getCrop(params.clipdata,
689 *dialog_->xlED, *dialog_->ybED,
690 *dialog_->xrED, *dialog_->ytED,
691 controller().bbChanged());
693 if (dialog_->tab->isTabEnabled(
694 dialog_->tab->indexOf(dialog_->optionstab)))
695 getExtra(params.extradata, extra_);
697 controller().setParams(params);
701 void GuiExternal::getBB()
703 dialog_->xlED->setText("0");
704 dialog_->ybED->setText("0");
705 dialog_->xrED->setText("0");
706 dialog_->ytED->setText("0");
708 string const filename = fromqstr(dialog_->fileED->text());
709 if (filename.empty())
712 string const bb = controller().readBB(filename);
716 dialog_->xlED->setText(toqstr(token(bb, ' ', 0)));
717 dialog_->ybED->setText(toqstr(token(bb, ' ', 1)));
718 dialog_->xrED->setText(toqstr(token(bb, ' ', 2)));
719 dialog_->ytED->setText(toqstr(token(bb, ' ', 3)));
721 controller().bbChanged(false);
724 } // namespace frontend
727 #include "GuiExternal_moc.cpp"