]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetBox.cpp
de.po
[lyx.git] / src / insets / InsetBox.cpp
index 0156603f764d3906599bb496cceae9549ad6004d..7711277e0a90f2d6c22348fc8ebb1e3188ad19f2 100644 (file)
@@ -27,6 +27,8 @@
 #include "Lexer.h"
 #include "MetricsInfo.h"
 #include "output_xhtml.h"
+#include "TexRow.h"
+#include "texstream.h"
 #include "TextClass.h"
 
 #include "support/debug.h"
@@ -90,7 +92,7 @@ BoxTranslatorLoc const & boxtranslator_loc()
        return translator;
 }
 
-} // namespace anon
+} // namespace
 
 
 /////////////////////////////////////////////////////////////////////////
@@ -100,7 +102,7 @@ BoxTranslatorLoc const & boxtranslator_loc()
 /////////////////////////////////////////////////////////////////////////
 
 InsetBox::InsetBox(Buffer * buffer, string const & label)
-       : InsetCollapsable(buffer), params_(label)
+       : InsetCollapsible(buffer), params_(label)
 {}
 
 
@@ -114,14 +116,14 @@ docstring InsetBox::layoutName() const
 void InsetBox::write(ostream & os) const
 {
        params_.write(os);
-       InsetCollapsable::write(os);
+       InsetCollapsible::write(os);
 }
 
 
 void InsetBox::read(Lexer & lex)
 {
        params_.read(lex);
-       InsetCollapsable::read(lex);
+       InsetCollapsible::read(lex);
 }
 
 
@@ -158,12 +160,18 @@ void InsetBox::setButtonLabel()
                label = bformat(_("%1$s (%2$s, %3$s)"),
                        type, inner, frame);
        setLabel(label);
+
+       // set the frame color for the inset if the type is Boxed
+       if (btype == Boxed)
+               setFrameColor(lcolor.getFromLaTeXName(params_.framecolor));
+       else
+               setFrameColor(Color_collapsibleframe);
 }
 
 
 bool InsetBox::hasFixedWidth() const
 {
-       return !params_.width.empty();
+       return !params_.width.empty() && params_.special == "none";
 }
 
 
@@ -174,15 +182,15 @@ bool InsetBox::allowMultiPar() const
 }
 
 
-void InsetBox::metrics(MetricsInfo & m, Dimension & dim) const
+void InsetBox::metrics(MetricsInfo & mi, Dimension & dim) const
 {
        // back up textwidth.
-       int textwidth_backup = m.base.textwidth;
+       int textwidth_backup = mi.base.textwidth;
        if (hasFixedWidth())
-               m.base.textwidth = params_.width.inPixels(m.base);
-       InsetCollapsable::metrics(m, dim);
+               mi.base.textwidth = mi.base.inPixels(params_.width);
+       InsetCollapsible::metrics(mi, dim);
        // retore textwidth.
-       m.base.textwidth = textwidth_backup;
+       mi.base.textwidth = textwidth_backup;
 }
 
 
@@ -193,17 +201,65 @@ bool InsetBox::forcePlainLayout(idx_type) const
 }
 
 
