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 "BufferParams.h"
19 #include "BufferView.h"
21 #include "DispatchResult.h"
22 #include "FuncStatus.h"
23 #include "FuncRequest.h"
24 #include "LaTeXFeatures.h"
26 #include "MetricsInfo.h"
27 #include "output_xhtml.h"
28 #include "TextClass.h"
30 #include "support/debug.h"
31 #include "support/docstream.h"
32 #include "support/gettext.h"
33 #include "support/lstrings.h"
34 #include "support/Translator.h"
36 #include "frontends/Application.h"
41 using namespace lyx::support;
47 typedef Translator<string, InsetBox::BoxType> BoxTranslator;
48 typedef Translator<docstring, InsetBox::BoxType> BoxTranslatorLoc;
50 BoxTranslator initBoxtranslator()
52 BoxTranslator translator("Boxed", InsetBox::Boxed);
53 translator.addPair("Frameless", InsetBox::Frameless);
54 translator.addPair("Framed", InsetBox::Framed);
55 translator.addPair("ovalbox", InsetBox::ovalbox);
56 translator.addPair("Ovalbox", InsetBox::Ovalbox);
57 translator.addPair("Shadowbox", InsetBox::Shadowbox);
58 translator.addPair("Shaded", InsetBox::Shaded);
59 translator.addPair("Doublebox",InsetBox::Doublebox);
64 BoxTranslatorLoc initBoxtranslatorLoc()
66 BoxTranslatorLoc translator(_("simple frame"), InsetBox::Boxed);
67 translator.addPair(_("frameless"), InsetBox::Frameless);
68 translator.addPair(_("simple frame, page breaks"), InsetBox::Framed);
69 translator.addPair(_("oval, thin"), InsetBox::ovalbox);
70 translator.addPair(_("oval, thick"), InsetBox::Ovalbox);
71 translator.addPair(_("drop shadow"), InsetBox::Shadowbox);
72 translator.addPair(_("shaded background"), InsetBox::Shaded);
73 translator.addPair(_("double frame"), InsetBox::Doublebox);
78 BoxTranslator const & boxtranslator()
80 static BoxTranslator translator = initBoxtranslator();
85 BoxTranslatorLoc const & boxtranslator_loc()
87 static BoxTranslatorLoc translator = initBoxtranslatorLoc();
94 /////////////////////////////////////////////////////////////////////////
98 /////////////////////////////////////////////////////////////////////////
100 InsetBox::InsetBox(Buffer * buffer, string const & label)
101 : InsetCollapsable(buffer), params_(label)
105 docstring InsetBox::name() const
109 if (boxtranslator().find(params_.type) == Shaded)
111 return from_ascii(name);
115 void InsetBox::write(ostream & os) const
118 InsetCollapsable::write(os);
122 void InsetBox::read(Lexer & lex)
125 InsetCollapsable::read(lex);
129 void InsetBox::setButtonLabel()
131 BoxType const btype = boxtranslator().find(params_.type);
133 docstring const type = _("Box");
136 if (params_.inner_box) {
137 if (params_.use_parbox)
139 else if (params_.use_makebox)
140 inner = _("Makebox");
142 inner = _("Minipage");
146 if (btype != Frameless)
147 frame = boxtranslator_loc().find(btype);
150 if (inner.empty() && frame.empty())
152 else if (inner.empty())
153 label = bformat(_("%1$s (%2$s)"),
155 else if (frame.empty())
156 label = bformat(_("%1$s (%2$s)"),
159 label = bformat(_("%1$s (%2$s, %3$s)"),
165 bool InsetBox::hasFixedWidth() const
167 return params_.inner_box || params_.special != "width";
171 void InsetBox::metrics(MetricsInfo & m, Dimension & dim) const
173 // back up textwidth.
174 int textwidth_backup = m.base.textwidth;
176 m.base.textwidth = params_.width.inPixels(m.base.textwidth);
177 InsetCollapsable::metrics(m, dim);
179 m.base.textwidth = textwidth_backup;
183 bool InsetBox::forcePlainLayout(idx_type) const
185 return (!params_.inner_box || params_.use_makebox) && params_.type != "Shaded";
189 void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd)
191 switch (cmd.action()) {
193 case LFUN_INSET_MODIFY: {
194 //lyxerr << "InsetBox::dispatch MODIFY" << endl;
195 if (cmd.getArg(0) == "changetype") {
196 cur.recordUndoInset(ATOMIC_UNDO, this);
197 params_.type = cmd.getArg(1);
199 string2params(to_utf8(cmd.argument()), params_);
205 InsetCollapsable::doDispatch(cur, cmd);
211 bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd,
212 FuncStatus & flag) const
214 switch (cmd.action()) {
216 case LFUN_INSET_MODIFY:
217 if (cmd.getArg(0) == "changetype")
218 flag.setOnOff(cmd.getArg(1) == params_.type);
219 flag.setEnabled(true);
222 case LFUN_INSET_DIALOG_UPDATE:
223 flag.setEnabled(true);
226 case LFUN_BREAK_PARAGRAPH:
227 if ((params_.inner_box && !params_.use_makebox) || params_.type == "Shaded")
228 return InsetCollapsable::getStatus(cur, cmd, flag);
229 flag.setEnabled(false);
233 return InsetCollapsable::getStatus(cur, cmd, flag);
238 int InsetBox::latex(odocstream & os, OutputParams const & runparams) const
240 BoxType btype = boxtranslator().find(params_.type);
242 string width_string = params_.width.asLatexString();
243 bool stdwidth = false;
244 if (params_.inner_box &&
245 (width_string.find("1.0\\columnwidth") != string::npos
246 || width_string.find("1.0\\textwidth") != string::npos)) {
254 width_string += " - 2\\fboxsep - 2\\fboxrule";
257 width_string += " - 2\\fboxsep - 0.8pt";
260 width_string += " - 2\\fboxsep - 1.6pt";
263 // Shadow falls outside right margin... opinions?
264 width_string += " - 2\\fboxsep - 2\\fboxrule"/* "-\\shadowsize"*/;
267 width_string += " - 2\\fboxsep - 7.5\\fboxrule - 1pt";
274 // Adapt to column/text width correctly also if paragraphs indented:
282 os << "\\begin{framed}%\n";
287 if (!params_.inner_box) {
288 // Special widths, see usrguide §3.5
290 if (params_.special != "none") {
291 os << "[" << params_.width.value()
292 << '\\' << from_utf8(params_.special)
295 os << '[' << from_ascii(width_string)
297 if (params_.hor_pos != 'c')
298 os << "[" << params_.hor_pos << "]";
309 os << "\\shadowbox{";
315 os << "\\doublebox{";
319 if (params_.inner_box) {
320 if (params_.use_parbox)
322 else if (params_.use_makebox) {
325 // output the width and horizontal position
326 if (params_.special != "none") {
327 os << "[" << params_.width.value()
328 << '\\' << from_utf8(params_.special)
331 os << '[' << from_ascii(width_string)
333 if (params_.hor_pos != 'c')
334 os << "[" << params_.hor_pos << "]";
338 os << "\\begin{minipage}";
340 // output parameters for parbox and minipage
341 if (!params_.use_makebox) {
342 os << "[" << params_.pos << "]";
343 if (params_.height_special == "none") {
345 os << "[" << from_ascii(params_.height.asLatexString()) << "]";
348 // set no optional argument when the value is the default "1\height"
349 // (special units like \height are handled as "in")
350 // but when the user has chosen a non-default inner_pos, the height
351 // must be given: \minipage[pos][height][inner-pos]{width}
352 if ((params_.height != Length("1in") ||
353 params_.height_special != "totalheight") ||
354 params_.inner_pos != params_.pos) {
356 os << "[" << params_.height.value()
357 << "\\" << from_utf8(params_.height_special) << "]";
360 if (params_.inner_pos != params_.pos)
361 os << "[" << params_.inner_pos << "]";
363 os << '{' << from_ascii(width_string) << '}';
364 if (params_.use_parbox)
370 } // end if inner_box
372 if (btype == Shaded) {
373 os << "\\begin{shaded}%\n";
377 i += InsetText::latex(os, runparams);
380 os << "\\end{shaded}";
382 if (params_.inner_box) {
383 if (params_.use_parbox || params_.use_makebox)
386 os << "%\n\\end{minipage}";
393 os << "\\end{framed}";
415 int InsetBox::plaintext(odocstream & os, OutputParams const & runparams) const
417 BoxType const btype = boxtranslator().find(params_.type);
441 InsetText::plaintext(os, runparams);
472 return PLAINTEXT_NEWLINE + len; // len chars on a separate line
476 int InsetBox::docbook(odocstream & os, OutputParams const & runparams) const
478 return InsetText::docbook(os, runparams);
482 docstring InsetBox::xhtml(XHTMLStream & xs, OutputParams const & runparams) const
484 // construct attributes
485 string attrs = "class='" + params_.type + "'";
487 if (!params_.width.empty())
488 style += ("width: " + params_.width.asHTMLString() + "; ");
489 // The special heights don't really mean anything for us.
490 if (!params_.height.empty() && params_.height_special == "none")
491 style += ("height: " + params_.height.asHTMLString() + "; ");
493 attrs += " style='" + style + "'";
495 xs << html::StartTag("div", attrs);
496 XHTMLOptions const opts = InsetText::WriteLabel | InsetText::WriteInnerTag;
497 docstring defer = InsetText::insetAsXHTML(xs, runparams, opts);
498 xs << html::EndTag("div");
504 void InsetBox::validate(LaTeXFeatures & features) const
506 BoxType btype = boxtranslator().find(params_.type);
511 features.require("framed");
514 features.require("calc");
520 features.require("calc");
521 features.require("fancybox");
524 features.require("color");
525 features.require("framed");
528 InsetCollapsable::validate(features);
532 docstring InsetBox::contextMenu(BufferView const &, int, int) const
534 return from_ascii("context-box");
538 string InsetBox::params2string(InsetBoxParams const & params)
541 data << "box" << ' ';
547 void InsetBox::string2params(string const & in, InsetBoxParams & params)
549 params = InsetBoxParams(string());
553 istringstream data(in);
559 if (!lex || name != "box") {
560 LYXERR0("InsetBox::string2params(" << in << ")\n"
561 "Expected arg 1 to be \"box\"\n");
565 // This is part of the inset proper that is usually swallowed
566 // by Text::readInset
569 if (!lex || id != "Box") {
570 LYXERR0("InsetBox::string2params(" << in << ")\n"
571 "Expected arg 2 to be \"Box\"\n");
578 /////////////////////////////////////////////////////////////////////////
582 /////////////////////////////////////////////////////////////////////////
584 InsetBoxParams::InsetBoxParams(string const & label)
589 width(Length("100col%")),
594 height(Length("1in")),
595 height_special("totalheight") // default is 1\\totalheight
599 void InsetBoxParams::write(ostream & os) const
601 os << "Box " << type << "\n";
602 os << "position \"" << pos << "\"\n";
603 os << "hor_pos \"" << hor_pos << "\"\n";
604 os << "has_inner_box " << inner_box << "\n";
605 os << "inner_pos \"" << inner_pos << "\"\n";
606 os << "use_parbox " << use_parbox << "\n";
607 os << "use_makebox " << use_makebox << "\n";
608 os << "width \"" << width.asString() << "\"\n";
609 os << "special \"" << special << "\"\n";
610 os << "height \"" << height.asString() << "\"\n";
611 os << "height_special \"" << height_special << "\"\n";
615 void InsetBoxParams::read(Lexer & lex)
617 lex.setContext("InsetBoxParams::read");
619 lex >> "position" >> pos;
620 lex >> "hor_pos" >> hor_pos;
621 lex >> "has_inner_box" >> inner_box;
622 if (type == "Framed")
624 lex >> "inner_pos" >> inner_pos;
625 lex >> "use_parbox" >> use_parbox;
626 lex >> "use_makebox" >> use_makebox;
627 lex >> "width" >> width;
628 lex >> "special" >> special;
629 lex >> "height" >> height;
630 lex >> "height_special" >> height_special;