]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetBox.cpp
make code look a bit more uniform
[lyx.git] / src / insets / InsetBox.cpp
index ed131d50934a1f0a86dcbf0dc5b9ce7650442241..b81ac332f25bba197ca0805123bd3558ca353752 100644 (file)
 #include "InsetBox.h"
 
 #include "Buffer.h"
+#include "BufferParams.h"
 #include "BufferView.h"
 #include "Cursor.h"
 #include "DispatchResult.h"
-#include "debug.h"
 #include "FuncStatus.h"
 #include "FuncRequest.h"
-#include "gettext.h"
+#include "support/gettext.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
 #include "MetricsInfo.h"
+#include "TextClass.h"
 
+#include "support/debug.h"
 #include "support/Translator.h"
 
 #include <sstream>
 
+using namespace std;
 
 namespace lyx {
 
-using std::string;
-using std::istringstream;
-using std::ostream;
-using std::ostringstream;
-using std::endl;
-
-
 namespace {
 
-typedef Translator<std::string, InsetBox::BoxType> BoxTranslator;
+typedef Translator<string, InsetBox::BoxType> BoxTranslator;
 typedef Translator<docstring, InsetBox::BoxType> BoxTranslatorLoc;
 
 BoxTranslator const init_boxtranslator()
 {
        BoxTranslator translator("Boxed", InsetBox::Boxed);
        translator.addPair("Frameless", InsetBox::Frameless);
+       translator.addPair("Framed", InsetBox::Framed);
        translator.addPair("ovalbox", InsetBox::ovalbox);
        translator.addPair("Ovalbox", InsetBox::Ovalbox);
        translator.addPair("Shadowbox", InsetBox::Shadowbox);
+       translator.addPair("Shaded", InsetBox::Shaded);
        translator.addPair("Doublebox",InsetBox::Doublebox);
        return translator;
 }
@@ -59,12 +57,14 @@ BoxTranslator const init_boxtranslator()
 
 BoxTranslatorLoc const init_boxtranslator_loc()
 {
-       BoxTranslatorLoc translator(_("Boxed"), InsetBox::Boxed);
-       translator.addPair(_("Frameless"), InsetBox::Frameless);
-       translator.addPair(_("ovalbox"), InsetBox::ovalbox);
-       translator.addPair(_("Ovalbox"), InsetBox::Ovalbox);
-       translator.addPair(_("Shadowbox"), InsetBox::Shadowbox);
-       translator.addPair(_("Doublebox"), InsetBox::Doublebox);
+       BoxTranslatorLoc translator(_("simple frame"), InsetBox::Boxed);
+       translator.addPair(_("frameless"), InsetBox::Frameless);
+       translator.addPair(_("simple frame, page breaks"), InsetBox::Framed);
+       translator.addPair(_("oval, thin"), InsetBox::ovalbox);
+       translator.addPair(_("oval, thick"), InsetBox::Ovalbox);
+       translator.addPair(_("drop shadow"), InsetBox::Shadowbox);
+       translator.addPair(_("shaded background"), InsetBox::Shaded);
+       translator.addPair(_("double frame"), InsetBox::Doublebox);
        return translator;
 }
 
@@ -85,23 +85,11 @@ BoxTranslatorLoc const & boxtranslator_loc()
 } // anon
 
 
-void InsetBox::init()
+InsetBox::InsetBox(Buffer const & buffer, string const & label)
+       : InsetCollapsable(buffer), params_(label)
 {
-       setButtonLabel();
-}
-
-
-InsetBox::InsetBox(BufferParams const & bp, string const & label)
-       : InsetCollapsable(bp), params_(label)
-{
-       init();
-}
-
-
-InsetBox::InsetBox(InsetBox const & in)
-       : InsetCollapsable(in), params_(in.params_)
-{
-       init();
+       if (forceEmptyLayout())
+               paragraphs().back().setLayout(buffer.params().documentClass().emptyLayout());
 }
 
 
@@ -111,30 +99,33 @@ InsetBox::~InsetBox()
 }
 
 
