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 params_.type = cmd.getArg(1);
198 string2params(to_utf8(cmd.argument()), params_);
204 InsetCollapsable::doDispatch(cur, cmd);
210 bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd,
211 FuncStatus & flag) const
213 switch (cmd.action()) {
215 case LFUN_INSET_MODIFY:
216 if (cmd.getArg(0) == "changetype")
217 flag.setOnOff(cmd.getArg(1) == params_.type);
218 flag.setEnabled(true);
221 case LFUN_INSET_DIALOG_UPDATE:
222 flag.setEnabled(true);
225 case LFUN_BREAK_PARAGRAPH:
226 if ((params_.inner_box && !params_.use_makebox) || params_.type == "Shaded")
227 return InsetCollapsable::getStatus(cur, cmd, flag);
228 flag.setEnabled(false);
232 return InsetCollapsable::getStatus(cur, cmd, flag);
237 int InsetBox::latex(odocstream & 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";
273 // Adapt to column/text width correctly also if paragraphs indented:
281 os << "\\begin{framed}%\n";
286 if (!params_.inner_box) {
287 // Special widths, see usrguide §3.5
289 if (params_.special != "none") {
290 os << "[" << params_.width.value()
291 << '\\' << from_utf8(params_.special)
294 os << '[' << from_ascii(width_string)
296 if (params_.hor_pos != 'c')
297 os << "[" << params_.hor_pos << "]";
308 os << "\\shadowbox{";
314 os << "\\doublebox{";
318 if (params_.inner_box) {
319 if (params_.use_parbox)
321 else if (params_.use_makebox) {
324 // output the width and horizontal position
325 if (params_.special != "none") {
326 os << "[" << params_.width.value()
327 << '\\' << from_utf8(params_.special)
330 os << '[' << from_ascii(width_string)
332 if (params_.hor_pos != 'c')
333 os << "[" << params_.hor_pos << "]";
337 os << "\\begin{minipage}";
339 // output parameters for parbox and minipage
340 if (!params_.use_makebox) {
341 os << "[" << params_.pos << "]";
342 if (params_.height_special == "none") {
344 os << "[" << from_ascii(params_.height.asLatexString()) << "]";
347 // set no optional argument when the value is the default "1\height"
348 // (special units like \height are handled as "in")
349 // but when the user has chosen a non-default inner_pos, the height
350 // must be given: \minipage[pos][height][inner-pos]{width}
351 if ((params_.height != Length("1in") ||
352 params_.height_special != "totalheight") ||
353 params_.inner_pos != params_.pos) {
355 os << "[" << params_.height.value()
356 << "\\" << from_utf8(params_.height_special) << "]";
359 if (params_.inner_pos != params_.pos)
360 os << "[" << params_.inner_pos << "]";
362 os << '{' << from_ascii(width_string) << '}';
363 if (params_.use_parbox)
369 } // end if inner_box
371 if (btype == Shaded) {
372 os << "\\begin{shaded}%\n";
376 i += InsetText::latex(os, runparams);
379 os << "\\end{shaded}";
381 if (params_.inner_box) {
382 if (params_.use_parbox || params_.use_makebox)
385 os << "%\n\\end{minipage}";
392 os << "\\end{framed}";
414 int InsetBox::plaintext(odocstream & os, OutputParams const & runparams) const
416 BoxType const btype = boxtranslator().find(params_.type);
440 InsetText::plaintext(os, runparams);
471 return PLAINTEXT_NEWLINE + len; // len chars on a separate line
475 int InsetBox::docbook(odocstream & os, OutputParams const & runparams) const
477 return InsetText::docbook(os, runparams);
481 docstring InsetBox::xhtml(XHTMLStream & xs, OutputParams const & runparams) const
483 // construct attributes
484 string attrs = "class='" + params_.type + "'";
486 if (!params_.width.empty())
487 style += ("width: " + params_.width.asHTMLString() + "; ");
488 // The special heights don't really mean anything for us.
489 if (!params_.height.empty() && params_.height_special == "none")
490 style += ("height: " + params_.height.asHTMLString() + "; ");
492 attrs += " style='" + style + "'";
494 xs << html::StartTag("div", attrs);
495 XHTMLOptions const opts = InsetText::WriteLabel | InsetText::WriteInnerTag;
496 docstring defer = InsetText::insetAsXHTML(xs, runparams, opts);
497 xs << html::EndTag("div");
503 void InsetBox::validate(LaTeXFeatures & features) const
505 BoxType btype = boxtranslator().find(params_.type);
510 features.require("framed");
513 features.require("calc");
519 features.require("calc");
520 features.require("fancybox");
523 features.require("color");
524 features.require("framed");
527 InsetCollapsable::validate(features);
531 docstring InsetBox::contextMenu(BufferView const &, int, int) const
533 return from_ascii("context-box");
537 string InsetBox::params2string(InsetBoxParams const & params)
540 data << "box" << ' ';
546 void InsetBox::string2params(string const & in, InsetBoxParams & params)
548 params = InsetBoxParams(string());
552 istringstream data(in);
558 if (!lex || name != "box") {
559 LYXERR0("InsetBox::string2params(" << in << ")\n"
560 "Expected arg 1 to be \"box\"\n");
564 // This is part of the inset proper that is usually swallowed
565 // by Text::readInset
568 if (!lex || id != "Box") {
569 LYXERR0("InsetBox::string2params(" << in << ")\n"
570 "Expected arg 2 to be \"Box\"\n");
577 /////////////////////////////////////////////////////////////////////////
581 /////////////////////////////////////////////////////////////////////////
583 InsetBoxParams::InsetBoxParams(string const & label)
588 width(Length("100col%")),
593 height(Length("1in")),
594 height_special("totalheight") // default is 1\\totalheight
598 void InsetBoxParams::write(ostream & os) const
600 os << "Box " << type << "\n";
601 os << "position \"" << pos << "\"\n";
602 os << "hor_pos \"" << hor_pos << "\"\n";
603 os << "has_inner_box " << inner_box << "\n";
604 os << "inner_pos \"" << inner_pos << "\"\n";
605 os << "use_parbox " << use_parbox << "\n";
606 os << "use_makebox " << use_makebox << "\n";
607 os << "width \"" << width.asString() << "\"\n";
608 os << "special \"" << special << "\"\n";
609 os << "height \"" << height.asString() << "\"\n";
610 os << "height_special \"" << height_special << "\"\n";
614 void InsetBoxParams::read(Lexer & lex)
616 lex.setContext("InsetBoxParams::read");
618 lex >> "position" >> pos;
619 lex >> "hor_pos" >> hor_pos;
620 lex >> "has_inner_box" >> inner_box;
621 if (type == "Framed")
623 lex >> "inner_pos" >> inner_pos;
624 lex >> "use_parbox" >> use_parbox;
625 lex >> "use_makebox" >> use_makebox;
626 lex >> "width" >> width;
627 lex >> "special" >> special;
628 lex >> "height" >> height;
629 lex >> "height_special" >> height_special;