+bool InsetBox::needsCProtection(bool const maintext, bool const fragile) const
+{
+       // We need to cprotect boxes that use minipages as inner box
+       // in fragile context
+       if (fragile && params_.inner_box && !params_.use_parbox && !params_.use_makebox)
+               return true;
+
+       return InsetText::needsCProtection(maintext, fragile);
+}
+
+
 ColorCode InsetBox::backgroundColor(PainterInfo const &) const
 {
-       if (params_.type != "Shaded")
-               return getLayout().bgcolor();
-       // FIXME: This hardcoded color is a hack!
-       if (buffer().params().boxbgcolor == lyx::rgbFromHexName("#ff0000"))
+       // we only support background color for 3 types
+       if (params_.type != "Shaded" && params_.type != "Frameless" && params_.type != "Boxed")
                return getLayout().bgcolor();
-       ColorCode c = lcolor.getFromLyXName("boxbgcolor");
-       if (c == Color_none)
-               return getLayout().bgcolor();
-       return c;
+
+       if (params_.type == "Shaded") {
+               // 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;
+       }
+
+       if (params_.backgroundcolor != "none")
+               return lcolor.getFromLaTeXName(params_.backgroundcolor);
+
+       return getLayout().bgcolor();
+}
+
+
+LyXAlignment InsetBox::contentAlignment() const
+{
+       // Custom horizontal alignment is only allowed with a fixed width
+       // and if either makebox or no inner box are used
+       if (params_.width.empty() || !(params_.use_makebox || !params_.inner_box))
+               return LYX_ALIGN_NONE;
+
+       // The default value below is actually irrelevant
+       LyXAlignment align = LYX_ALIGN_NONE;
+       switch (params_.hor_pos) {
+       case 'l':
+               align = LYX_ALIGN_LEFT;
+               break;
+       case 'c':
+               align = LYX_ALIGN_CENTER;
+               break;
+       case 'r':
+               align = LYX_ALIGN_RIGHT;
+               break;
+       case 's':
+               align = LYX_ALIGN_BLOCK;
+               break;
+       }
+       return align;
 }
 
 
@@ -223,16 +279,28 @@ void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd)
                        return;
                }
                cur.recordUndoInset(this);
-               if (change_type)
+               if (change_type) {
                        params_.type = cmd.getArg(1);
-               else // if (for_box)
+                       // set a makebox if there is no inner box but Frameless was exectued
+                       // otherwise the result would be a non existent box (no inner AND outer box)
+                       // (this was LyX bug 8712)
+                       if (params_.type == "Frameless" && !params_.inner_box) {
+                               params_.use_makebox = true;
+                               params_.inner_box = true;
+                       }
+                       // handle the opposite case
+                       if (params_.type == "Boxed" && params_.use_makebox) {
+                               params_.use_makebox = false;
+                               params_.inner_box = false;
+                       }
+               } else
                        string2params(to_utf8(cmd.argument()), params_);
                setButtonLabel();
                break;
        }
 
        default:
-               InsetCollapsable::doDispatch(cur, cmd);
+               InsetCollapsible::doDispatch(cur, cmd);
                break;
        }
 }
@@ -255,7 +323,7 @@ bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd,
                        flag.setEnabled(true);
                        return true;
                }
-               return InsetCollapsable::getStatus(cur, cmd, flag);
+               return InsetCollapsible::getStatus(cur, cmd, flag);
        }
 
        case LFUN_INSET_DIALOG_UPDATE:
@@ -263,23 +331,25 @@ bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd,
                return true;
 
        default:
-               return InsetCollapsable::getStatus(cur, cmd, flag);
+               return InsetCollapsible::getStatus(cur, cmd, flag);
        }
 }
 
 
