3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Angus Leeming
7 * \author Martin Vermeer
8 * \author Jürgen Spitzmüller
10 * Full author contact details are available in file CREDITS.
17 #include "BufferView.h"
19 #include "DispatchResult.h"
21 #include "FuncStatus.h"
22 #include "FuncRequest.h"
24 #include "LaTeXFeatures.h"
27 #include "MetricsInfo.h"
29 #include "support/Translator.h"
37 using std::istringstream;
39 using std::ostringstream;
45 typedef Translator<std::string, InsetBox::BoxType> BoxTranslator;
46 typedef Translator<docstring, InsetBox::BoxType> BoxTranslatorLoc;
48 BoxTranslator const init_boxtranslator()
50 BoxTranslator translator("Boxed", InsetBox::Boxed);
51 translator.addPair("Frameless", InsetBox::Frameless);
52 translator.addPair("ovalbox", InsetBox::ovalbox);
53 translator.addPair("Ovalbox", InsetBox::Ovalbox);
54 translator.addPair("Shadowbox", InsetBox::Shadowbox);
55 translator.addPair("Doublebox",InsetBox::Doublebox);
60 BoxTranslatorLoc const init_boxtranslator_loc()
62 BoxTranslatorLoc translator(_("Boxed"), InsetBox::Boxed);
63 translator.addPair(_("Frameless"), InsetBox::Frameless);
64 translator.addPair(_("ovalbox"), InsetBox::ovalbox);
65 translator.addPair(_("Ovalbox"), InsetBox::Ovalbox);
66 translator.addPair(_("Shadowbox"), InsetBox::Shadowbox);
67 translator.addPair(_("Doublebox"), InsetBox::Doublebox);
72 BoxTranslator const & boxtranslator()
74 static BoxTranslator translator = init_boxtranslator();
79 BoxTranslatorLoc const & boxtranslator_loc()
81 static BoxTranslatorLoc translator = init_boxtranslator_loc();
94 InsetBox::InsetBox(BufferParams const & bp, string const & label)
95 : InsetCollapsable(bp), params_(label)
101 InsetBox::InsetBox(InsetBox const & in)
102 : InsetCollapsable(in), params_(in.params_)
108 InsetBox::~InsetBox()
110 InsetBoxMailer(*this).hideDialog();
114 Inset * InsetBox::clone() const
116 return new InsetBox(*this);
120 docstring const InsetBox::editMessage() const
122 return _("Opened Box Inset");
126 void InsetBox::write(Buffer const & buf, ostream & os) const
129 InsetCollapsable::write(buf, os);
133 void InsetBox::read(Buffer const & buf, Lexer & lex)
136 InsetCollapsable::read(buf, lex);
141 void InsetBox::setButtonLabel()
143 Font font(Font::ALL_SANE);
147 BoxType btype = boxtranslator().find(params_.type);
152 if (btype == Frameless) {
153 if (params_.use_parbox)
154 label += _("Parbox");
156 label += _("Minipage");
158 label += boxtranslator_loc().find(btype);
163 font.setColor(Color::foreground);
168 bool InsetBox::hasFixedWidth() const
170 return params_.inner_box || params_.special != "width";
174 void InsetBox::metrics(MetricsInfo & m, Dimension & dim) const
176 // back up textwidth.
177 int textwidth_backup = m.base.textwidth;
179 m.base.textwidth = params_.width.inPixels(m.base.textwidth);
180 InsetCollapsable::metrics(m, dim);
182 m.base.textwidth = textwidth_backup;
186 bool InsetBox::forceDefaultParagraphs(idx_type) const
188 return !params_.inner_box;
192 bool InsetBox::showInsetDialog(BufferView * bv) const
194 InsetBoxMailer(const_cast<InsetBox &>(*this)).showDialog(bv);
199 void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd)
201 switch (cmd.action) {
203 case LFUN_INSET_MODIFY: {
204 //lyxerr << "InsetBox::dispatch MODIFY" << endl;
205 InsetBoxMailer::string2params(to_utf8(cmd.argument()), params_);
210 case LFUN_INSET_DIALOG_UPDATE:
211 InsetBoxMailer(*this).updateDialog(&cur.bv());
214 case LFUN_MOUSE_RELEASE:
215 if (cmd.button() == mouse_button::button3 && hitButton(cmd)) {
216 InsetBoxMailer(*this).showDialog(&cur.bv());
219 InsetCollapsable::doDispatch(cur, cmd);
223 InsetCollapsable::doDispatch(cur, cmd);
229 bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd,
230 FuncStatus & flag) const
232 switch (cmd.action) {
234 case LFUN_INSET_MODIFY:
235 case LFUN_INSET_DIALOG_UPDATE:
238 case LFUN_BREAK_PARAGRAPH:
239 if (params_.inner_box) {
240 return InsetCollapsable::getStatus(cur, cmd, flag);
247 return InsetCollapsable::getStatus(cur, cmd, flag);
252 int InsetBox::latex(Buffer const & buf, odocstream & os,
253 OutputParams const & runparams) const
255 BoxType btype = boxtranslator().find(params_.type);
257 string width_string = params_.width.asLatexString();
258 bool stdwidth(false);
259 if (params_.inner_box &&
260 (width_string.find("1.0\\columnwidth") != string::npos
261 || width_string.find("1.0\\textwidth") != string::npos)) {
267 width_string += " - 2\\fboxsep - 2\\fboxrule";
270 width_string += " - 2\\fboxsep - 0.8pt";
273 width_string += " - 2\\fboxsep - 1.6pt";
276 // Shadow falls outside right margin... opinions?
277 width_string += " - 2\\fboxsep - 2\\fboxrule"/* "-\\shadowsize"*/;
280 width_string += " - 2\\fboxsep - 7.5\\fboxrule - 1.0pt";
287 // Adapt to column/text width correctly also if paragraphs indented:
296 if (!params_.inner_box) {
298 // Special widths, see usrguide §3.5
300 if (params_.special != "none") {
301 os << "[" << params_.width.value()
302 << '\\' << from_utf8(params_.special)
305 os << '[' << from_ascii(width_string)
307 if (params_.hor_pos != 'c')
308 os << "[" << params_.hor_pos << "]";
320 os << "\\shadowbox{";
323 os << "\\doublebox{";
327 if (params_.inner_box) {
328 if (params_.use_parbox)
331 os << "\\begin{minipage}";
333 os << "[" << params_.pos << "]";
334 if (params_.height_special == "none") {
336 os << "[" << from_ascii(params_.height.asLatexString()) << "]";
339 // set no optional argument when the value is the default "1\height"
340 // (special units like \height are handled as "in")
341 // but when the user has chosen a non-default inner_pos, the height
342 // must be given: \minipage[pos][height][inner-pos]{width}
343 if (params_.height != Length("1in") ||
344 params_.inner_pos != params_.pos) {
346 os << "[" << params_.height.value()
347 << "\\" << from_utf8(params_.height_special) << "]";
350 if (params_.inner_pos != params_.pos)
351 os << "[" << params_.inner_pos << "]";
354 os << '{' << from_ascii(width_string) << '}';
356 if (params_.use_parbox)
362 i += InsetText::latex(buf, os, runparams);
364 if (params_.inner_box) {
365 if (params_.use_parbox)
368 os << "%\n\\end{minipage}";
375 if (!params_.inner_box)
376 os << "}"; // for makebox
394 int InsetBox::plaintext(Buffer const & buf, odocstream & os,
395 OutputParams const & runparams) const
397 BoxType const btype = boxtranslator().find(params_.type);
400 case Frameless: break;
401 case Boxed: os << "[\n"; break;
402 case ovalbox: os << "(\n"; break;
403 case Ovalbox: os << "((\n"; break;
404 case Shadowbox: os << "[/\n"; break;
405 case Doublebox: os << "[[\n"; break;
408 InsetText::plaintext(buf, os, runparams);
412 case Frameless: os << "\n"; break;
413 case Boxed: os << "\n]"; len = 1; break;
414 case ovalbox: os << "\n)"; len = 1; break;
415 case Ovalbox: os << "\n))"; len = 2; break;
416 case Shadowbox: os << "\n/]"; len = 2; break;
417 case Doublebox: os << "\n]]"; len = 2; break;
420 return PLAINTEXT_NEWLINE + len; // len chars on a separate line
424 int InsetBox::docbook(Buffer const & buf, odocstream & os,
425 OutputParams const & runparams) const
427 return InsetText::docbook(buf, os, runparams);
431 void InsetBox::validate(LaTeXFeatures & features) const
433 BoxType btype = boxtranslator().find(params_.type);
438 features.require("calc");
444 features.require("calc");
445 features.require("fancybox");
448 InsetText::validate(features);
452 InsetBoxMailer::InsetBoxMailer(InsetBox & inset)
457 string const InsetBoxMailer::name_ = "box";
460 string const InsetBoxMailer::inset2string(Buffer const &) const
462 return params2string(inset_.params());
466 string const InsetBoxMailer::params2string(InsetBoxParams const & params)
469 data << "box" << ' ';
475 void InsetBoxMailer::string2params(string const & in,
476 InsetBoxParams & params)
478 params = InsetBoxParams(string());
482 istringstream data(in);
488 if (!lex || name != name_)
489 return print_mailer_error("InsetBoxMailer", in, 1, name_);
491 // This is part of the inset proper that is usually swallowed
492 // by Text::readInset
495 if (!lex || id != "Box")
496 return print_mailer_error("InsetBoxMailer", in, 2, "Box");
502 InsetBoxParams::InsetBoxParams(string const & label)
506 width(Length("100col%")),
511 height(Length("1in")),
512 height_special("totalheight") // default is 1\\totalheight
516 void InsetBoxParams::write(ostream & os) const
518 os << "Box " << type << "\n";
519 os << "position \"" << pos << "\"\n";
520 os << "hor_pos \"" << hor_pos << "\"\n";
521 os << "has_inner_box " << inner_box << "\n";
522 os << "inner_pos \"" << inner_pos << "\"\n";
523 os << "use_parbox " << use_parbox << "\n";
524 os << "width \"" << width.asString() << "\"\n";
525 os << "special \"" << special << "\"\n";
526 os << "height \"" << height.asString() << "\"\n";
527 os << "height_special \"" << height_special << "\"\n";
531 void InsetBoxParams::read(Lexer & lex)
537 type = lex.getString();
544 token = lex.getString();
547 if (token == "position") {
549 // The [0] is needed. We need the first and only char in
551 pos = lex.getString()[0];
553 lyxerr << "InsetBox::Read: Missing 'position'-tag!" << token << endl;
554 lex.pushToken(token);
558 token = lex.getString();
561 if (token == "hor_pos") {
563 hor_pos = lex.getString()[0];
565 lyxerr << "InsetBox::Read: Missing 'hor_pos'-tag!" << token << endl;
566 lex.pushToken(token);
570 token = lex.getString();
573 if (token == "has_inner_box") {
575 inner_box = lex.getInteger();
577 lyxerr << "InsetBox::Read: Missing 'has_inner_box'-tag!" << endl;
578 lex.pushToken(token);
582 token = lex.getString();
585 if (token == "inner_pos") {
587 inner_pos = lex.getString()[0];
589 lyxerr << "InsetBox::Read: Missing 'inner_pos'-tag!"
591 lex.pushToken(token);
595 token = lex.getString();
598 if (token == "use_parbox") {
600 use_parbox = lex.getInteger();
602 lyxerr << "InsetBox::Read: Missing 'use_parbox'-tag!" << endl;
603 lex.pushToken(token);
607 token = lex.getString();
610 if (token == "width") {
612 width = Length(lex.getString());
614 lyxerr << "InsetBox::Read: Missing 'width'-tag!" << endl;
615 lex.pushToken(token);
619 token = lex.getString();
622 if (token == "special") {
624 special = lex.getString();
626 lyxerr << "InsetBox::Read: Missing 'special'-tag!" << endl;
627 lex.pushToken(token);
631 token = lex.getString();
634 if (token == "height") {
636 height = Length(lex.getString());
638 lyxerr << "InsetBox::Read: Missing 'height'-tag!" << endl;
639 lex.pushToken(token);
643 token = lex.getString();
646 if (token == "height_special") {
648 height_special = lex.getString();
650 lyxerr << "InsetBox::Read: Missing 'height_special'-tag!" << endl;
651 lex.pushToken(token);