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"
36 #include <qlineedit.h>
37 #include <qpushbutton.h>
38 #include <qcheckbox.h>
39 #include <qcombobox.h>
40 #include <qtabwidget.h>
41 #include <qtextview.h>
43 namespace external = lyx::external;
45 using lyx::support::isStrDbl;
46 using lyx::support::token;
47 using lyx::support::trim;
58 LyXLength::UNIT defaultUnit()
60 LyXLength::UNIT default_unit = LyXLength::CM;
61 switch (lyxrc.default_papersize) {
64 case PAPER_USEXECUTIVE:
65 default_unit = LyXLength::IN;
74 void setDisplay(QCheckBox & displayCB, QComboBox & showCO, QLineEdit & scaleED,
75 external::DisplayType display, unsigned int scale,
80 case external::DefaultDisplay:
83 case external::MonochromeDisplay:
86 case external::GrayscaleDisplay:
89 case external::ColorDisplay:
92 case external::PreviewDisplay:
95 case external::NoDisplay:
100 showCO.setCurrentItem(item);
101 bool const no_display = display == external::NoDisplay;
102 showCO.setEnabled(!no_display && !read_only);
103 displayCB.setChecked(!no_display);
104 scaleED.setEnabled(!no_display && !read_only);
105 scaleED.setText(toqstr(convert<string>(scale)));
109 void getDisplay(external::DisplayType & display,
110 unsigned int & scale,
111 QCheckBox const & displayCB,
112 QComboBox const & showCO,
113 QLineEdit const & scaleED)
115 switch (showCO.currentItem()) {
117 display = external::DefaultDisplay;
120 display = external::MonochromeDisplay;
123 display = external::GrayscaleDisplay;
126 display = external::ColorDisplay;
129 display = external::PreviewDisplay;
133 if (!displayCB.isChecked())
134 display = external::NoDisplay;
136 scale = convert<int>(fromqstr(scaleED.text()));
140 void setRotation(QLineEdit & angleED, QComboBox & originCO,
141 external::RotationData const & data)
143 originCO.setCurrentItem(int(data.origin()));
144 angleED.setText(toqstr(data.angle));
148 void getRotation(external::RotationData & data,
149 QLineEdit const & angleED, QComboBox const & originCO)
151 typedef external::RotationData::OriginType OriginType;
153 data.origin(static_cast<OriginType>(originCO.currentItem()));
154 data.angle = fromqstr(angleED.text());
158 void setSize(QLineEdit & widthED, QComboBox & widthUnitCO,
159 QLineEdit & heightED, LengthCombo & heightUnitCO,
160 QCheckBox & aspectratioCB,
161 external::ResizeData const & data)
163 bool using_scale = data.usingScale();
164 std::string scale = data.scale;
165 if (data.no_resize()) {
166 // Everything is zero, so default to this!
172 widthED.setText(toqstr(scale));
173 widthUnitCO.setCurrentItem(0);
175 widthED.setText(toqstr(convert<string>(data.width.value())));
176 // Because 'Scale' is position 0...
177 // Note also that width cannot be zero here, so
178 // we don't need to worry about the default unit.
179 widthUnitCO.setCurrentItem(data.width.unit() + 1);
182 string const h = data.height.zero() ? string() : data.height.asString();
183 LyXLength::UNIT default_unit = data.width.zero() ?
184 defaultUnit() : data.width.unit();
185 lengthToWidgets(&heightED, &heightUnitCO, h, default_unit);
187 heightED.setEnabled(!using_scale);
188 heightUnitCO.setEnabled(!using_scale);
190 aspectratioCB.setChecked(data.keepAspectRatio);
192 bool const disable_aspectRatio = using_scale ||
193 data.width.zero() || data.height.zero();
194 aspectratioCB.setEnabled(!disable_aspectRatio);
198 void getSize(external::ResizeData & data,
199 QLineEdit const & widthED, QComboBox const & widthUnitCO,
200 QLineEdit const & heightED, LengthCombo const & heightUnitCO,
201 QCheckBox const & aspectratioCB)
203 string const width = fromqstr(widthED.text());
205 if (widthUnitCO.currentItem() > 0) {
206 // Subtract one, because scale is 0.
207 int const unit = widthUnitCO.currentItem() - 1;
210 if (isValidLength(width, &w))
212 else if (isStrDbl(width))
213 data.width = LyXLength(convert<double>(width),
214 static_cast<LyXLength::UNIT>(unit));
216 data.width = LyXLength();
218 data.scale = string();
221 // scaling instead of a width
223 data.width = LyXLength();
226 data.height = LyXLength(widgetsToLength(&heightED, &heightUnitCO));
228 data.keepAspectRatio = aspectratioCB.isChecked();
232 void setCrop(QCheckBox & clipCB,
233 QLineEdit & xlED, QLineEdit & ybED,
234 QLineEdit & xrED, QLineEdit & ytED,
235 external::ClipData const & data)
237 clipCB.setChecked(data.clip);
238 graphics::BoundingBox const & bbox = data.bbox;
239 xlED.setText(toqstr(convert<string>(bbox.xl)));
240 ybED.setText(toqstr(convert<string>(bbox.yb)));
241 xrED.setText(toqstr(convert<string>(bbox.xr)));
242 ytED.setText(toqstr(convert<string>(bbox.yt)));
246 void getCrop(external::ClipData & data,
247 QCheckBox const & clipCB,
248 QLineEdit const & xlED, QLineEdit const & ybED,
249 QLineEdit const & xrED, QLineEdit const & ytED,
252 data.clip = clipCB.isChecked();
257 data.bbox.xl = convert<int>(fromqstr(xlED.text()));
258 data.bbox.yb = convert<int>(fromqstr(ybED.text()));
259 data.bbox.xr = convert<int>(fromqstr(xrED.text()));
260 data.bbox.yt = convert<int>(fromqstr(ytED.text()));
264 void getExtra(external::ExtraData & data,
265 QExternal::MapType const & extra)
267 typedef QExternal::MapType MapType;
268 MapType::const_iterator it = extra.begin();
269 MapType::const_iterator const end = extra.end();
270 for (; it != end; ++it)
271 data.set(it->first, trim(fromqstr(it->second)));
277 typedef QController<ControlExternal, QView<QExternalDialog> > base_class;
279 QExternal::QExternal(Dialog & parent)
280 : base_class(parent, _("External Material"))
284 void QExternal::build_dialog()
286 dialog_.reset(new QExternalDialog(this));
288 bcview().setOK(dialog_->okPB);
289 bcview().setApply(dialog_->applyPB);
290 bcview().setCancel(dialog_->closePB);
292 bcview().addReadOnly(dialog_->fileED);
293 bcview().addReadOnly(dialog_->browsePB);
294 bcview().addReadOnly(dialog_->editPB);
295 bcview().addReadOnly(dialog_->externalCO);
296 bcview().addReadOnly(dialog_->draftCB);
297 bcview().addReadOnly(dialog_->displayscaleED);
298 bcview().addReadOnly(dialog_->showCO);
299 bcview().addReadOnly(dialog_->displayCB);
300 bcview().addReadOnly(dialog_->angleED);
301 bcview().addReadOnly(dialog_->originCO);
302 bcview().addReadOnly(dialog_->heightUnitCO);
303 bcview().addReadOnly(dialog_->heightED);
304 bcview().addReadOnly(dialog_->aspectratioCB);
305 bcview().addReadOnly(dialog_->widthUnitCO);
306 bcview().addReadOnly(dialog_->widthED);
307 bcview().addReadOnly(dialog_->clipCB);
308 bcview().addReadOnly(dialog_->getbbPB);
309 bcview().addReadOnly(dialog_->ytED);
310 bcview().addReadOnly(dialog_->xlED);
311 bcview().addReadOnly(dialog_->xrED);
312 bcview().addReadOnly(dialog_->ybED);
313 bcview().addReadOnly(dialog_->extraFormatCO);
314 bcview().addReadOnly(dialog_->extraED);
316 addCheckedLineEdit(bcview(), dialog_->angleED, dialog_->angleLA);
317 addCheckedLineEdit(bcview(), dialog_->displayscaleED, dialog_->scaleLA);
318 addCheckedLineEdit(bcview(), dialog_->heightED, dialog_->heightLA);
319 addCheckedLineEdit(bcview(), dialog_->widthED, dialog_->widthLA);
320 addCheckedLineEdit(bcview(), dialog_->xlED, dialog_->lbLA);
321 addCheckedLineEdit(bcview(), dialog_->ybED, dialog_->lbLA);
322 addCheckedLineEdit(bcview(), dialog_->xrED, dialog_->rtLA);
323 addCheckedLineEdit(bcview(), dialog_->ytED, dialog_->rtLA);
324 addCheckedLineEdit(bcview(), dialog_->fileED, dialog_->fileLA);
326 std::vector<string> templates(controller().getTemplates());
328 for (std::vector<string>::const_iterator cit = templates.begin();
329 cit != templates.end(); ++cit) {
330 dialog_->externalCO->insertItem(toqstr(*cit), -1);
333 // Fill the origins combo
334 typedef vector<external::RotationDataType> Origins;
335 Origins const & all_origins = external::all_origins();
336 for (Origins::size_type i = 0; i != all_origins.size(); ++i)
337 dialog_->originCO->insertItem(toqstr(external::origin_gui_str(i)));
339 // Fill the width combo
340 dialog_->widthUnitCO->insertItem(qt_("Scale%"));
341 for (int i = 0; i < num_units; i++)
342 dialog_->widthUnitCO->insertItem(unit_name_gui[i], -1);
346 void QExternal::update_contents()
348 PathValidator * path_validator = getPathValidator(dialog_->fileED);
350 path_validator->setChecker(kernel().docType(), lyxrc);
352 dialog_->tab->setCurrentPage(0);
353 InsetExternalParams const & params = controller().params();
356 params.filename.outputFilename(kernel().bufferFilepath());
357 dialog_->fileED->setText(toqstr(name));
359 dialog_->externalCO->setCurrentItem(
360 controller().getTemplateNumber(params.templatename()));
363 dialog_->draftCB->setChecked(params.draft);
365 setDisplay(*dialog_->displayCB, *dialog_->showCO,
366 *dialog_->displayscaleED,
367 params.display, params.lyxscale, readOnly());
369 setRotation(*dialog_->angleED, *dialog_->originCO, params.rotationdata);
371 setSize(*dialog_->widthED, *dialog_->widthUnitCO,
372 *dialog_->heightED, *dialog_->heightUnitCO,
373 *dialog_->aspectratioCB,
376 setCrop(*dialog_->clipCB,
377 *dialog_->xlED, *dialog_->ybED,
378 *dialog_->xrED, *dialog_->ytED,
380 controller().bbChanged(!params.clipdata.bbox.empty());
386 void QExternal::updateTemplate()
388 external::Template templ =
389 controller().getTemplate(dialog_->externalCO->currentItem());
390 dialog_->externalTV->setText(toqstr(templ.helpText));
392 // Ascertain which (if any) transformations the template supports
393 // and disable tabs hosting unsupported transforms.
394 typedef vector<external::TransformID> TransformIDs;
395 TransformIDs const transformIds = templ.transformIds;
396 TransformIDs::const_iterator tr_begin = transformIds.begin();
397 TransformIDs::const_iterator const tr_end = transformIds.end();
399 bool found = find(tr_begin, tr_end, external::Rotate) != tr_end;
400 dialog_->tab->setTabEnabled(dialog_->rotatetab, found);
402 found = find(tr_begin, tr_end, external::Resize) != tr_end;
403 dialog_->tab->setTabEnabled(dialog_->scaletab, found);
405 found = find(tr_begin, tr_end, external::Clip) != tr_end;
406 dialog_->tab->setTabEnabled(dialog_->croptab, found);
408 found = find(tr_begin, tr_end, external::Extra) != tr_end;
409 dialog_->tab->setTabEnabled(dialog_->optionstab, found);
413 // Ascertain whether the template has any formats supporting
414 // the 'Extra' option
415 QLineEdit * const extraED = dialog_->extraED;
416 QComboBox * const extraCB = dialog_->extraFormatCO;
422 external::Template::Formats::const_iterator it = templ.formats.begin();
423 external::Template::Formats::const_iterator end = templ.formats.end();
424 for (; it != end; ++it) {
425 if (it->second.option_transformers.find(external::Extra) ==
426 it->second.option_transformers.end())
428 string const format = it->first;
429 string const opt = controller().params().extradata.get(format);
430 extraCB->insertItem(toqstr(format));
431 extra_[format] = toqstr(opt);
434 bool const enabled = extraCB->count() > 0;
436 dialog_->tab->setTabEnabled(dialog_->optionstab, enabled);
437 extraED->setEnabled(enabled && !kernel().isBufferReadonly());
438 extraCB->setEnabled(enabled);
441 extraCB->setCurrentItem(0);
442 extraED->setText(extra_[fromqstr(extraCB->currentText())]);
447 void QExternal::apply()
449 InsetExternalParams params = controller().params();
451 params.filename.set(fromqstr(dialog_->fileED->text()),
452 kernel().bufferFilepath());
454 params.settemplate(controller().getTemplate(
455 dialog_->externalCO->currentItem()).lyxName);
457 params.draft = dialog_->draftCB->isChecked();
459 getDisplay(params.display, params.lyxscale,
460 *dialog_->displayCB, *dialog_->showCO,
461 *dialog_->displayscaleED);
463 if (dialog_->tab->isTabEnabled(dialog_->rotatetab))
464 getRotation(params.rotationdata,
465 *dialog_->angleED, *dialog_->originCO);
467 if (dialog_->tab->isTabEnabled(dialog_->scaletab))
468 getSize(params.resizedata,
469 *dialog_->widthED, *dialog_->widthUnitCO,
470 *dialog_->heightED, *dialog_->heightUnitCO,
471 *dialog_->aspectratioCB);
473 if (dialog_->tab->isTabEnabled(dialog_->croptab))
474 getCrop(params.clipdata,
476 *dialog_->xlED, *dialog_->ybED,
477 *dialog_->xrED, *dialog_->ytED,
478 controller().bbChanged());
480 if (dialog_->tab->isTabEnabled(dialog_->optionstab))
481 getExtra(params.extradata, extra_);
483 controller().setParams(params);
487 void QExternal::getBB()
489 dialog_->xlED->setText("0");
490 dialog_->ybED->setText("0");
491 dialog_->xrED->setText("0");
492 dialog_->ytED->setText("0");
494 string const filename = fromqstr(dialog_->fileED->text());
495 if (filename.empty())
498 string const bb = controller().readBB(filename);
502 dialog_->xlED->setText(toqstr(token(bb, ' ', 0)));
503 dialog_->ybED->setText(toqstr(token(bb, ' ', 1)));
504 dialog_->xrED->setText(toqstr(token(bb, ' ', 2)));
505 dialog_->ytED->setText(toqstr(token(bb, ' ', 3)));
507 controller().bbChanged(false);
510 } // namespace frontend