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 // Qt defines a macro 'signals' that clashes with a boost namespace.
15 // All is well if the namespace is visible first.
16 #include "lengthcommon.h"
19 #include "controllers/ControlExternal.h"
21 #include "insets/ExternalTemplate.h"
22 #include "insets/insetexternal.h"
24 #include "support/lstrings.h"
25 #include "support/convert.h"
27 #include "QExternal.h"
28 #include "QExternalDialog.h"
31 #include "checkedwidgets.h"
32 #include "lengthcombo.h"
33 #include "qt_helpers.h"
34 #include "validators.h"
37 #include <QPushButton>
40 #include <QTextBrowser>
42 namespace external = lyx::external;
44 using lyx::support::isStrDbl;
45 using lyx::support::token;
46 using lyx::support::trim;
57 LyXLength::UNIT defaultUnit()
59 LyXLength::UNIT default_unit = LyXLength::CM;
60 switch (lyxrc.default_papersize) {
63 case PAPER_USEXECUTIVE:
64 default_unit = LyXLength::IN;
73 void setDisplay(QCheckBox & displayCB, QComboBox & showCO, QLineEdit & scaleED,
74 external::DisplayType display, unsigned int scale,
79 case external::DefaultDisplay:
82 case external::MonochromeDisplay:
85 case external::GrayscaleDisplay:
88 case external::ColorDisplay:
91 case external::PreviewDisplay:
94 case external::NoDisplay:
99 showCO.setCurrentIndex(item);
100 bool const no_display = display == external::NoDisplay;
101 showCO.setEnabled(!no_display && !read_only);
102 displayCB.setChecked(!no_display);
103 scaleED.setEnabled(!no_display && !read_only);
104 scaleED.setText(toqstr(convert<string>(scale)));
108 void getDisplay(external::DisplayType & display,
109 unsigned int & scale,
110 QCheckBox const & displayCB,
111 QComboBox const & showCO,
112 QLineEdit const & scaleED)
114 switch (showCO.currentIndex()) {
116 display = external::DefaultDisplay;
119 display = external::MonochromeDisplay;
122 display = external::GrayscaleDisplay;
125 display = external::ColorDisplay;
128 display = external::PreviewDisplay;
132 if (!displayCB.isChecked())
133 display = external::NoDisplay;
135 scale = convert<int>(fromqstr(scaleED.text()));
139 void setRotation(QLineEdit & angleED, QComboBox & originCO,
140 external::RotationData const & data)
142 originCO.setCurrentIndex(int(data.origin()));
143 angleED.setText(toqstr(data.angle));
147 void getRotation(external::RotationData & data,
148 QLineEdit const & angleED, QComboBox const & originCO)
150 typedef external::RotationData::OriginType OriginType;
152 data.origin(static_cast<OriginType>(originCO.currentIndex()));
153 data.angle = fromqstr(angleED.text());
157 void setSize(QLineEdit & widthED, QComboBox & widthUnitCO,
158 QLineEdit & heightED, LengthCombo & heightUnitCO,
159 QCheckBox & aspectratioCB,
160 external::ResizeData const & data)
162 bool using_scale = data.usingScale();
163 std::string scale = data.scale;
164 if (data.no_resize()) {
165 // Everything is zero, so default to this!
171 widthED.setText(toqstr(scale));
172 widthUnitCO.setCurrentIndex(0);
174 widthED.setText(toqstr(convert<string>(data.width.value())));
175 // Because 'Scale' is position 0...
176 // Note also that width cannot be zero here, so
177 // we don't need to worry about the default unit.
178 widthUnitCO.setCurrentIndex(data.width.unit() + 1);
181 string const h = data.height.zero() ? string() : data.height.asString();
182 LyXLength::UNIT default_unit = data.width.zero() ?
183 defaultUnit() : data.width.unit();
184 lengthToWidgets(&heightED, &heightUnitCO, h, default_unit);
186 heightED.setEnabled(!using_scale);
187 heightUnitCO.setEnabled(!using_scale);
189 aspectratioCB.setChecked(data.keepAspectRatio);
191 bool const disable_aspectRatio = using_scale ||
192 data.width.zero() || data.height.zero();
193 aspectratioCB.setEnabled(!disable_aspectRatio);
197 void getSize(external::ResizeData & data,
198 QLineEdit const & widthED, QComboBox const & widthUnitCO,
199 QLineEdit const & heightED, LengthCombo const & heightUnitCO,
200 QCheckBox const & aspectratioCB)
202 string const width = fromqstr(widthED.text());
204 if (widthUnitCO.currentIndex() > 0) {
205 // Subtract one, because scale is 0.
206 int const unit = widthUnitCO.currentIndex() - 1;
209 if (isValidLength(width, &w))
211 else if (isStrDbl(width))
212 data.width = LyXLength(convert<double>(width),
213 static_cast<LyXLength::UNIT>(unit));
215 data.width = LyXLength();
217 data.scale = string();
220 // scaling instead of a width
222 data.width = LyXLength();
225 data.height = LyXLength(widgetsToLength(&heightED, &heightUnitCO));
227 data.keepAspectRatio = aspectratioCB.isChecked();
231 void setCrop(QCheckBox & clipCB,
232 QLineEdit & xlED, QLineEdit & ybED,
233 QLineEdit & xrED, QLineEdit & ytED,
234 external::ClipData const & data)
236 clipCB.setChecked(data.clip);
237 graphics::BoundingBox const & bbox = data.bbox;
238 xlED.setText(toqstr(convert<string>(bbox.xl)));
239 ybED.setText(toqstr(convert<string>(bbox.yb)));
240 xrED.setText(toqstr(convert<string>(bbox.xr)));
241 ytED.setText(toqstr(convert<string>(bbox.yt)));
245 void getCrop(external::ClipData & data,
246 QCheckBox const & clipCB,
247 QLineEdit const & xlED, QLineEdit const & ybED,
248 QLineEdit const & xrED, QLineEdit const & ytED,
251 data.clip = clipCB.isChecked();
256 data.bbox.xl = convert<int>(fromqstr(xlED.text()));
257 data.bbox.yb = convert<int>(fromqstr(ybED.text()));
258 data.bbox.xr = convert<int>(fromqstr(xrED.text()));
259 data.bbox.yt = convert<int>(fromqstr(ytED.text()));
263 void getExtra(external::ExtraData & data,
264 QExternal::MapType const & extra)
266 typedef QExternal::MapType MapType;
267 MapType::const_iterator it = extra.begin();
268 MapType::const_iterator const end = extra.end();
269 for (; it != end; ++it)
270 data.set(it->first, trim(fromqstr(it->second)));
276 typedef QController<ControlExternal, QView<QExternalDialog> > base_class;
278 QExternal::QExternal(Dialog & parent)
279 : base_class(parent, _("External Material"))
283 void QExternal::build_dialog()
285 dialog_.reset(new QExternalDialog(this));
287 bcview().setOK(dialog_->okPB);
288 bcview().setApply(dialog_->applyPB);
289 bcview().setCancel(dialog_->closePB);
291 bcview().addReadOnly(dialog_->fileED);
292 bcview().addReadOnly(dialog_->browsePB);
293 bcview().addReadOnly(dialog_->editPB);
294 bcview().addReadOnly(dialog_->externalCO);
295 bcview().addReadOnly(dialog_->draftCB);
296 bcview().addReadOnly(dialog_->displayscaleED);
297 bcview().addReadOnly(dialog_->showCO);
298 bcview().addReadOnly(dialog_->displayCB);
299 bcview().addReadOnly(dialog_->angleED);
300 bcview().addReadOnly(dialog_->originCO);
301 bcview().addReadOnly(dialog_->heightUnitCO);
302 bcview().addReadOnly(dialog_->heightED);
303 bcview().addReadOnly(dialog_->aspectratioCB);
304 bcview().addReadOnly(dialog_->widthUnitCO);
305 bcview().addReadOnly(dialog_->widthED);
306 bcview().addReadOnly(dialog_->clipCB);
307 bcview().addReadOnly(dialog_->getbbPB);
308 bcview().addReadOnly(dialog_->ytED);
309 bcview().addReadOnly(dialog_->xlED);
310 bcview().addReadOnly(dialog_->xrED);
311 bcview().addReadOnly(dialog_->ybED);
312 bcview().addReadOnly(dialog_->extraFormatCO);
313 bcview().addReadOnly(dialog_->extraED);
315 addCheckedLineEdit(bcview(), dialog_->angleED, dialog_->angleLA);
316 addCheckedLineEdit(bcview(), dialog_->displayscaleED, dialog_->scaleLA);
317 addCheckedLineEdit(bcview(), dialog_->heightED, dialog_->heightLA);
318 addCheckedLineEdit(bcview(), dialog_->widthED, dialog_->widthLA);
319 addCheckedLineEdit(bcview(), dialog_->xlED, dialog_->lbLA);
320 addCheckedLineEdit(bcview(), dialog_->ybED, dialog_->lbLA);
321 addCheckedLineEdit(bcview(), dialog_->xrED, dialog_->rtLA);
322 addCheckedLineEdit(bcview(), dialog_->ytED, dialog_->rtLA);
323 addCheckedLineEdit(bcview(), dialog_->fileED, dialog_->fileLA);
325 std::vector<string> templates(controller().getTemplates());
327 for (std::vector<string>::const_iterator cit = templates.begin();
328 cit != templates.end(); ++cit) {
329 dialog_->externalCO->addItem(toqstr(*cit));
332 // Fill the origins combo
333 typedef vector<external::RotationDataType> Origins;
334 Origins const & all_origins = external::all_origins();
335 for (Origins::size_type i = 0; i != all_origins.size(); ++i)
336 dialog_->originCO->addItem(toqstr(external::origin_gui_str(i)));
338 // Fill the width combo
339 dialog_->widthUnitCO->addItem(qt_("Scale%"));
340 for (int i = 0; i < num_units; i++)
341 dialog_->widthUnitCO->addItem(unit_name_gui[i]);
345 void QExternal::update_contents()
347 PathValidator * path_validator = getPathValidator(dialog_->fileED);
349 path_validator->setChecker(kernel().docType(), lyxrc);
351 dialog_->tab->setCurrentIndex(0);
352 InsetExternalParams const & params = controller().params();
355 params.filename.outputFilename(kernel().bufferFilepath());
356 dialog_->fileED->setText(toqstr(name));
358 dialog_->externalCO->setCurrentIndex(
359 controller().getTemplateNumber(params.templatename()));
362 dialog_->draftCB->setChecked(params.draft);
364 setDisplay(*dialog_->displayCB, *dialog_->showCO,
365 *dialog_->displayscaleED,
366 params.display, params.lyxscale, readOnly());
368 setRotation(*dialog_->angleED, *dialog_->originCO, params.rotationdata);
370 setSize(*dialog_->widthED, *dialog_->widthUnitCO,
371 *dialog_->heightED, *dialog_->heightUnitCO,
372 *dialog_->aspectratioCB,
375 setCrop(*dialog_->clipCB,
376 *dialog_->xlED, *dialog_->ybED,
377 *dialog_->xrED, *dialog_->ytED,
379 controller().bbChanged(!params.clipdata.bbox.empty());
385 void QExternal::updateTemplate()
387 external::Template templ =
388 controller().getTemplate(dialog_->externalCO->currentIndex());
389 dialog_->externalTB->setPlainText(toqstr(templ.helpText));
391 // Ascertain which (if any) transformations the template supports
392 // and disable tabs hosting unsupported transforms.
393 typedef vector<external::TransformID> TransformIDs;
394 TransformIDs const transformIds = templ.transformIds;
395 TransformIDs::const_iterator tr_begin = transformIds.begin();
396 TransformIDs::const_iterator const tr_end = transformIds.end();
398 bool found = find(tr_begin, tr_end, external::Rotate) != tr_end;
399 dialog_->tab->setTabEnabled(
400 dialog_->tab->indexOf(dialog_->rotatetab), found);
401 found = find(tr_begin, tr_end, external::Resize) != tr_end;
402 dialog_->tab->setTabEnabled(
403 dialog_->tab->indexOf(dialog_->scaletab), found);
405 found = find(tr_begin, tr_end, external::Clip) != tr_end;
406 dialog_->tab->setTabEnabled(
407 dialog_->tab->indexOf(dialog_->croptab), found);
409 found = find(tr_begin, tr_end, external::Extra) != tr_end;
410 dialog_->tab->setTabEnabled(
411 dialog_->tab->indexOf(dialog_->optionstab), found);
416 // Ascertain whether the template has any formats supporting
417 // the 'Extra' option
418 QLineEdit * const extraED = dialog_->extraED;
419 QComboBox * const extraCB = dialog_->extraFormatCO;
425 external::Template::Formats::const_iterator it = templ.formats.begin();
426 external::Template::Formats::const_iterator end = templ.formats.end();
427 for (; it != end; ++it) {
428 if (it->second.option_transformers.find(external::Extra) ==
429 it->second.option_transformers.end())
431 string const format = it->first;
432 string const opt = controller().params().extradata.get(format);
433 extraCB->addItem(toqstr(format));
434 extra_[format] = toqstr(opt);
437 bool const enabled = extraCB->count() > 0;
439 dialog_->tab->setTabEnabled(
440 dialog_->tab->indexOf(dialog_->optionstab), enabled);
441 extraED->setEnabled(enabled && !kernel().isBufferReadonly());
442 extraCB->setEnabled(enabled);
445 extraCB->setCurrentIndex(0);
446 extraED->setText(extra_[fromqstr(extraCB->currentText())]);
451 void QExternal::apply()
453 InsetExternalParams params = controller().params();
455 params.filename.set(fromqstr(dialog_->fileED->text()),
456 kernel().bufferFilepath());
458 params.settemplate(controller().getTemplate(
459 dialog_->externalCO->currentIndex()).lyxName);
461 params.draft = dialog_->draftCB->isChecked();
463 getDisplay(params.display, params.lyxscale,
464 *dialog_->displayCB, *dialog_->showCO,
465 *dialog_->displayscaleED);
467 if (dialog_->tab->isTabEnabled(
468 dialog_->tab->indexOf(dialog_->rotatetab)))
469 getRotation(params.rotationdata,
470 *dialog_->angleED, *dialog_->originCO);
472 if (dialog_->tab->isTabEnabled(
473 dialog_->tab->indexOf(dialog_->scaletab)))
474 getSize(params.resizedata,
475 *dialog_->widthED, *dialog_->widthUnitCO,
476 *dialog_->heightED, *dialog_->heightUnitCO,
477 *dialog_->aspectratioCB);
479 if (dialog_->tab->isTabEnabled(
480 dialog_->tab->indexOf(dialog_->croptab)))
481 getCrop(params.clipdata,
483 *dialog_->xlED, *dialog_->ybED,
484 *dialog_->xrED, *dialog_->ytED,
485 controller().bbChanged());
487 if (dialog_->tab->isTabEnabled(
488 dialog_->tab->indexOf(dialog_->optionstab)))
489 getExtra(params.extradata, extra_);
491 controller().setParams(params);
495 void QExternal::getBB()
497 dialog_->xlED->setText("0");
498 dialog_->ybED->setText("0");
499 dialog_->xrED->setText("0");
500 dialog_->ytED->setText("0");
502 string const filename = fromqstr(dialog_->fileED->text());
503 if (filename.empty())
506 string const bb = controller().readBB(filename);
510 dialog_->xlED->setText(toqstr(token(bb, ' ', 0)));
511 dialog_->ybED->setText(toqstr(token(bb, ' ', 1)));
512 dialog_->xrED->setText(toqstr(token(bb, ' ', 2)));
513 dialog_->ytED->setText(toqstr(token(bb, ' ', 3)));
515 controller().bbChanged(false);
518 } // namespace frontend