+const string defaultThick = "0.4pt";
+const string defaultSep = "3pt";
+const string defaultShadow = "4pt";
+
 void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
 {
        BoxType btype = boxtranslator().find(params_.type);
 
        string width_string = params_.width.asLatexString();
        string thickness_string = params_.thickness.asLatexString();
-       const string defaultThick = "0.4pt";
        string separation_string = params_.separation.asLatexString();
-       const string defaultSep = "3pt";
        string shadowsize_string = params_.shadowsize.asLatexString();
-       const string defaultShadow = "4pt";
        bool stdwidth = false;
+       string const cprotect = hasCProtectContent(runparams.moving_arg) ? "\\cprotect" : string();
        // in general the overall width of some decorated boxes is wider thean the inner box
        // we could therefore calculate the real width for all sizes so that if the user wants
        // e.g. 0.1\columnwidth or 2cm he gets exactly this size
@@ -330,77 +400,79 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
        case Frameless:
                break;
        case Framed:
-               if (!(thickness_string.find(defaultThick) != string::npos)) {
+               if (thickness_string != defaultThick) {
                        os << "{\\FrameRule " << from_ascii(thickness_string);
-                       if (!(separation_string.find(defaultSep) != string::npos))
+                       if (separation_string != defaultSep)
                                os << "\\FrameSep " << from_ascii(separation_string);
                }
-               if (!(separation_string.find(defaultSep) != string::npos)
-                       && (thickness_string.find(defaultThick) != string::npos))
+               if (separation_string != defaultSep && thickness_string == defaultThick)
                        os << "{\\FrameSep " << from_ascii(separation_string);
 
                os << "\\begin{framed}%\n";
                break;
        case Boxed:
-               if (!(thickness_string.find(defaultThick) != string::npos)) {
+               if (thickness_string != defaultThick) {
                        os << "{\\fboxrule " << from_ascii(thickness_string);
-                       if (!(separation_string.find(defaultSep) != string::npos))
+                       if (separation_string != defaultSep)
                                os << "\\fboxsep " << from_ascii(separation_string);
                }
-               if (!(separation_string.find(defaultSep) != string::npos)
-                       && (thickness_string.find(defaultThick) != string::npos))
+               if (separation_string != defaultSep && thickness_string == defaultThick)
                        os << "{\\fboxsep " << from_ascii(separation_string);
-               if (!width_string.empty()) {
-                       if (!params_.inner_box) {
+               if (!params_.inner_box && !width_string.empty()) {
+                       if (params_.framecolor != "black" || params_.backgroundcolor != "none") {
+                               os << "\\fcolorbox{" << params_.framecolor << "}{" << params_.backgroundcolor << "}{";
+                               os << "\\makebox";
+                       } else
                                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 << "]";
+                       // Special widths, see usrguide sec. 3.5
+                       // FIXME UNICODE
+                       if (params_.special != "none") {
+                               os << "[" << params_.width.value()
+                                  << '\\' << from_utf8(params_.special)
+                                  << ']';
                        } else
-                               os << "\\fbox";
-               } else
-                       os << "\\fbox";
+                               os << '[' << from_ascii(width_string)
+                                  << ']';
+                       // default horizontal alignment is 'c'
+                       if (params_.hor_pos != 'c')
+                               os << "[" << params_.hor_pos << "]";
+               } else {
+                       if (params_.framecolor != "black" || params_.backgroundcolor != "none")
+                               os << "\\fcolorbox{" << params_.framecolor << "}{" << params_.backgroundcolor << "}";
+                       else
+                               os << cprotect << "\\fbox";
+               }
                os << "{";
                break;
        case ovalbox:
-               if (!separation_string.empty() && separation_string.find(defaultSep) == string::npos)
+               if (!separation_string.empty() && separation_string != defaultSep)
                        os << "{\\fboxsep " << from_ascii(separation_string);
                os << "\\ovalbox{";
                break;
        case Ovalbox:
-               if (!separation_string.empty() && separation_string.find(defaultSep) == string::npos)
+               if (!separation_string.empty() && separation_string != defaultSep)
                        os << "{\\fboxsep " << from_ascii(separation_string);
                os << "\\Ovalbox{";
                break;
        case Shadowbox:
-               if (!(thickness_string.find(defaultThick) != string::npos)) {
+               if (thickness_string != defaultThick) {
                        os << "{\\fboxrule " << from_ascii(thickness_string);
-                       if (!(separation_string.find(defaultSep) != string::npos)) {
+                       if (separation_string != defaultSep) {
                                os << "\\fboxsep " << from_ascii(separation_string);
-                               if (!(shadowsize_string.find(defaultShadow) != string::npos))
+                               if (shadowsize_string != defaultShadow)
                                        os << "\\shadowsize " << from_ascii(shadowsize_string);
                        }
-                       if (!(shadowsize_string.find(defaultShadow) != string::npos)
-                               && (separation_string.find(defaultSep) != string::npos))
+                       if (shadowsize_string != defaultShadow  && separation_string == defaultSep)
                                os << "\\shadowsize " << from_ascii(shadowsize_string);
                }
-               if (!(separation_string.find(defaultSep) != string::npos)
-                       && (thickness_string.find(defaultThick) != string::npos)) {
+               if (separation_string != defaultSep && thickness_string == defaultThick) {
                                os << "{\\fboxsep " << from_ascii(separation_string);
-                               if (!(shadowsize_string.find(defaultShadow) != string::npos))
+                               if (shadowsize_string != defaultShadow)
                                        os << "\\shadowsize " << from_ascii(shadowsize_string);
                }
-               if (!(shadowsize_string.find(defaultShadow) != string::npos)
-                               && (separation_string.find(defaultSep) != string::npos)
-                               && (thickness_string.find(defaultThick) != string::npos))
+               if (shadowsize_string != defaultShadow
+                               && separation_string == defaultSep
+                               && thickness_string == defaultThick)
                                os << "{\\shadowsize " << from_ascii(shadowsize_string);
                os << "\\shadowbox{";
                break;
@@ -409,23 +481,26 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
                // it is inside a minipage or parbox
                break;
        case Doublebox:
-               if (!(thickness_string.find(defaultThick) != string::npos)) {
+               if (thickness_string != defaultThick) {
                        os << "{\\fboxrule " << from_ascii(thickness_string);
-                       if (!(separation_string.find(defaultSep) != string::npos))
+                       if (separation_string != defaultSep)
                                os << "\\fboxsep " << from_ascii(separation_string);
                }
-               if (!(separation_string.find(defaultSep) != string::npos)
-                       && (thickness_string.find(defaultThick) != string::npos))
+               if (separation_string != defaultSep && thickness_string == defaultThick)
                        os << "{\\fboxsep " << from_ascii(separation_string);
                os << "\\doublebox{";
                break;
        }
 
        if (params_.inner_box) {
-               if (params_.use_parbox)
+               if (params_.use_parbox) {
+                       if (params_.backgroundcolor != "none" && btype == Frameless)
+                               os << "\\colorbox{" << params_.backgroundcolor << "}{";
                        os << "\\parbox";
-               else if (params_.use_makebox) {
+               else if (params_.use_makebox) {
                        if (!width_string.empty()) {
+                               if (params_.backgroundcolor != "none")
+                                       os << "\\colorbox{" << params_.backgroundcolor << "}{";
                                os << "\\makebox";
                                // FIXME UNICODE
                                // output the width and horizontal position
@@ -438,12 +513,19 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
                                           << ']';
                                if (params_.hor_pos != 'c')
                                        os << "[" << params_.hor_pos << "]";
-                       } else
-                               os << "\\mbox";
+                       } else {
+                               if (params_.backgroundcolor != "none")
+                                       os << "\\colorbox{" << params_.backgroundcolor << "}";
+                               else
+                                       os << "\\mbox";
+                       }
                        os << "{";
                }
-               else
+               else {
+                       if (params_.backgroundcolor != "none" && btype == Frameless)
+                               os << "\\colorbox{" << params_.backgroundcolor << "}{";
                        os << "\\begin{minipage}";
+               }
 
                // output parameters for parbox and minipage
                if (!params_.use_makebox) {
@@ -480,23 +562,6 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
                os << "\\begin{shaded}%\n";
        }
 
-       // \framebox and \makebox handle hor_pos their own way
-       // hor_pos is senseless for \mbox and \fbox
-       if (!(params_.use_makebox)
-               && !(btype == Boxed && !params_.inner_box)) {
-                       switch (params_.hor_pos) {
-                       case 'l':
-                               // do nothing because this is LaTeX's default
-                               break;
-                       case 'c':
-                               os << "\\centering ";
-                               break;
-                       case 'r':
-                               os << "\\raggedleft ";
-                               break;
-                       }
-       }
-
        InsetText::latex(os, runparams);
 
        if (btype == Shaded)
@@ -507,6 +572,9 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
                        os << "%\n}";
                else
                        os << "%\n\\end{minipage}";
+               if (params_.backgroundcolor != "none" && btype == Frameless
+                       && !(params_.use_makebox && width_string.empty()))
+                       os << "}";
        }
 
        switch (btype) {
@@ -514,37 +582,37 @@ void InsetBox::latex(otexstream & os, OutputParams const & runparams) const
                break;
        case Framed:
                os << "\\end{framed}";
-               if (!(separation_string.find(defaultSep) != string::npos)
-                       || !(thickness_string.find(defaultThick) != string::npos))
+               if (separation_string != defaultSep     || thickness_string != defaultThick)
                        os << "}";
                break;
        case Boxed:
                os << "}";
-               if (!(separation_string.find(defaultSep) != string::npos)
-                       || !(thickness_string.find(defaultThick) != string::npos))
+               if (!params_.inner_box && !width_string.empty()
+                       && (params_.framecolor != "black" || params_.backgroundcolor != "none"))
+                       os << "}";
+               if (separation_string != defaultSep     || thickness_string != defaultThick)
                        os << "}";
                break;
        case ovalbox:
                os << "}";
-               if (!(separation_string.find(defaultSep) != string::npos))
+               if (separation_string != defaultSep)
                        os << "}";
                break;
        case Ovalbox:
                os << "}";
-               if (!(separation_string.find(defaultSep) != string::npos))
+               if (separation_string != defaultSep)
                        os << "}";
                break;
        case Doublebox:
                os << "}";
-               if (!(separation_string.find(defaultSep) != string::npos)
-                       || !(thickness_string.find(defaultThick) != string::npos))
+               if (separation_string != defaultSep || thickness_string != defaultThick)
                        os << "}";
                break;
        case Shadowbox:
                os << "}";
-               if (!(separation_string.find(defaultSep) != string::npos)
-                       || !(thickness_string.find(defaultThick) != string::npos)
-                       || !(shadowsize_string.find(defaultShadow) != string::npos))
+               if (separation_string != defaultSep
+                       || thickness_string != defaultThick
+                       || shadowsize_string != defaultShadow)
                        os << "}";
                break;
        case Shaded:
@@ -652,6 +720,8 @@ void InsetBox::validate(LaTeXFeatures & features) const
        BoxType btype = boxtranslator().find(params_.type);
        switch (btype) {
        case Frameless:
+               if (params_.backgroundcolor != "none")
+                       features.require("xcolor");
                break;
        case Framed:
                features.require("calc");
@@ -659,6 +729,8 @@ void InsetBox::validate(LaTeXFeatures & features) const
                break;
        case Boxed:
                features.require("calc");
+               if (params_.framecolor != "black" || params_.backgroundcolor != "none")
+                       features.require("xcolor");
                break;
        case ovalbox:
        case Ovalbox:
@@ -672,7 +744,7 @@ void InsetBox::validate(LaTeXFeatures & features) const
                features.require("framed");
                break;
        }
-       InsetCollapsable::validate(features);
+       InsetCollapsible::validate(features);
 }
 
 
@@ -740,9 +812,11 @@ InsetBoxParams::InsetBoxParams(string const & label)
          inner_pos('t'),
          height(Length("1in")),
          height_special("totalheight"), // default is 1\\totalheight
-         thickness(Length("0.4pt")),
-         separation(Length("3pt")),
-         shadowsize(Length("4pt"))
+         thickness(Length(defaultThick)),
+         separation(Length(defaultSep)),
+         shadowsize(Length(defaultShadow)),
+         framecolor("black"),
+         backgroundcolor("none")
 {}
 
 
@@ -762,6 +836,8 @@ void InsetBoxParams::write(ostream & os) const
        os << "thickness \"" << thickness.asString() << "\"\n";
        os << "separation \"" << separation.asString() << "\"\n";
        os << "shadowsize \"" << shadowsize.asString() << "\"\n";
+       os << "framecolor \"" << framecolor << "\"\n";
+       os << "backgroundcolor \"" << backgroundcolor << "\"\n";
 }
 
 
@@ -784,6 +860,8 @@ void InsetBoxParams::read(Lexer & lex)
        lex >> "thickness" >> thickness;
        lex >> "separation" >> separation;
        lex >> "shadowsize" >> shadowsize;
+       lex >> "framecolor" >> framecolor;
+       lex >> "backgroundcolor" >> backgroundcolor;
 }