]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetBox.cpp
Whitespace
[lyx.git] / src / insets / InsetBox.cpp
index 296b29a7a2ce1698c29754cb002d6c41a8abbe04..c96a7c9e7d11375d5a2fac0ec9537743a63fe0c1 100644 (file)
@@ -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.
  */
@@ -17,6 +17,7 @@
 #include "Buffer.h"
 #include "BufferParams.h"
 #include "BufferView.h"
+#include "ColorSet.h"
 #include "Cursor.h"
 #include "DispatchResult.h"
 #include "FuncStatus.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"
@@ -75,14 +78,14 @@ BoxTranslatorLoc initBoxtranslatorLoc()
 
 BoxTranslator const & boxtranslator()
 {
-       static BoxTranslator translator = initBoxtranslator();
+       static BoxTranslator const translator = initBoxtranslator();
        return translator;
 }
 
 
 BoxTranslatorLoc const & boxtranslator_loc()
 {
-       static BoxTranslatorLoc translator = initBoxtranslatorLoc();
+       static BoxTranslatorLoc const translator = initBoxtranslatorLoc();
        return translator;
 }
 
@@ -95,30 +98,15 @@ BoxTranslatorLoc const & boxtranslator_loc()
 //
 /////////////////////////////////////////////////////////////////////////
 
-InsetBox::InsetBox(Buffer const & buffer, string const & label)
+InsetBox::InsetBox(Buffer * buffer, string const & label)
        : InsetCollapsable(buffer), params_(label)
 {}
 
 
-InsetBox::~InsetBox()
-{
-       hideDialogs("box", this);
-}
-
-
-docstring InsetBox::editMessage() const
-{
-       return _("Opened Box Inset");
-}
-
-
-docstring InsetBox::name() const 
+docstring InsetBox::layoutName() const
 {
        // FIXME: UNICODE
-       string name = "Box";
-       if (boxtranslator().find(params_.type) == Shaded)
-               name += ":Shaded";
-       return from_ascii(name);
+       return from_ascii("Box:" + params_.type);
 }
 
 
@@ -146,6 +134,8 @@ void InsetBox::setButtonLabel()
        if (params_.inner_box) {
                if (params_.use_parbox)
                        inner = _("Parbox");
+               else if (params_.use_makebox)
+                       inner = _("Makebox");
                else
                        inner = _("Minipage");
        }
@@ -172,7 +162,7 @@ void InsetBox::setButtonLabel()
 
 bool InsetBox::hasFixedWidth() const
 {
-       return params_.inner_box || params_.special != "width";
+       return !params_.width.empty();
 }
 
 
@@ -190,36 +180,49 @@ void InsetBox::metrics(MetricsInfo & m, Dimension & dim) const
 
 bool InsetBox::forcePlainLayout(idx_type) const
 {
-       return !params_.inner_box && params_.type != "Framed";
+       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
 {
-       bv->showDialog("box", params2string(params_),
-               const_cast<InsetBox *>(this));
-       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;
-               if (cmd.getArg(0) == "changetype")
+               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;
+               }
+               cur.recordUndoInset(ATOMIC_UNDO, this);
+               if (change_type)
                        params_.type = cmd.getArg(1);
-               else
+               else // if (for_box)
                        string2params(to_utf8(cmd.argument()), params_);
-               setLayout(cur.buffer().params());
+               setButtonLabel();
                break;
        }
 
-       case LFUN_INSET_DIALOG_UPDATE:
-               cur.bv().updateDialog("box", params2string(params_));
-               break;
-
        default:
                InsetCollapsable::doDispatch(cur, cmd);
                break;
@@ -230,20 +233,30 @@ 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:
-               if (cmd.getArg(0) == "changetype")
-                       flag.setOnOff(cmd.getArg(1) == params_.type);
-               flag.setEnabled(true);
-               return true;
+       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_DIALOG_UPDATE:
                flag.setEnabled(true);
                return true;
 
