X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetBox.cpp;h=c96a7c9e7d11375d5a2fac0ec9537743a63fe0c1;hb=6da7ee1be170629aa6647aa8b2d6cf66ea928a9b;hp=cd4a1d62b80619d4632d3ff7c522d4f4170db031;hpb=a3dfd2f10bfc1c07a6a569a63f33be246ee31924;p=lyx.git diff --git a/src/insets/InsetBox.cpp b/src/insets/InsetBox.cpp index cd4a1d62b8..c96a7c9e7d 100644 --- a/src/insets/InsetBox.cpp +++ b/src/insets/InsetBox.cpp @@ -5,7 +5,7 @@ * * \author Angus Leeming * \author Martin Vermeer - * \author Jürgen Spitzmüller + * \author Jürgen Spitzmüller * * Full author contact details are available in file CREDITS. */ @@ -15,22 +15,31 @@ #include "InsetBox.h" #include "Buffer.h" +#include "BufferParams.h" #include "BufferView.h" +#include "ColorSet.h" #include "Cursor.h" #include "DispatchResult.h" -#include "support/debug.h" #include "FuncStatus.h" #include "FuncRequest.h" -#include "support/gettext.h" #include "LaTeXFeatures.h" #include "Lexer.h" #include "MetricsInfo.h" +#include "output_xhtml.h" +#include "TextClass.h" +#include "support/debug.h" +#include "support/docstream.h" +#include "support/gettext.h" +#include "support/lstrings.h" #include "support/Translator.h" +#include "frontends/Application.h" + #include using namespace std; +using namespace lyx::support; namespace lyx { @@ -39,7 +48,7 @@ namespace { typedef Translator BoxTranslator; typedef Translator BoxTranslatorLoc; -BoxTranslator const init_boxtranslator() +BoxTranslator initBoxtranslator() { BoxTranslator translator("Boxed", InsetBox::Boxed); translator.addPair("Frameless", InsetBox::Frameless); @@ -53,7 +62,7 @@ BoxTranslator const init_boxtranslator() } -BoxTranslatorLoc const init_boxtranslator_loc() +BoxTranslatorLoc initBoxtranslatorLoc() { BoxTranslatorLoc translator(_("simple frame"), InsetBox::Boxed); translator.addPair(_("frameless"), InsetBox::Frameless); @@ -69,95 +78,91 @@ BoxTranslatorLoc const init_boxtranslator_loc() BoxTranslator const & boxtranslator() { - static BoxTranslator translator = init_boxtranslator(); + static BoxTranslator const translator = initBoxtranslator(); return translator; } BoxTranslatorLoc const & boxtranslator_loc() { - static BoxTranslatorLoc translator = init_boxtranslator_loc(); + static BoxTranslatorLoc const translator = initBoxtranslatorLoc(); return translator; } -} // anon - +} // namespace anon -InsetBox::InsetBox(BufferParams const & bp, string const & label) - : InsetCollapsable(bp), params_(label) -{} +///////////////////////////////////////////////////////////////////////// +// +// InsetBox +// +///////////////////////////////////////////////////////////////////////// -InsetBox::InsetBox(InsetBox const & in) - : InsetCollapsable(in), params_(in.params_) +InsetBox::InsetBox(Buffer * buffer, string const & label) + : InsetCollapsable(buffer), params_(label) {} -InsetBox::~InsetBox() -{ - InsetBoxMailer(*this).hideDialog(); -} - - -Inset * InsetBox::clone() const -{ - return new InsetBox(*this); -} - - -docstring const InsetBox::editMessage() const -{ - return _("Opened Box Inset"); -} - - -docstring InsetBox::name() const +docstring InsetBox::layoutName() const { // FIXME: UNICODE - string name = string("Box"); - if (boxtranslator().find(params_.type) == Shaded) - name += string(":Shaded"); - return from_ascii(name); + return from_ascii("Box:" + params_.type); } -void InsetBox::write(Buffer const & buf, ostream & os) const +void InsetBox::write(ostream & os) const { params_.write(os); - InsetCollapsable::write(buf, os); + InsetCollapsable::write(os); } -void InsetBox::read(Buffer const & buf, Lexer & lex) +void InsetBox::read(Lexer & lex) { params_.read(lex); - InsetCollapsable::read(buf, lex); + InsetCollapsable::read(lex); } void InsetBox::setButtonLabel() { - BoxType btype = boxtranslator().find(params_.type); + BoxType const btype = boxtranslator().find(params_.type); - docstring label; - label += _("Box"); - label += " ("; - if (btype == Frameless) { + docstring const type = _("Box"); + + docstring inner; + if (params_.inner_box) { if (params_.use_parbox) - label += _("Parbox"); + inner = _("Parbox"); + else if (params_.use_makebox) + inner = _("Makebox"); else - label += _("Minipage"); - } else - label += boxtranslator_loc().find(btype); - label += ")"; + inner = _("Minipage"); + } + + docstring frame; + if (btype != Frameless) + frame = boxtranslator_loc().find(btype); + docstring label; + if (inner.empty() && frame.empty()) + label = type; + else if (inner.empty()) + label = bformat(_("%1$s (%2$s)"), + type, frame); + else if (frame.empty()) + label = bformat(_("%1$s (%2$s)"), + type, inner); + else + label = bformat(_("%1$s (%2$s, %3$s)"), + type, inner, frame); setLabel(label); } bool InsetBox::hasFixedWidth() const { - return params_.inner_box || params_.special != "width"; + return !params_.width.empty(); } @@ -173,41 +178,50 @@ void InsetBox::metrics(MetricsInfo & m, Dimension & dim) const } -bool InsetBox::forceDefaultParagraphs(idx_type) const +bool InsetBox::forcePlainLayout(idx_type) const { - return !params_.inner_box; + return (!params_.inner_box || params_.use_makebox) + && params_.type != "Shaded" && params_.type != "Framed"; } -bool InsetBox::showInsetDialog(BufferView * bv) const +ColorCode InsetBox::backgroundColor(PainterInfo const &) const { - InsetBoxMailer(const_cast(*this)).showDialog(bv); - return true; + if (params_.type != "Shaded") + return getLayout().bgcolor(); + // FIXME: This hardcoded color is a hack! + if (buffer().params().boxbgcolor == lyx::rgbFromHexName("#ff0000")) + return getLayout().bgcolor(); + ColorCode c = lcolor.getFromLyXName("boxbgcolor"); + if (c == Color_none) + return getLayout().bgcolor(); + return c; } void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd) { - switch (cmd.action) { + switch (cmd.action()) { case LFUN_INSET_MODIFY: { //lyxerr << "InsetBox::dispatch MODIFY" << endl; - InsetBoxMailer::string2params(to_utf8(cmd.argument()), params_); - setLayout(cur.buffer().params()); - break; - } - - case LFUN_INSET_DIALOG_UPDATE: - InsetBoxMailer(*this).updateDialog(&cur.bv()); - break; - - case LFUN_MOUSE_RELEASE: - if (cmd.button() == mouse_button::button3 && hitButton(cmd)) { - InsetBoxMailer(*this).showDialog(&cur.bv()); - break; + string const first_arg = cmd.getArg(0); + bool const change_type = first_arg == "changetype"; + bool const for_box = first_arg == "box"; + if (!change_type && !for_box) { + // not for us + // this will not be handled higher up + cur.undispatched(); + return; } - InsetCollapsable::doDispatch(cur, cmd); + cur.recordUndoInset(ATOMIC_UNDO, this); + if (change_type) + params_.type = cmd.getArg(1); + else // if (for_box) + string2params(to_utf8(cmd.argument()), params_); + setButtonLabel(); break; + } default: InsetCollapsable::doDispatch(cur, cmd); @@ -219,19 +233,33 @@ void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd) bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus & flag) const { - switch (cmd.action) { + switch (cmd.action()) { + + case LFUN_INSET_MODIFY: { + string const first_arg = cmd.getArg(0); + if (first_arg == "changetype") { + string const type = cmd.getArg(1); + flag.setOnOff(type == params_.type); + flag.setEnabled(!params_.inner_box || type != "Framed"); + return true; + } + if (first_arg == "box") { + flag.setEnabled(true); + return true; + } + return InsetCollapsable::getStatus(cur, cmd, flag); + } - case LFUN_INSET_MODIFY: case LFUN_INSET_DIALOG_UPDATE: - flag.enabled(true); + flag.setEnabled(true); return true; - case LFUN_BREAK_PARAGRAPH: - if (params_.inner_box) { + + case LFUN_PARAGRAPH_BREAK: + if ((params_.inner_box && !params_.use_makebox) + || params_.type == "Shaded" || params_.type == "Framed") return InsetCollapsable::getStatus(cur, cmd, flag); - } else { - flag.enabled(false); - return true; - } + flag.setEnabled(false); + return true; default: return InsetCollapsable::getStatus(cur, cmd, flag); @@ -239,20 +267,13 @@ bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd, } -bool InsetBox::isMacroScope(Buffer const &) const -{ - BoxType btype = boxtranslator().find(params_.type); - return btype != Frameless || params_.inner_box; -} - - -int InsetBox::latex(Buffer const & buf, odocstream & os, - OutputParams const & runparams) const +void InsetBox::latex(otexstream & os, OutputParams const & runparams) const { BoxType btype = boxtranslator().find(params_.type); string width_string = params_.width.asLatexString(); - bool stdwidth(false); + bool stdwidth = false; + // FIXME: do not test explicitely values of width_string if (params_.inner_box && (width_string.find("1.0\\columnwidth") != string::npos || width_string.find("1.0\\textwidth") != string::npos)) { @@ -281,8 +302,10 @@ int InsetBox::latex(Buffer const & buf, odocstream & os, } } - int i = 0; - os << "%\n"; + os << safebreakln; + if (runparams.lastid != -1) + os.texrow().start(runparams.lastid, runparams.lastpos); + // Adapt to column/text width correctly also if paragraphs indented: if (stdwidth) os << "\\noindent"; @@ -292,25 +315,26 @@ int InsetBox::latex(Buffer const & buf, odocstream & os, break; case Framed: os << "\\begin{framed}%\n"; - i += 1; break; case Boxed: - os << "\\framebox"; - if (!params_.inner_box) { - os << "{\\makebox"; - // Special widths, see usrguide §3.5 - // FIXME UNICODE - if (params_.special != "none") { - os << "[" << params_.width.value() - << '\\' << from_utf8(params_.special) - << ']'; + if (!width_string.empty()) { + if (!params_.inner_box) { + os << "\\framebox"; + // Special widths, see usrguide sec. 3.5 + // FIXME UNICODE + if (params_.special != "none") { + os << "[" << params_.width.value() + << '\\' << from_utf8(params_.special) + << ']'; + } else + os << '[' << from_ascii(width_string) + << ']'; + if (params_.hor_pos != 'c') + os << "[" << params_.hor_pos << "]"; } else - os << '[' << from_ascii(width_string) - << ']'; - if (params_.hor_pos != 'c') - os << "[" << params_.hor_pos << "]"; - } - + os << "\\fbox"; + } else + os << "\\fbox"; os << "{"; break; case ovalbox: @@ -323,7 +347,8 @@ int InsetBox::latex(Buffer const & buf, odocstream & os, os << "\\shadowbox{"; break; case Shaded: - // later + // must be set later because e.g. the width settings only work when + // it is inside a minipage or parbox break; case Doublebox: os << "\\doublebox{"; @@ -333,49 +358,69 @@ int InsetBox::latex(Buffer const & buf, odocstream & os, if (params_.inner_box) { if (params_.use_parbox) os << "\\parbox"; + else if (params_.use_makebox) { + if (!width_string.empty()) { + os << "\\makebox"; + // FIXME UNICODE + // output the width and horizontal position + if (params_.special != "none") { + os << "[" << params_.width.value() + << '\\' << from_utf8(params_.special) + << ']'; + } else + os << '[' << from_ascii(width_string) + << ']'; + if (params_.hor_pos != 'c') + os << "[" << params_.hor_pos << "]"; + } else + os << "\\mbox"; + os << "{"; + } else os << "\\begin{minipage}"; - os << "[" << params_.pos << "]"; - if (params_.height_special == "none") { - // FIXME UNICODE - os << "[" << from_ascii(params_.height.asLatexString()) << "]"; - } else { - // Special heights - // set no optional argument when the value is the default "1\height" - // (special units like \height are handled as "in") - // but when the user has chosen a non-default inner_pos, the height - // must be given: \minipage[pos][height][inner-pos]{width} - if ((params_.height != Length("1in") || - params_.height_special != "totalheight") || - params_.inner_pos != params_.pos) { + // output parameters for parbox and minipage + if (!params_.use_makebox) { + os << "[" << params_.pos << "]"; + if (params_.height_special == "none") { // FIXME UNICODE - os << "[" << params_.height.value() - << "\\" << from_utf8(params_.height_special) << "]"; + os << "[" << from_ascii(params_.height.asLatexString()) << "]"; + } else { + // Special heights + // set no optional argument when the value is the default "1\height" + // (special units like \height are handled as "in") + // but when the user has chosen a non-default inner_pos, the height + // must be given: \minipage[pos][height][inner-pos]{width} + if ((params_.height != Length("1in") || + params_.height_special != "totalheight") || + params_.inner_pos != params_.pos) { + // FIXME UNICODE + os << "[" << params_.height.value() + << "\\" << from_utf8(params_.height_special) << "]"; + } } + if (params_.inner_pos != params_.pos) + os << "[" << params_.inner_pos << "]"; + // FIXME UNICODE + os << '{' << from_ascii(width_string) << '}'; + if (params_.use_parbox) + os << "{"; } - if (params_.inner_pos != params_.pos) - os << "[" << params_.inner_pos << "]"; - - // FIXME UNICODE - os << '{' << from_ascii(width_string) << '}'; - if (params_.use_parbox) - os << "{"; os << "%\n"; - i += 1; - } - if (btype == Shaded) + } // end if inner_box + + if (btype == Shaded) { os << "\\begin{shaded}%\n"; - i += 1; + } - i += InsetText::latex(buf, os, runparams); + InsetText::latex(os, runparams); if (btype == Shaded) os << "\\end{shaded}"; if (params_.inner_box) { - if (params_.use_parbox) + if (params_.use_parbox || params_.use_makebox) os << "%\n}"; else os << "%\n\\end{minipage}"; @@ -388,8 +433,6 @@ int InsetBox::latex(Buffer const & buf, odocstream & os, os << "\\end{framed}"; break; case Boxed: - if (!params_.inner_box) - os << "}"; // for makebox os << "}"; break; case ovalbox: @@ -402,15 +445,11 @@ int InsetBox::latex(Buffer const & buf, odocstream & os, // already done break; } - - i += 2; - - return i; } -int InsetBox::plaintext(Buffer const & buf, odocstream & os, - OutputParams const & runparams) const +int InsetBox::plaintext(odocstringstream & os, + OutputParams const & runparams, size_t max_length) const { BoxType const btype = boxtranslator().find(params_.type); @@ -436,7 +475,7 @@ int InsetBox::plaintext(Buffer const & buf, odocstream & os, break; } - InsetText::plaintext(buf, os, runparams); + InsetText::plaintext(os, runparams, max_length); int len = 0; switch (btype) { @@ -471,10 +510,34 @@ int InsetBox::plaintext(Buffer const & buf, odocstream & os, } -int InsetBox::docbook(Buffer const & buf, odocstream & os, - OutputParams const & runparams) const +int InsetBox::docbook(odocstream & os, OutputParams const & runparams) const +{ + return InsetText::docbook(os, runparams); +} + + +docstring InsetBox::xhtml(XHTMLStream & xs, OutputParams const & runparams) const { - return InsetText::docbook(buf, os, runparams); + // construct attributes + string attrs = "class='" + params_.type + "'"; + string style; + if (!params_.width.empty()) { + string w = params_.width.asHTMLString(); + if (w != "100%") + style += ("width: " + params_.width.asHTMLString() + "; "); + } + // The special heights don't really mean anything for us. + if (!params_.height.empty() && params_.height_special == "none") + style += ("height: " + params_.height.asHTMLString() + "; "); + if (!style.empty()) + attrs += " style='" + style + "'"; + + xs << html::StartTag("div", attrs); + XHTMLOptions const opts = InsetText::WriteLabel | InsetText::WriteInnerTag; + docstring defer = InsetText::insetAsXHTML(xs, runparams, opts); + xs << html::EndTag("div"); + xs << defer; + return docstring(); } @@ -502,25 +565,17 @@ void InsetBox::validate(LaTeXFeatures & features) const features.require("framed"); break; } - InsetText::validate(features); + InsetCollapsable::validate(features); } -InsetBoxMailer::InsetBoxMailer(InsetBox & inset) - : inset_(inset) -{} - - -string const InsetBoxMailer::name_ = "box"; - - -string const InsetBoxMailer::inset2string(Buffer const &) const +string InsetBox::contextMenuName() const { - return params2string(inset_.params()); + return "context-box"; } -string const InsetBoxMailer::params2string(InsetBoxParams const & params) +string InsetBox::params2string(InsetBoxParams const & params) { ostringstream data; data << "box" << ' '; @@ -529,36 +584,47 @@ string const InsetBoxMailer::params2string(InsetBoxParams const & params) } -void InsetBoxMailer::string2params(string const & in, - InsetBoxParams & params) +void InsetBox::string2params(string const & in, InsetBoxParams & params) { - params = InsetBoxParams(string()); if (in.empty()) return; istringstream data(in); - Lexer lex(0,0); + Lexer lex; lex.setStream(data); string name; lex >> name; - if (!lex || name != name_) - return print_mailer_error("InsetBoxMailer", in, 1, name_); + if (!lex || name != "box") { + LYXERR0("InsetBox::string2params(" << in << ")\n" + "Expected arg 1 to be \"box\"\n"); + return; + } // This is part of the inset proper that is usually swallowed // by Text::readInset string id; lex >> id; - if (!lex || id != "Box") - return print_mailer_error("InsetBoxMailer", in, 2, "Box"); + if (!lex || id != "Box") { + LYXERR0("InsetBox::string2params(" << in << ")\n" + "Expected arg 2 to be \"Box\"\n"); + } + params = InsetBoxParams(string()); params.read(lex); } +///////////////////////////////////////////////////////////////////////// +// +// InsetBoxParams +// +///////////////////////////////////////////////////////////////////////// + InsetBoxParams::InsetBoxParams(string const & label) : type(label), use_parbox(false), + use_makebox(false), inner_box(true), width(Length("100col%")), special("none"), @@ -578,6 +644,7 @@ void InsetBoxParams::write(ostream & os) const os << "has_inner_box " << inner_box << "\n"; os << "inner_pos \"" << inner_pos << "\"\n"; os << "use_parbox " << use_parbox << "\n"; + os << "use_makebox " << use_makebox << "\n"; os << "width \"" << width.asString() << "\"\n"; os << "special \"" << special << "\"\n"; os << "height \"" << height.asString() << "\"\n"; @@ -587,126 +654,20 @@ void InsetBoxParams::write(ostream & os) const void InsetBoxParams::read(Lexer & lex) { - if (!lex.isOK()) - return; - - lex.next(); - type = lex.getString(); - - if (!lex) - return; - - lex.next(); - string token; - token = lex.getString(); - if (!lex) - return; - if (token == "position") { - lex.next(); - // The [0] is needed. We need the first and only char in - // this string -- MV - pos = lex.getString()[0]; - } else { - lyxerr << "InsetBox::Read: Missing 'position'-tag!" << token << endl; - lex.pushToken(token); - } - - lex.next(); - token = lex.getString(); - if (!lex) - return; - if (token == "hor_pos") { - lex.next(); - hor_pos = lex.getString()[0]; - } else { - lyxerr << "InsetBox::Read: Missing 'hor_pos'-tag!" << token << endl; - lex.pushToken(token); - } - - lex.next(); - token = lex.getString(); - if (!lex) - return; - if (token == "has_inner_box") { - lex.next(); - inner_box = lex.getInteger(); - } else { - lyxerr << "InsetBox::Read: Missing 'has_inner_box'-tag!" << endl; - lex.pushToken(token); - } - - lex.next(); - token = lex.getString(); - if (!lex) - return; - if (token == "inner_pos") { - lex.next(); - inner_pos = lex.getString()[0]; - } else { - lyxerr << "InsetBox::Read: Missing 'inner_pos'-tag!" - << token << endl; - lex.pushToken(token); - } - - lex.next(); - token = lex.getString(); - if (!lex) - return; - if (token == "use_parbox") { - lex.next(); - use_parbox = lex.getInteger(); - } else { - lyxerr << "InsetBox::Read: Missing 'use_parbox'-tag!" << endl; - lex.pushToken(token); - } - - lex.next(); - token = lex.getString(); - if (!lex) - return; - if (token == "width") { - lex.next(); - width = Length(lex.getString()); - } else { - lyxerr << "InsetBox::Read: Missing 'width'-tag!" << endl; - lex.pushToken(token); - } - - lex.next(); - token = lex.getString(); - if (!lex) - return; - if (token == "special") { - lex.next(); - special = lex.getString(); - } else { - lyxerr << "InsetBox::Read: Missing 'special'-tag!" << endl; - lex.pushToken(token); - } - - lex.next(); - token = lex.getString(); - if (!lex) - return; - if (token == "height") { - lex.next(); - height = Length(lex.getString()); - } else { - lyxerr << "InsetBox::Read: Missing 'height'-tag!" << endl; - lex.pushToken(token); - } - - lex.next(); - token = lex.getString(); - if (!lex) - return; - if (token == "height_special") { - lex.next(); - height_special = lex.getString(); - } else { - lyxerr << "InsetBox::Read: Missing 'height_special'-tag!" << endl; - lex.pushToken(token); - } + lex.setContext("InsetBoxParams::read"); + lex >> type; + lex >> "position" >> pos; + lex >> "hor_pos" >> hor_pos; + lex >> "has_inner_box" >> inner_box; + if (type == "Framed") + inner_box = false; + lex >> "inner_pos" >> inner_pos; + lex >> "use_parbox" >> use_parbox; + lex >> "use_makebox" >> use_makebox; + lex >> "width" >> width; + lex >> "special" >> special; + lex >> "height" >> height; + lex >> "height_special" >> height_special; }