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::layoutName() const
108 return from_ascii("Box:" + params_.type);
112 void InsetBox::write(ostream & os) const
115 InsetCollapsable::write(os);
119 void InsetBox::read(Lexer & lex)
122 InsetCollapsable::read(lex);
126 void InsetBox::setButtonLabel()
128 BoxType const btype = boxtranslator().find(params_.type);
130 docstring const type = _("Box");
133 if (params_.inner_box) {
134 if (params_.use_parbox)
136 else if (params_.use_makebox)
137 inner = _("Makebox");
139 inner = _("Minipage");
143 if (btype != Frameless)
144 frame = boxtranslator_loc().find(btype);
147 if (inner.empty() && frame.empty())
149 else if (inner.empty())
150 label = bformat(_("%1$s (%2$s)"),
152 else if (frame.empty())
153 label = bformat(_("%1$s (%2$s)"),
156 label = bformat(_("%1$s (%2$s, %3$s)"),
162 bool InsetBox::hasFixedWidth() const
164 return params_.inner_box || params_.special != "width";
168 void InsetBox::metrics(MetricsInfo & m, Dimension & dim) const
170 // back up textwidth.
171 int textwidth_backup = m.base.textwidth;
173 m.base.textwidth = params_.width.inPixels(m.base.textwidth);
174 InsetCollapsable::metrics(m, dim);
176 m.base.textwidth = textwidth_backup;
180 bool InsetBox::forcePlainLayout(idx_type) const
182 return (!params_.inner_box || params_.use_makebox)
183 && params_.type != "Shaded" && params_.type != "Framed";
187 void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd)
189 switch (cmd.action()) {
191 case LFUN_INSET_MODIFY: {
192 //lyxerr << "InsetBox::dispatch MODIFY" << endl;
193 cur.recordUndoInset(ATOMIC_UNDO, this);
194 if (cmd.getArg(0) == "changetype") {
195 params_.type = cmd.getArg(1);
197 string2params(to_utf8(cmd.argument()), params_);
203 InsetCollapsable::doDispatch(cur, cmd);
209 bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd,
210 FuncStatus & flag) const
212 switch (cmd.action()) {
214 case LFUN_INSET_MODIFY:
215 if (cmd.getArg(0) == "changetype")
216 flag.setOnOff(cmd.getArg(1) == params_.type);
217 flag.setEnabled(true);
220 case LFUN_INSET_DIALOG_UPDATE:
221 flag.setEnabled(true);
224 case LFUN_BREAK_PARAGRAPH:
225 if ((params_.inner_box && !params_.use_makebox)
226 || params_.type == "Shaded" || params_.type == "Framed")
227 return InsetCollapsable::getStatus(cur, cmd, flag);
228 flag.setEnabled(false);
232 return InsetCollapsable::getStatus(cur, cmd, flag);
237 void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
239 BoxType btype = boxtranslator().find(params_.type);
241 string width_string = params_.width.asLatexString();
242 bool stdwidth = false;
243 if (params_.inner_box &&
244 (width_string.find("1.0\\columnwidth") != string::npos
245 || width_string.find("1.0\\textwidth") != string::npos)) {
253 width_string += " - 2\\fboxsep - 2\\fboxrule";
256 width_string += " - 2\\fboxsep - 0.8pt";
259 width_string += " - 2\\fboxsep - 1.6pt";
262 // Shadow falls outside right margin... opinions?
263 width_string += " - 2\\fboxsep - 2\\fboxrule"/* "-\\shadowsize"*/;
266 width_string += " - 2\\fboxsep - 7.5\\fboxrule - 1pt";
272 if (runparams.lastid != -1)
273 os.texrow().start(runparams.lastid, runparams.lastpos);
275 // Adapt to column/text width correctly also if paragraphs indented:
283 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)
369 } // end if inner_box
371 if (btype == Shaded) {
372 os << "\\begin{shaded}%\n";
375 InsetText::latex(os, runparams);
378 os << "\\end{shaded}";
380 if (params_.inner_box) {
381 if (params_.use_parbox || params_.use_makebox)
384 os << "%\n\\end{minipage}";
391 os << "\\end{framed}";
409 int InsetBox::plaintext(odocstream & os, OutputParams const & runparams) const
411 BoxType const btype = boxtranslator().find(params_.type);
435 InsetText::plaintext(os, runparams);
466 return PLAINTEXT_NEWLINE + len; // len chars on a separate line
470 int InsetBox::docbook(odocstream & os, OutputParams const & runparams) const
472 return InsetText::docbook(os, runparams);
476 docstring InsetBox::xhtml(XHTMLStream & xs, OutputParams const & runparams) const
478 // construct attributes
479 string attrs = "class='" + params_.type + "'";
481 if (!params_.width.empty()) {
482 string w = params_.width.asHTMLString();
484 style += ("width: " + params_.width.asHTMLString() + "; ");
486 // The special heights don't really mean anything for us.
487 if (!params_.height.empty() && params_.height_special == "none")
488 style += ("height: " + params_.height.asHTMLString() + "; ");
490 attrs += " style='" + style + "'";
492 xs << html::StartTag("div", attrs);
493 XHTMLOptions const opts = InsetText::WriteLabel | InsetText::WriteInnerTag;
494 docstring defer = InsetText::insetAsXHTML(xs, runparams, opts);
495 xs << html::EndTag("div");
501 void InsetBox::validate(LaTeXFeatures & features) const
503 BoxType btype = boxtranslator().find(params_.type);
508 features.require("framed");
511 features.require("calc");
517 features.require("calc");
518 features.require("fancybox");
521 features.require("color");
522 features.require("framed");
525 InsetCollapsable::validate(features);
529 docstring InsetBox::contextMenuName() const
531 return from_ascii("context-box");
535 string InsetBox::params2string(InsetBoxParams const & params)
538 data << "box" << ' ';
544 void InsetBox::string2params(string const & in, InsetBoxParams & params)
546 params = InsetBoxParams(string());
550 istringstream data(in);
556 if (!lex || name != "box") {
557 LYXERR0("InsetBox::string2params(" << in << ")\n"
558 "Expected arg 1 to be \"box\"\n");
562 // This is part of the inset proper that is usually swallowed
563 // by Text::readInset
566 if (!lex || id != "Box") {
567 LYXERR0("InsetBox::string2params(" << in << ")\n"
568 "Expected arg 2 to be \"Box\"\n");
575 /////////////////////////////////////////////////////////////////////////
579 /////////////////////////////////////////////////////////////////////////
581 InsetBoxParams::InsetBoxParams(string const & label)
586 width(Length("100col%")),
591 height(Length("1in")),
592 height_special("totalheight") // default is 1\\totalheight
596 void InsetBoxParams::write(ostream & os) const
598 os << "Box " << type << "\n";
599 os << "position \"" << pos << "\"\n";
600 os << "hor_pos \"" << hor_pos << "\"\n";
601 os << "has_inner_box " << inner_box << "\n";
602 os << "inner_pos \"" << inner_pos << "\"\n";
603 os << "use_parbox " << use_parbox << "\n";
604 os << "use_makebox " << use_makebox << "\n";
605 os << "width \"" << width.asString() << "\"\n";
606 os << "special \"" << special << "\"\n";
607 os << "height \"" << height.asString() << "\"\n";
608 os << "height_special \"" << height_special << "\"\n";
612 void InsetBoxParams::read(Lexer & lex)
614 lex.setContext("InsetBoxParams::read");
616 lex >> "position" >> pos;
617 lex >> "hor_pos" >> hor_pos;
618 lex >> "has_inner_box" >> inner_box;
619 if (type == "Framed")
621 lex >> "inner_pos" >> inner_pos;
622 lex >> "use_parbox" >> use_parbox;
623 lex >> "use_makebox" >> use_makebox;
624 lex >> "width" >> width;
625 lex >> "special" >> special;
626 lex >> "height" >> height;
627 lex >> "height_special" >> height_special;