-       case LFUN_BREAK_PARAGRAPH:
-               if (params_.inner_box || params_.type == "Framed")
+       case LFUN_PARAGRAPH_BREAK:
+               if ((params_.inner_box && !params_.use_makebox)
+                    || params_.type == "Shaded" || params_.type == "Framed")
                        return InsetCollapsable::getStatus(cur, cmd, flag);
                flag.setEnabled(false);
                return true;
@@ -254,12 +267,13 @@ bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-int InsetBox::latex(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;
+       // 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)) {
@@ -288,8 +302,10 @@ int InsetBox::latex(odocstream & os, OutputParams const & runparams) const
                }
        }
 
-       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";
@@ -299,25 +315,26 @@ int InsetBox::latex(odocstream & os, OutputParams const & runparams) const
                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:
@@ -330,7 +347,8 @@ int InsetBox::latex(odocstream & os, OutputParams const & runparams) const
                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{";
@@ -340,50 +358,69 @@ int InsetBox::latex(odocstream & os, OutputParams const & runparams) const
        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;
-       }
+       } // end if inner_box
+
        if (btype == Shaded) {
                os << "\\begin{shaded}%\n";
-               ++i;
        }
 
-       i += InsetText::latex(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}";
@@ -396,8 +433,6 @@ int InsetBox::latex(odocstream & os, OutputParams const & runparams) const
                os << "\\end{framed}";
                break;
        case Boxed:
-               if (!params_.inner_box)
-                       os << "}"; // for makebox
                os << "}";
                break;
        case ovalbox:
@@ -410,14 +445,11 @@ int InsetBox::latex(odocstream & os, OutputParams const & runparams) const
                // already done
                break;
        }
-
-       i += 2;
-
-       return i;
 }
 
 
-int InsetBox::plaintext(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);
 
@@ -443,7 +475,7 @@ int InsetBox::plaintext(odocstream & os, OutputParams const & runparams) const
                        break;
        }
 
-       InsetText::plaintext(os, runparams);
+       InsetText::plaintext(os, runparams, max_length);
 
        int len = 0;
        switch (btype) {
@@ -484,6 +516,31 @@ int InsetBox::docbook(odocstream & os, OutputParams const & runparams) const
 }
 
 
+docstring InsetBox::xhtml(XHTMLStream & xs, OutputParams const & runparams) const
+{
+       // 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();
+}
+
+
 void InsetBox::validate(LaTeXFeatures & features) const
 {
        BoxType btype = boxtranslator().find(params_.type);
@@ -508,13 +565,13 @@ void InsetBox::validate(LaTeXFeatures & features) const
                features.require("framed");
                break;
        }
-       InsetText::validate(features);
+       InsetCollapsable::validate(features);
 }
 
 
-docstring InsetBox::contextMenu(BufferView const &, int, int) const
+string InsetBox::contextMenuName() const
 {
-       return from_ascii("context-box");
+       return "context-box";
 }
 
 
@@ -529,7 +586,6 @@ string InsetBox::params2string(InsetBoxParams const & params)
 
 void InsetBox::string2params(string const & in, InsetBoxParams & params)
 {
-       params = InsetBoxParams(string());
        if (in.empty())
                return;
 
@@ -554,6 +610,7 @@ void InsetBox::string2params(string const & in, InsetBoxParams & params)
                                          "Expected arg 2 to be \"Box\"\n");
        }
 
+       params = InsetBoxParams(string());
        params.read(lex);
 }
 
@@ -567,6 +624,7 @@ void InsetBox::string2params(string const & in, InsetBoxParams & params)
 InsetBoxParams::InsetBoxParams(string const & label)
        : type(label),
          use_parbox(false),
+         use_makebox(false),
          inner_box(true),
          width(Length("100col%")),
          special("none"),
@@ -586,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";
@@ -604,6 +663,7 @@ void InsetBoxParams::read(Lexer & lex)
                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;