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
11 * Full author contact details are available in file CREDITS.
19 #include "BufferParams.h"
20 #include "BufferView.h"
23 #include "DispatchResult.h"
24 #include "FuncStatus.h"
25 #include "FuncRequest.h"
26 #include "LaTeXFeatures.h"
28 #include "MetricsInfo.h"
29 #include "output_xhtml.h"
31 #include "texstream.h"
32 #include "TextClass.h"
34 #include "support/debug.h"
35 #include "support/docstream.h"
36 #include "support/gettext.h"
37 #include "support/lstrings.h"
38 #include "support/Translator.h"
40 #include "frontends/Application.h"
45 using namespace lyx::support;
51 typedef Translator<string, InsetBox::BoxType> BoxTranslator;
52 typedef Translator<docstring, InsetBox::BoxType> BoxTranslatorLoc;
54 BoxTranslator initBoxtranslator()
56 BoxTranslator translator("Boxed", InsetBox::Boxed);
57 translator.addPair("Frameless", InsetBox::Frameless);
58 translator.addPair("Framed", InsetBox::Framed);
59 translator.addPair("ovalbox", InsetBox::ovalbox);
60 translator.addPair("Ovalbox", InsetBox::Ovalbox);
61 translator.addPair("Shadowbox", InsetBox::Shadowbox);
62 translator.addPair("Shaded", InsetBox::Shaded);
63 translator.addPair("Doublebox",InsetBox::Doublebox);
68 BoxTranslatorLoc initBoxtranslatorLoc()
70 BoxTranslatorLoc translator(_("simple frame"), InsetBox::Boxed);
71 translator.addPair(_("frameless"), InsetBox::Frameless);
72 translator.addPair(_("simple frame, page breaks"), InsetBox::Framed);
73 translator.addPair(_("oval, thin"), InsetBox::ovalbox);
74 translator.addPair(_("oval, thick"), InsetBox::Ovalbox);
75 translator.addPair(_("drop shadow"), InsetBox::Shadowbox);
76 translator.addPair(_("shaded background"), InsetBox::Shaded);
77 translator.addPair(_("double frame"), InsetBox::Doublebox);
82 BoxTranslator const & boxtranslator()
84 static BoxTranslator const translator = initBoxtranslator();
89 BoxTranslatorLoc const & boxtranslator_loc()
91 static BoxTranslatorLoc const translator = initBoxtranslatorLoc();
98 /////////////////////////////////////////////////////////////////////////
102 /////////////////////////////////////////////////////////////////////////
104 InsetBox::InsetBox(Buffer * buffer, string const & label)
105 : InsetCollapsible(buffer), params_(label)
109 docstring InsetBox::layoutName() const
112 return from_ascii("Box:" + params_.type);
116 void InsetBox::write(ostream & os) const
119 InsetCollapsible::write(os);
123 void InsetBox::read(Lexer & lex)
126 InsetCollapsible::read(lex);
130 void InsetBox::setButtonLabel()
132 BoxType const btype = boxtranslator().find(params_.type);
134 docstring const type = _("Box");
137 if (params_.inner_box) {
138 if (params_.use_parbox)
140 else if (params_.use_makebox)
141 inner = _("Makebox");
143 inner = _("Minipage");
147 if (btype != Frameless)
148 frame = boxtranslator_loc().find(btype);
151 if (inner.empty() && frame.empty())
153 else if (inner.empty())
154 label = bformat(_("%1$s (%2$s)"),
156 else if (frame.empty())
157 label = bformat(_("%1$s (%2$s)"),
160 label = bformat(_("%1$s (%2$s, %3$s)"),
164 // set the frame color for the inset if the type is Boxed
166 setFrameColor(lcolor.getFromLaTeXName(params_.framecolor));
168 setFrameColor(Color_collapsibleframe);
172 bool InsetBox::hasFixedWidth() const
174 return !params_.width.empty() && params_.special == "none";
178 bool InsetBox::allowMultiPar() const
180 return (params_.inner_box && !params_.use_makebox)
181 || params_.type == "Shaded" || params_.type == "Framed";
185 void InsetBox::metrics(MetricsInfo & mi, Dimension & dim) const
187 // back up textwidth.
188 int textwidth_backup = mi.base.textwidth;
190 mi.base.textwidth = mi.base.inPixels(params_.width);
191 InsetCollapsible::metrics(mi, dim);
193 mi.base.textwidth = textwidth_backup;
197 bool InsetBox::forcePlainLayout(idx_type) const
199 return (!params_.inner_box || params_.use_makebox)
200 && params_.type != "Shaded" && params_.type != "Framed";
204 bool InsetBox::needsCProtection(bool const maintext, bool const fragile) const
206 // We need to cprotect boxes that use minipages as inner box
207 // in fragile context
208 if (fragile && params_.inner_box && !params_.use_parbox && !params_.use_makebox)
211 return InsetText::needsCProtection(maintext, fragile);
215 ColorCode InsetBox::backgroundColor(PainterInfo const &) const
217 // we only support background color for 3 types
218 if (params_.type != "Shaded" && params_.type != "Frameless" && params_.type != "Boxed")
219 return getLayout().bgcolor();
221 if (params_.type == "Shaded") {
222 // FIXME: This hardcoded color is a hack!
223 if (buffer().params().boxbgcolor == lyx::rgbFromHexName("#ff0000"))
224 return getLayout().bgcolor();
226 ColorCode c = lcolor.getFromLyXName("boxbgcolor");
228 return getLayout().bgcolor();
232 if (params_.backgroundcolor != "none")
233 return lcolor.getFromLaTeXName(params_.backgroundcolor);
235 return getLayout().bgcolor();
239 LyXAlignment InsetBox::contentAlignment() const
241 // Custom horizontal alignment is only allowed with a fixed width
242 // and if either makebox or no inner box are used
243 if (params_.width.empty() || !(params_.use_makebox || !params_.inner_box))
244 return LYX_ALIGN_NONE;
246 // The default value below is actually irrelevant
247 LyXAlignment align = LYX_ALIGN_NONE;
248 switch (params_.hor_pos) {
250 align = LYX_ALIGN_LEFT;
253 align = LYX_ALIGN_CENTER;
256 align = LYX_ALIGN_RIGHT;
259 align = LYX_ALIGN_BLOCK;
266 void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd)
268 switch (cmd.action()) {
270 case LFUN_INSET_MODIFY: {
271 //lyxerr << "InsetBox::dispatch MODIFY" << endl;
272 string const first_arg = cmd.getArg(0);
273 bool const change_type = first_arg == "changetype";
274 bool const for_box = first_arg == "box";
275 if (!change_type && !for_box) {
277 // this will not be handled higher up
281 cur.recordUndoInset(this);
283 params_.type = cmd.getArg(1);
284 // set a makebox if there is no inner box but Frameless was exectued
285 // otherwise the result would be a non existent box (no inner AND outer box)
286 // (this was LyX bug 8712)
287 if (params_.type == "Frameless" && !params_.inner_box) {
288 params_.use_makebox = true;
289 params_.inner_box = true;
291 // handle the opposite case
292 if (params_.type == "Boxed" && params_.use_makebox) {
293 params_.use_makebox = false;
294 params_.inner_box = false;
297 string2params(to_utf8(cmd.argument()), params_);
303 InsetCollapsible::doDispatch(cur, cmd);
309 bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd,
310 FuncStatus & flag) const
312 switch (cmd.action()) {
314 case LFUN_INSET_MODIFY: {
315 string const first_arg = cmd.getArg(0);
316 if (first_arg == "changetype") {
317 string const type = cmd.getArg(1);
318 flag.setOnOff(type == params_.type);
319 flag.setEnabled(!params_.inner_box || type != "Framed");
322 if (first_arg == "box") {
323 flag.setEnabled(true);
326 return InsetCollapsible::getStatus(cur, cmd, flag);
329 case LFUN_INSET_DIALOG_UPDATE:
330 flag.setEnabled(true);
334 return InsetCollapsible::getStatus(cur, cmd, flag);
339 const string defaultThick = "0.4pt";
340 const string defaultSep = "3pt";
341 const string defaultShadow = "4pt";
343 void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
345 BoxType btype = boxtranslator().find(params_.type);
347 string width_string = params_.width.asLatexString();
348 string thickness_string = params_.thickness.asLatexString();
349 string separation_string = params_.separation.asLatexString();
350 string shadowsize_string = params_.shadowsize.asLatexString();
351 bool stdwidth = false;
352 string const cprotect = hasCProtectContent(runparams.moving_arg) ? "\\cprotect" : string();
353 // in general the overall width of some decorated boxes is wider thean the inner box
354 // we could therefore calculate the real width for all sizes so that if the user wants
355 // e.g. 0.1\columnwidth or 2cm he gets exactly this size
356 // however this makes problems when importing TeX code
357 // therefore only recalculate for the most common case that the box should not protrude
359 if (params_.inner_box
360 && ((width_string.find("1\\columnwidth") != string::npos
361 || width_string.find("1\\textwidth") != string::npos)
362 || width_string.find("1\\paperwidth") != string::npos
363 || width_string.find("1\\linewidth") != string::npos)) {
369 width_string += " - 2\\FrameSep - 2\\FrameRule";
372 width_string += " - 2\\fboxsep - 2\\fboxrule";
377 width_string += " - 2\\fboxsep - 0.8pt";
380 width_string += " - 2\\fboxsep - 1.6pt";
383 width_string += " - 2\\fboxsep - 2\\fboxrule - \\shadowsize";
386 width_string += " - 2\\fboxsep - 7.5\\fboxrule - 1pt";
392 if (runparams.lastid != -1)
393 os.texrow().start(runparams.lastid, runparams.lastpos);
395 // adapt column/text width correctly also if paragraphs indented
396 if (stdwidth && !(buffer().params().paragraph_separation))
399 bool needendgroup = false;
404 if (thickness_string != defaultThick) {
405 os << "{\\FrameRule " << from_ascii(thickness_string);
406 if (separation_string != defaultSep)
407 os << "\\FrameSep " << from_ascii(separation_string);
409 if (separation_string != defaultSep && thickness_string == defaultThick)
410 os << "{\\FrameSep " << from_ascii(separation_string);
412 os << "\\begin{framed}%\n";
415 if (thickness_string != defaultThick) {
416 os << "{\\fboxrule " << from_ascii(thickness_string);
417 if (separation_string != defaultSep)
418 os << "\\fboxsep " << from_ascii(separation_string);
420 if (separation_string != defaultSep && thickness_string == defaultThick)
421 os << "{\\fboxsep " << from_ascii(separation_string);
422 if (!params_.inner_box && !width_string.empty()) {
423 if (params_.framecolor != "black" || params_.backgroundcolor != "none") {
424 os << "\\fcolorbox{" << params_.framecolor << "}{" << params_.backgroundcolor << "}{";
428 // Special widths, see usrguide sec. 3.5
430 if (params_.special != "none") {
431 os << "[" << params_.width.value()
432 << '\\' << from_utf8(params_.special)
435 os << '[' << from_ascii(width_string)
437 // default horizontal alignment is 'c'
438 if (params_.hor_pos != 'c')
439 os << "[" << params_.hor_pos << "]";
441 if (params_.framecolor != "black" || params_.backgroundcolor != "none")
442 os << "\\fcolorbox{" << params_.framecolor << "}{" << params_.backgroundcolor << "}";
444 if (!cprotect.empty() && contains(runparams.active_chars, '^')) {
445 // cprotect relies on ^ being ignored
446 os << "\\begingroup\\catcode`\\^=9";
449 os << cprotect << "\\fbox";
455 if (!separation_string.empty() && separation_string != defaultSep)
456 os << "{\\fboxsep " << from_ascii(separation_string);
460 if (!separation_string.empty() && separation_string != defaultSep)
461 os << "{\\fboxsep " << from_ascii(separation_string);
465 if (thickness_string != defaultThick) {
466 os << "{\\fboxrule " << from_ascii(thickness_string);
467 if (separation_string != defaultSep) {
468 os << "\\fboxsep " << from_ascii(separation_string);
469 if (shadowsize_string != defaultShadow)
470 os << "\\shadowsize " << from_ascii(shadowsize_string);
472 if (shadowsize_string != defaultShadow && separation_string == defaultSep)
473 os << "\\shadowsize " << from_ascii(shadowsize_string);
475 if (separation_string != defaultSep && thickness_string == defaultThick) {
476 os << "{\\fboxsep " << from_ascii(separation_string);
477 if (shadowsize_string != defaultShadow)
478 os << "\\shadowsize " << from_ascii(shadowsize_string);
480 if (shadowsize_string != defaultShadow
481 && separation_string == defaultSep
482 && thickness_string == defaultThick)
483 os << "{\\shadowsize " << from_ascii(shadowsize_string);
484 os << "\\shadowbox{";
487 // must be set later because e.g. the width settings only work when
488 // it is inside a minipage or parbox
491 if (thickness_string != defaultThick) {
492 os << "{\\fboxrule " << from_ascii(thickness_string);
493 if (separation_string != defaultSep)
494 os << "\\fboxsep " << from_ascii(separation_string);
496 if (separation_string != defaultSep && thickness_string == defaultThick)
497 os << "{\\fboxsep " << from_ascii(separation_string);
498 os << "\\doublebox{";
502 if (params_.inner_box) {
503 if (params_.use_parbox) {
504 if (params_.backgroundcolor != "none" && btype == Frameless)
505 os << "\\colorbox{" << params_.backgroundcolor << "}{";
507 } else if (params_.use_makebox) {
508 if (!width_string.empty()) {
509 if (params_.backgroundcolor != "none")
510 os << "\\colorbox{" << params_.backgroundcolor << "}{";
513 // output the width and horizontal position
514 if (params_.special != "none") {
515 os << "[" << params_.width.value()
516 << '\\' << from_utf8(params_.special)
519 os << '[' << from_ascii(width_string)
521 if (params_.hor_pos != 'c')
522 os << "[" << params_.hor_pos << "]";
524 if (params_.backgroundcolor != "none")
525 os << "\\colorbox{" << params_.backgroundcolor << "}";
532 if (params_.backgroundcolor != "none" && btype == Frameless)
533 os << "\\colorbox{" << params_.backgroundcolor << "}{";
534 os << "\\begin{minipage}";
537 // output parameters for parbox and minipage
538 if (!params_.use_makebox) {
539 os << "[" << params_.pos << "]";
540 if (params_.height_special == "none") {
542 os << "[" << from_ascii(params_.height.asLatexString()) << "]";
545 // set no optional argument when the value is the default "1\height"
546 // (special units like \height are handled as "in")
547 // but when the user has chosen a non-default inner_pos, the height
548 // must be given: \minipage[pos][height][inner-pos]{width}
549 if ((params_.height != Length("1in") ||
550 params_.height_special != "totalheight") ||
551 params_.inner_pos != params_.pos) {
553 os << "[" << params_.height.value()
554 << "\\" << from_utf8(params_.height_special) << "]";
557 if (params_.inner_pos != params_.pos)
558 os << "[" << params_.inner_pos << "]";
560 os << '{' << from_ascii(width_string) << '}';
561 if (params_.use_parbox)
566 } // end if inner_box
568 if (btype == Shaded) {
569 os << "\\begin{shaded}%\n";
572 InsetText::latex(os, runparams);
575 os << "\\end{shaded}";
577 if (params_.inner_box) {
578 if (params_.use_parbox || params_.use_makebox)
581 os << "%\n\\end{minipage}";
582 if (params_.backgroundcolor != "none" && btype == Frameless
583 && !(params_.use_makebox && width_string.empty()))
591 os << "\\end{framed}";
592 if (separation_string != defaultSep || thickness_string != defaultThick)
597 if (!params_.inner_box && !width_string.empty()
598 && (params_.framecolor != "black" || params_.backgroundcolor != "none"))
600 if (separation_string != defaultSep || thickness_string != defaultThick)
607 if (separation_string != defaultSep)
612 if (separation_string != defaultSep)
617 if (separation_string != defaultSep || thickness_string != defaultThick)
622 if (separation_string != defaultSep
623 || thickness_string != defaultThick
624 || shadowsize_string != defaultShadow)
634 int InsetBox::plaintext(odocstringstream & os,
635 OutputParams const & runparams, size_t max_length) const
637 BoxType const btype = boxtranslator().find(params_.type);
661 InsetText::plaintext(os, runparams, max_length);
692 return PLAINTEXT_NEWLINE + len; // len chars on a separate line
696 int InsetBox::docbook(odocstream & os, OutputParams const & runparams) const
698 return InsetText::docbook(os, runparams);
702 docstring InsetBox::xhtml(XHTMLStream & xs, OutputParams const & runparams) const
704 // construct attributes
705 string attrs = "class='" + params_.type + "'";
707 if (!params_.width.empty()) {
708 string w = params_.width.asHTMLString();
710 style += ("width: " + params_.width.asHTMLString() + "; ");
712 // The special heights don't really mean anything for us.
713 if (!params_.height.empty() && params_.height_special == "none")
714 style += ("height: " + params_.height.asHTMLString() + "; ");
716 attrs += " style='" + style + "'";
718 xs << html::StartTag("div", attrs);
719 XHTMLOptions const opts = InsetText::WriteLabel | InsetText::WriteInnerTag;
720 docstring defer = InsetText::insetAsXHTML(xs, runparams, opts);
721 xs << html::EndTag("div");
727 void InsetBox::validate(LaTeXFeatures & features) const
729 BoxType btype = boxtranslator().find(params_.type);
732 if (params_.backgroundcolor != "none")
733 features.require("xcolor");
736 features.require("calc");
737 features.require("framed");
740 features.require("calc");
741 if (params_.framecolor != "black" || params_.backgroundcolor != "none")
742 features.require("xcolor");
748 features.require("calc");
749 features.require("fancybox");
752 features.require("color");
753 features.require("framed");
756 InsetCollapsible::validate(features);
760 string InsetBox::contextMenuName() const
762 return "context-box";
766 string InsetBox::params2string(InsetBoxParams const & params)
769 data << "box" << ' ';
775 void InsetBox::string2params(string const & in, InsetBoxParams & params)
780 istringstream data(in);
786 if (!lex || name != "box") {
787 LYXERR0("InsetBox::string2params(" << in << ")\n"
788 "Expected arg 1 to be \"box\"\n");
792 // This is part of the inset proper that is usually swallowed
793 // by Text::readInset
796 if (!lex || id != "Box") {
797 LYXERR0("InsetBox::string2params(" << in << ")\n"
798 "Expected arg 2 to be \"Box\"\n");
801 params = InsetBoxParams(string());
806 /////////////////////////////////////////////////////////////////////////
810 /////////////////////////////////////////////////////////////////////////
812 InsetBoxParams::InsetBoxParams(string const & label)
817 width(Length("100col%")),
822 height(Length("1in")),
823 height_special("totalheight"), // default is 1\\totalheight
824 thickness(Length(defaultThick)),
825 separation(Length(defaultSep)),
826 shadowsize(Length(defaultShadow)),
828 backgroundcolor("none")
832 void InsetBoxParams::write(ostream & os) const
834 os << "Box " << type << "\n";
835 os << "position \"" << pos << "\"\n";
836 os << "hor_pos \"" << hor_pos << "\"\n";
837 os << "has_inner_box " << inner_box << "\n";
838 os << "inner_pos \"" << inner_pos << "\"\n";
839 os << "use_parbox " << use_parbox << "\n";
840 os << "use_makebox " << use_makebox << "\n";
841 os << "width \"" << width.asString() << "\"\n";
842 os << "special \"" << special << "\"\n";
843 os << "height \"" << height.asString() << "\"\n";
844 os << "height_special \"" << height_special << "\"\n";
845 os << "thickness \"" << thickness.asString() << "\"\n";
846 os << "separation \"" << separation.asString() << "\"\n";
847 os << "shadowsize \"" << shadowsize.asString() << "\"\n";
848 os << "framecolor \"" << framecolor << "\"\n";
849 os << "backgroundcolor \"" << backgroundcolor << "\"\n";
853 void InsetBoxParams::read(Lexer & lex)
855 lex.setContext("InsetBoxParams::read");
857 lex >> "position" >> pos;
858 lex >> "hor_pos" >> hor_pos;
859 lex >> "has_inner_box" >> inner_box;
860 if (type == "Framed")
862 lex >> "inner_pos" >> inner_pos;
863 lex >> "use_parbox" >> use_parbox;
864 lex >> "use_makebox" >> use_makebox;
865 lex >> "width" >> width;
866 lex >> "special" >> special;
867 lex >> "height" >> height;
868 lex >> "height_special" >> height_special;
869 lex >> "thickness" >> thickness;
870 lex >> "separation" >> separation;
871 lex >> "shadowsize" >> shadowsize;
872 lex >> "framecolor" >> framecolor;
873 lex >> "backgroundcolor" >> backgroundcolor;