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.
18 #include "BufferView.h"
20 #include "DispatchResult.h"
22 #include "FuncStatus.h"
23 #include "FuncRequest.h"
25 #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 BoxType btype = boxtranslator().find(params_.type);
148 if (btype == Frameless) {
149 if (params_.use_parbox)
150 label += _("Parbox");
152 label += _("Minipage");
154 label += boxtranslator_loc().find(btype);
159 setLabelColor(Color_foreground);
163 bool InsetBox::hasFixedWidth() const
165 return params_.inner_box || params_.special != "width";
169 void InsetBox::metrics(MetricsInfo & m, Dimension & dim) const
171 // back up textwidth.
172 int textwidth_backup = m.base.textwidth;
174 m.base.textwidth = params_.width.inPixels(m.base.textwidth);
175 InsetCollapsable::metrics(m, dim);
177 m.base.textwidth = textwidth_backup;
181 bool InsetBox::forceDefaultParagraphs(idx_type) const
183 return !params_.inner_box;
187 bool InsetBox::showInsetDialog(BufferView * bv) const
189 InsetBoxMailer(const_cast<InsetBox &>(*this)).showDialog(bv);
194 void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd)
196 switch (cmd.action) {
198 case LFUN_INSET_MODIFY: {
199 //lyxerr << "InsetBox::dispatch MODIFY" << endl;
200 InsetBoxMailer::string2params(to_utf8(cmd.argument()), params_);
201 setLayout(cur.buffer().params());
206 case LFUN_INSET_DIALOG_UPDATE:
207 InsetBoxMailer(*this).updateDialog(&cur.bv());
210 case LFUN_MOUSE_RELEASE:
211 if (cmd.button() == mouse_button::button3 && hitButton(cmd)) {
212 InsetBoxMailer(*this).showDialog(&cur.bv());
215 InsetCollapsable::doDispatch(cur, cmd);
219 InsetCollapsable::doDispatch(cur, cmd);
225 bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd,
226 FuncStatus & flag) const
228 switch (cmd.action) {
230 case LFUN_INSET_MODIFY:
231 case LFUN_INSET_DIALOG_UPDATE:
234 case LFUN_BREAK_PARAGRAPH:
235 if (params_.inner_box) {
236 return InsetCollapsable::getStatus(cur, cmd, flag);
243 return InsetCollapsable::getStatus(cur, cmd, flag);
248 int InsetBox::latex(Buffer const & buf, odocstream & os,
249 OutputParams const & runparams) const
251 BoxType btype = boxtranslator().find(params_.type);
253 string width_string = params_.width.asLatexString();
254 bool stdwidth(false);
255 if (params_.inner_box &&
256 (width_string.find("1.0\\columnwidth") != string::npos
257 || width_string.find("1.0\\textwidth") != string::npos)) {
263 width_string += " - 2\\fboxsep - 2\\fboxrule";
266 width_string += " - 2\\fboxsep - 0.8pt";
269 width_string += " - 2\\fboxsep - 1.6pt";
272 // Shadow falls outside right margin... opinions?
273 width_string += " - 2\\fboxsep - 2\\fboxrule"/* "-\\shadowsize"*/;
276 width_string += " - 2\\fboxsep - 7.5\\fboxrule - 1.0pt";
283 // Adapt to column/text width correctly also if paragraphs indented:
292 if (!params_.inner_box) {
294 // Special widths, see usrguide §3.5
296 if (params_.special != "none") {
297 os << "[" << params_.width.value()
298 << '\\' << from_utf8(params_.special)
301 os << '[' << from_ascii(width_string)
303 if (params_.hor_pos != 'c')
304 os << "[" << params_.hor_pos << "]";
316 os << "\\shadowbox{";
319 os << "\\doublebox{";
323 if (params_.inner_box) {
324 if (params_.use_parbox)
327 os << "\\begin{minipage}";
329 os << "[" << params_.pos << "]";
330 if (params_.height_special == "none") {
332 os << "[" << from_ascii(params_.height.asLatexString()) << "]";
335 // set no optional argument when the value is the default "1\height"
336 // (special units like \height are handled as "in")
337 // but when the user has chosen a non-default inner_pos, the height
338 // must be given: \minipage[pos][height][inner-pos]{width}
339 if ((params_.height != Length("1in") ||
340 params_.height_special != "totalheight") ||
341 params_.inner_pos != params_.pos) {
343 os << "[" << params_.height.value()
344 << "\\" << from_utf8(params_.height_special) << "]";
347 if (params_.inner_pos != params_.pos)
348 os << "[" << params_.inner_pos << "]";
351 os << '{' << from_ascii(width_string) << '}';
353 if (params_.use_parbox)
359 i += InsetText::latex(buf, os, runparams);
361 if (params_.inner_box) {
362 if (params_.use_parbox)
365 os << "%\n\\end{minipage}";
372 if (!params_.inner_box)
373 os << "}"; // for makebox
391 int InsetBox::plaintext(Buffer const & buf, odocstream & os,
392 OutputParams const & runparams) const
394 BoxType const btype = boxtranslator().find(params_.type);
397 case Frameless: break;
398 case Boxed: os << "[\n"; break;
399 case ovalbox: os << "(\n"; break;
400 case Ovalbox: os << "((\n"; break;
401 case Shadowbox: os << "[/\n"; break;
402 case Doublebox: os << "[[\n"; break;
405 InsetText::plaintext(buf, os, runparams);
409 case Frameless: os << "\n"; break;
410 case Boxed: os << "\n]"; len = 1; break;
411 case ovalbox: os << "\n)"; len = 1; break;
412 case Ovalbox: os << "\n))"; len = 2; break;
413 case Shadowbox: os << "\n/]"; len = 2; break;
414 case Doublebox: os << "\n]]"; len = 2; break;
417 return PLAINTEXT_NEWLINE + len; // len chars on a separate line
421 int InsetBox::docbook(Buffer const & buf, odocstream & os,
422 OutputParams const & runparams) const
424 return InsetText::docbook(buf, os, runparams);
428 void InsetBox::validate(LaTeXFeatures & features) const
430 BoxType btype = boxtranslator().find(params_.type);
435 features.require("calc");
441 features.require("calc");
442 features.require("fancybox");
445 InsetText::validate(features);
449 InsetBoxMailer::InsetBoxMailer(InsetBox & inset)
454 string const InsetBoxMailer::name_ = "box";
457 string const InsetBoxMailer::inset2string(Buffer const &) const
459 return params2string(inset_.params());
463 string const InsetBoxMailer::params2string(InsetBoxParams const & params)
466 data << "box" << ' ';
472 void InsetBoxMailer::string2params(string const & in,
473 InsetBoxParams & params)
475 params = InsetBoxParams(string());
479 istringstream data(in);
485 if (!lex || name != name_)
486 return print_mailer_error("InsetBoxMailer", in, 1, name_);
488 // This is part of the inset proper that is usually swallowed
489 // by Text::readInset
492 if (!lex || id != "Box")
493 return print_mailer_error("InsetBoxMailer", in, 2, "Box");
499 InsetBoxParams::InsetBoxParams(string const & label)
503 width(Length("100col%")),
508 height(Length("1in")),
509 height_special("totalheight") // default is 1\\totalheight
513 void InsetBoxParams::write(ostream & os) const
515 os << "Box " << type << "\n";
516 os << "position \"" << pos << "\"\n";
517 os << "hor_pos \"" << hor_pos << "\"\n";
518 os << "has_inner_box " << inner_box << "\n";
519 os << "inner_pos \"" << inner_pos << "\"\n";
520 os << "use_parbox " << use_parbox << "\n";
521 os << "width \"" << width.asString() << "\"\n";
522 os << "special \"" << special << "\"\n";
523 os << "height \"" << height.asString() << "\"\n";
524 os << "height_special \"" << height_special << "\"\n";
528 void InsetBoxParams::read(Lexer & lex)
534 type = lex.getString();
541 token = lex.getString();
544 if (token == "position") {
546 // The [0] is needed. We need the first and only char in
548 pos = lex.getString()[0];
550 lyxerr << "InsetBox::Read: Missing 'position'-tag!" << token << endl;
551 lex.pushToken(token);
555 token = lex.getString();
558 if (token == "hor_pos") {
560 hor_pos = lex.getString()[0];
562 lyxerr << "InsetBox::Read: Missing 'hor_pos'-tag!" << token << endl;
563 lex.pushToken(token);
567 token = lex.getString();
570 if (token == "has_inner_box") {
572 inner_box = lex.getInteger();
574 lyxerr << "InsetBox::Read: Missing 'has_inner_box'-tag!" << endl;
575 lex.pushToken(token);
579 token = lex.getString();
582 if (token == "inner_pos") {
584 inner_pos = lex.getString()[0];
586 lyxerr << "InsetBox::Read: Missing 'inner_pos'-tag!"
588 lex.pushToken(token);
592 token = lex.getString();
595 if (token == "use_parbox") {
597 use_parbox = lex.getInteger();
599 lyxerr << "InsetBox::Read: Missing 'use_parbox'-tag!" << endl;
600 lex.pushToken(token);
604 token = lex.getString();
607 if (token == "width") {
609 width = Length(lex.getString());
611 lyxerr << "InsetBox::Read: Missing 'width'-tag!" << endl;
612 lex.pushToken(token);
616 token = lex.getString();
619 if (token == "special") {
621 special = lex.getString();
623 lyxerr << "InsetBox::Read: Missing 'special'-tag!" << endl;
624 lex.pushToken(token);
628 token = lex.getString();
631 if (token == "height") {
633 height = Length(lex.getString());
635 lyxerr << "InsetBox::Read: Missing 'height'-tag!" << endl;
636 lex.pushToken(token);
640 token = lex.getString();
643 if (token == "height_special") {
645 height_special = lex.getString();
647 lyxerr << "InsetBox::Read: Missing 'height_special'-tag!" << endl;
648 lex.pushToken(token);