-Inset * InsetBox::clone() const
+docstring InsetBox::editMessage() const
 {
-       return new InsetBox(*this);
+       return _("Opened Box Inset");
 }
 
 
-docstring const InsetBox::editMessage() const
+docstring InsetBox::name() const 
 {
-       return _("Opened Box Inset");
+       // FIXME: UNICODE
+       string name = "Box";
+       if (boxtranslator().find(params_.type) == Shaded)
+               name += string(":Shaded");
+       return from_ascii(name);
 }
 
 
-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);
-       setButtonLabel();
+       InsetCollapsable::read(lex);
 }
 
 
@@ -155,14 +146,12 @@ void InsetBox::setButtonLabel()
        label += ")";
 
        setLabel(label);
-
-       setLabelColor(Color_foreground);
 }
 
 
 bool InsetBox::hasFixedWidth() const
 {
-      return params_.inner_box || params_.special != "width";
+       return params_.inner_box || params_.special != "width";
 }
 
 
@@ -178,7 +167,7 @@ void InsetBox::metrics(MetricsInfo & m, Dimension & dim) const
 }
 
 
-bool InsetBox::forceDefaultParagraphs(idx_type) const
+bool InsetBox::forceEmptyLayout() const
 {
        return !params_.inner_box;
 }
@@ -199,7 +188,6 @@ void InsetBox::doDispatch(Cursor & cur, FuncRequest & cmd)
                //lyxerr << "InsetBox::dispatch MODIFY" << endl;
                InsetBoxMailer::string2params(to_utf8(cmd.argument()), params_);
                setLayout(cur.buffer().params());
-               setButtonLabel();
                break;
        }
 
@@ -245,21 +233,29 @@ bool InsetBox::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-int InsetBox::latex(Buffer const & buf, odocstream & os,
-                   OutputParams const & runparams) const
+bool InsetBox::isMacroScope() const
+{
+       BoxType btype = boxtranslator().find(params_.type);
+       return btype != Frameless || params_.inner_box;
+}
+
+
+int InsetBox::latex(odocstream & os, OutputParams const & runparams) const
 {
        BoxType btype = boxtranslator().find(params_.type);
 
        string width_string = params_.width.asLatexString();
-       bool stdwidth(false);
+       bool stdwidth = false;
        if (params_.inner_box &&
                        (width_string.find("1.0\\columnwidth") != string::npos
                        || width_string.find("1.0\\textwidth") != string::npos)) {
                stdwidth = true;
                switch (btype) {
                case Frameless:
+               case Framed:
                        break;
                case Boxed:
+               case Shaded:
                        width_string += " - 2\\fboxsep - 2\\fboxrule";
                        break;
                case ovalbox:
@@ -273,7 +269,7 @@ int InsetBox::latex(Buffer const & buf, odocstream & os,
                        width_string += " - 2\\fboxsep - 2\\fboxrule"/* "-\\shadowsize"*/;
                        break;
                case Doublebox:
-                       width_string += " - 2\\fboxsep - 7.5\\fboxrule - 1.0pt";
+                       width_string += " - 2\\fboxsep - 7.5\\fboxrule - 1pt";
                        break;
                }
        }
@@ -287,6 +283,10 @@ int InsetBox::latex(Buffer const & buf, odocstream & os,
        switch (btype) {
        case Frameless:
                break;
+       case Framed:
+               os << "\\begin{framed}%\n";
+               i += 1;
+               break;
        case Boxed:
                os << "\\framebox";
                if (!params_.inner_box) {
@@ -315,6 +315,9 @@ int InsetBox::latex(Buffer const & buf, odocstream & os,
        case Shadowbox:
                os << "\\shadowbox{";
                break;
+       case Shaded:
+               // later
+               break;
        case Doublebox:
                os << "\\doublebox{";
                break;
@@ -355,8 +358,14 @@ int InsetBox::latex(Buffer const & buf, odocstream & os,
                os << "%\n";
                i += 1;
        }
+       if (btype == Shaded)
+               os << "\\begin{shaded}%\n";
+               i += 1;
+
+       i += InsetText::latex(os, runparams);
 
-       i += InsetText::latex(buf, os, runparams);
+       if (btype == Shaded)
+               os << "\\end{shaded}";
 
        if (params_.inner_box) {
                if (params_.use_parbox)
@@ -368,6 +377,9 @@ int InsetBox::latex(Buffer const & buf, odocstream & os,
        switch (btype) {
        case Frameless:
                break;
+       case Framed:
+               os << "\\end{framed}";
+               break;
        case Boxed:
                if (!params_.inner_box)
                        os << "}"; // for makebox
@@ -379,49 +391,81 @@ int InsetBox::latex(Buffer const & buf, odocstream & os,
        case Shadowbox:
                os << "}";
                break;
+       case Shaded:
+               // already done
+               break;
        }
-       os << "%\n";
 
-       i += 3;
+       i += 2;
 
        return i;
 }
 
 
-int InsetBox::plaintext(Buffer const & buf, odocstream & os,
-                       OutputParams const & runparams) const
+int InsetBox::plaintext(odocstream & os, OutputParams const & runparams) const
 {
        BoxType const btype = boxtranslator().find(params_.type);
 
        switch (btype) {
-               case Frameless: break;
-               case Boxed:     os << "[\n";  break;
-               case ovalbox:   os << "(\n";  break;
-               case Ovalbox:   os << "((\n"; break;
-               case Shadowbox: os << "[/\n"; break;
-               case Doublebox: os << "[[\n"; break;
+               case Frameless:
+                       break;
+               case Framed:
+               case Boxed:
+                       os << "[\n";
+                       break;
+               case ovalbox:
+                       os << "(\n";
+                       break;
+               case Ovalbox:
+                       os << "((\n";
+                       break;
+               case Shadowbox:
+               case Shaded:
+                       os << "[/\n";
+                       break;
+               case Doublebox:
+                       os << "[[\n";
+                       break;
        }
 
-       InsetText::plaintext(buf, os, runparams);
+       InsetText::plaintext(os, runparams);
 
        int len = 0;
        switch (btype) {
-               case Frameless: os << "\n";            break;
-               case Boxed:     os << "\n]";  len = 1; break;
-               case ovalbox:   os << "\n)";  len = 1; break;
-               case Ovalbox:   os << "\n))"; len = 2; break;
-               case Shadowbox: os << "\n/]"; len = 2; break;
-               case Doublebox: os << "\n]]"; len = 2; break;
+               case Frameless:
+                       os << "\n";
+                       break;
+               case Framed:
+               case Boxed:
+                       os << "\n]";
+                       len = 1;
+                       break;
+               case ovalbox:
+                       os << "\n)";
+                       len = 1;
+                       break;
+               case Ovalbox:
+                       os << "\n))";
+                       len = 2;
+                       break;
+               case Shadowbox:
+               case Shaded:
+                       os << "\n/]";
+                       len = 2;
+                       break;
+               case Doublebox:
+                       os << "\n]]";
+                       len = 2;
+                       break;
        }
 
        return PLAINTEXT_NEWLINE + len; // len chars on a separate line
 }
 
 
-int InsetBox::docbook(Buffer const & buf, odocstream & os,
-                     OutputParams const & runparams) const
+int InsetBox::docbook(odocstream & os, OutputParams const & runparams) const
 {
-       return InsetText::docbook(buf, os, runparams);
+       return InsetText::docbook(os, runparams);
 }
 
 
@@ -431,6 +475,9 @@ void InsetBox::validate(LaTeXFeatures & features) const
        switch (btype) {
        case Frameless:
                break;
+       case Framed:
+               features.require("framed");
+               break;
        case Boxed:
                features.require("calc");
                break;
@@ -441,6 +488,10 @@ void InsetBox::validate(LaTeXFeatures & features) const
                features.require("calc");
                features.require("fancybox");
                break;
+       case Shaded:
+               features.require("color");
+               features.require("framed");
+               break;
        }
        InsetText::validate(features);
 }