]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCollapsable.cpp
Manage the initial setting of Default or Plain Layout more simply.
[lyx.git] / src / insets / InsetCollapsable.cpp
index a7939033c39ac541dd26719d7628b3cbb5fbd7cd..e2fbb3600c66adaaa727b7657a27fc84400f94ac 100644 (file)
@@ -4,8 +4,8 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Alejandro Aguilar Sierra
- * \author Jürgen Vigna
- * \author Lars Gullik Bjønnes
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -28,7 +28,9 @@
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
 #include "MetricsInfo.h"
+#include "paragraph_funcs.h"
 #include "ParagraphParameters.h"
+#include "sgml.h"
 #include "TextClass.h"
 
 #include "frontends/FontMetrics.h"
@@ -44,29 +46,53 @@ using namespace std;
 
 namespace lyx {
 
-InsetCollapsable::CollapseStatus InsetCollapsable::status() const
+InsetCollapsable::CollapseStatus InsetCollapsable::status(BufferView const & bv) const
 {
-       if (decoration() == InsetLayout::Conglomerate)
+       if (decoration() == InsetLayout::CONGLOMERATE)
                return status_;
-       return autoOpen_ ? Open : status_;
+       return auto_open_[&bv] ? Open : status_;
+}
+
+
+InsetCollapsable::Geometry InsetCollapsable::geometry(BufferView const & bv) const
+{
+       switch (decoration()) {
+       case InsetLayout::CLASSIC:
+               if (status(bv) == Open)
+                       return openinlined_ ? LeftButton : TopButton;
+               return ButtonOnly;
+
+       case InsetLayout::MINIMALISTIC:
+               return status(bv) == Open ? NoButton : ButtonOnly ;
+
+       case InsetLayout::CONGLOMERATE:
+               return status(bv) == Open ? SubLabel : Corners ;
+
+       case InsetLayout::DEFAULT:
+               break; // this shouldn't happen
+       }
+
+       // dummy return value to shut down a warning,
+       // this is dead code.
+       return NoButton;
 }
 
 
 InsetCollapsable::Geometry InsetCollapsable::geometry() const
 {
        switch (decoration()) {
-       case InsetLayout::Classic:
-               if (status() == Open)
+       case InsetLayout::CLASSIC:
+               if (status_ == Open)
                        return openinlined_ ? LeftButton : TopButton;
                return ButtonOnly;
 
-       case InsetLayout::Minimalistic:
-               return status() == Open ? NoButton : ButtonOnly ;
+       case InsetLayout::MINIMALISTIC:
+               return status_ == Open ? NoButton : ButtonOnly ;
 
-       case InsetLayout::Conglomerate:
-               return status() == Open ? SubLabel : Corners ;
+       case InsetLayout::CONGLOMERATE:
+               return status_ == Open ? SubLabel : Corners ;
 
-       case InsetLayout::Default:
+       case InsetLayout::DEFAULT:
                break; // this shouldn't happen
        }
 
@@ -76,40 +102,37 @@ InsetCollapsable::Geometry InsetCollapsable::geometry() const
 }
 
 
-InsetCollapsable::InsetCollapsable(Buffer const & buf,
-               CollapseStatus status)
-       : InsetText(buf), status_(status),
-         openinlined_(false), autoOpen_(false), mouse_hover_(false)
+InsetCollapsable::InsetCollapsable(Buffer const & buf, InsetText::UsePlain ltype)
+       : InsetText(buf, ltype), status_(Inset::Open),
+         openinlined_(false), mouse_hover_(false)
 {
-       DocumentClass const & dc = buf.params().documentClass();
-       setLayout(&dc);
+       setLayout(&buf.params().documentClass());
        setAutoBreakRows(true);
        setDrawFrame(true);
        setFrameColor(Color_collapsableframe);
-       paragraphs().back().setLayout(dc.plainLayout());
 }
 
 
 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
        : InsetText(rhs),
-               layout_(rhs.layout_),
-               labelstring_(rhs.labelstring_),
-               button_dim(rhs.button_dim),
-               status_(rhs.status_),
-               openinlined_(rhs.openinlined_),
-               autoOpen_(rhs.autoOpen_),
-               // the sole purpose of this copy constructor
-               mouse_hover_(false)
+         status_(rhs.status_),
+         layout_(rhs.layout_),
+         labelstring_(rhs.labelstring_),
+         button_dim(rhs.button_dim),
+         openinlined_(rhs.openinlined_),
+         auto_open_(rhs.auto_open_),
+         // the sole purpose of this copy constructor
+         mouse_hover_(false)
 {
 }
 
 
 docstring InsetCollapsable::toolTip(BufferView const & bv, int x, int y) const
 {
-       Dimension dim = dimensionCollapsed();
-       if (geometry() == NoButton)
+       Dimension dim = dimensionCollapsed(bv);
+       if (geometry(bv) == NoButton)
                return translateIfPossible(layout_->labelstring());
-       if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des || isOpen())
+       if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des || isOpen(bv))
                return docstring();
 
        OutputParams rp(&buffer().params().encoding());
@@ -170,8 +193,10 @@ void InsetCollapsable::read(Lexer & lex)
 
        // this must be set before we enter InsetText::read()
        setLayout(buffer().params());
-
        InsetText::read(lex);
+       // set button label again as the inset contents was not read yet at
+       // setLayout() time.
+       setButtonLabel();
 
        // Force default font, if so requested
        // This avoids paragraphs in buffer language that would have a
@@ -184,12 +209,12 @@ void InsetCollapsable::read(Lexer & lex)
 }
 
 
-Dimension InsetCollapsable::dimensionCollapsed() const
+Dimension InsetCollapsable::dimensionCollapsed(BufferView const & bv) const
 {
        LASSERT(layout_, /**/);
        Dimension dim;
        theFontMetrics(layout_->labelfont()).buttonText(
-               labelstring_, dim.wid, dim.asc, dim.des);
+               buttonLabel(bv), dim.wid, dim.asc, dim.des);
        return dim;
 }
 
@@ -198,13 +223,15 @@ void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
 {
        LASSERT(layout_, /**/);
 
-       autoOpen_ = mi.base.bv->cursor().isInside(this);
+       auto_open_[mi.base.bv] =  mi.base.bv->cursor().isInside(this);
 
        FontInfo tmpfont = mi.base.font;
        mi.base.font = layout_->font();
        mi.base.font.realize(tmpfont);
 
-       switch (geometry()) {
+       BufferView const & bv = *mi.base.bv;
+
+       switch (geometry(bv)) {
        case NoButton:
                InsetText::metrics(mi, dim);
                break;
@@ -223,15 +250,16 @@ void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
                int w = 0;
                int a = 0;
                int d = 0;
-               theFontMetrics(font).rectText(labelstring_, w, a, d);
+               theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
                dim.des += a + d;
                break;
                }
        case TopButton:
        case LeftButton:
        case ButtonOnly:
-               dim = dimensionCollapsed();
-               if (geometry() == TopButton || geometry() == LeftButton) {
+               dim = dimensionCollapsed(bv);
+               if (geometry(bv) == TopButton 
+                         || geometry(bv) == LeftButton) {
                        Dimension textdim;
                        InsetText::metrics(mi, textdim);
                        openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
@@ -262,27 +290,26 @@ bool InsetCollapsable::setMouseHover(bool mouse_hover)
 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 {
        LASSERT(layout_, /**/);
+       BufferView const & bv = *pi.base.bv;
 
-       autoOpen_ = pi.base.bv->cursor().isInside(this);
-       ColorCode const old_color = pi.background_color;
-       pi.background_color = backgroundColor();
+       auto_open_[&bv] =  bv.cursor().isInside(this);
 
        FontInfo tmpfont = pi.base.font;
        pi.base.font = layout_->font();
        pi.base.font.realize(tmpfont);
 
        // Draw button first -- top, left or only
-       Dimension dimc = dimensionCollapsed();
+       Dimension dimc = dimensionCollapsed(bv);
 
-       if (geometry() == TopButton ||
-           geometry() == LeftButton ||
-           geometry() == ButtonOnly) {
+       if (geometry(*pi.base.bv) == TopButton ||
+           geometry(*pi.base.bv) == LeftButton ||
+           geometry(*pi.base.bv) == ButtonOnly) {
                button_dim.x1 = x + 0;
                button_dim.x2 = x + dimc.width();
                button_dim.y1 = y - dimc.asc;
                button_dim.y2 = y + dimc.des;
 
-               pi.pain.buttonText(x, y, labelstring_, layout_->labelfont(),
+               pi.pain.buttonText(x, y, buttonLabel(bv), layout_->labelfont(),
                        mouse_hover_);
        } else {
                button_dim.x1 = 0;
@@ -291,10 +318,10 @@ void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
                button_dim.y2 = 0;
        }
 
-       Dimension const textdim = InsetText::dimension(*pi.base.bv);
+       Dimension const textdim = InsetText::dimension(bv);
        int const baseline = y;
        int textx, texty;
-       switch (geometry()) {
+       switch (geometry(bv)) {
        case LeftButton:
                textx = x + dimc.width();
                texty = baseline;
@@ -321,7 +348,7 @@ void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
                const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
 
                int desc = textdim.descent();
-               if (geometry() == Corners)
+               if (geometry(bv) == Corners)
                        desc -= 3;
 
                const int xx1 = x + TEXT_TO_INSET_OFFSET - 1;
@@ -346,7 +373,7 @@ void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
                        y + desc - 4, layout_->labelfont().color());
 
                // the label below the text. Can be toggled.
-               if (geometry() == SubLabel) {
+               if (geometry(bv) == SubLabel) {
                        FontInfo font(layout_->labelfont());
                        font.realize(sane_font);
                        font.decSize();
@@ -354,15 +381,15 @@ void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
                        int w = 0;
                        int a = 0;
                        int d = 0;
-                       theFontMetrics(font).rectText(labelstring_, w, a, d);
+                       theFontMetrics(font).rectText(buttonLabel(bv), w, a, d);
                        int const ww = max(textdim.wid, w);
                        pi.pain.rectText(x + (ww - w) / 2, y + desc + a,
-                               labelstring_, font, Color_none, Color_none);
+                               buttonLabel(bv), font, Color_none, Color_none);
                        desc += d;
                }
 
                // a visual cue when the cursor is inside the inset
-               Cursor & cur = pi.base.bv->cursor();
+               Cursor const & cur = bv.cursor();
                if (cur.isInside(this)) {
                        y -= textdim.asc;
                        y += 3;
@@ -375,7 +402,6 @@ void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
                }
                break;
        }
-       pi.background_color = old_color;
 
        pi.base.font = tmpfont;
 }
@@ -384,19 +410,19 @@ void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 void InsetCollapsable::cursorPos(BufferView const & bv,
                CursorSlice const & sl, bool boundary, int & x, int & y) const
 {
-       if (geometry() == ButtonOnly)
+       if (geometry(bv) == ButtonOnly)
                status_ = Open;
-       LASSERT(geometry() != ButtonOnly, /**/);
+       LASSERT(geometry(bv) != ButtonOnly, /**/);
 
        InsetText::cursorPos(bv, sl, boundary, x, y);
        Dimension const textdim = InsetText::dimension(bv);
 
-       switch (geometry()) {
+       switch (geometry(bv)) {
        case LeftButton:
-               x += dimensionCollapsed().wid;
+               x += dimensionCollapsed(bv).wid;
                break;
        case TopButton: {
-               y += dimensionCollapsed().des + textdim.asc;
+               y += dimensionCollapsed(bv).des + textdim.asc;
                break;
        }
        case NoButton:
@@ -461,9 +487,9 @@ void InsetCollapsable::edit(Cursor & cur, bool front, EntryDirection entry_from)
 Inset * InsetCollapsable::editXY(Cursor & cur, int x, int y)
 {
        //lyxerr << "InsetCollapsable: edit xy" << endl;
-       if (geometry() == ButtonOnly
+       if (geometry(cur.bv()) == ButtonOnly
         || (button_dim.contains(x, y) 
-         && geometry() != NoButton))
+         && geometry(cur.bv()) != NoButton))
                return this;
        cur.push(*this);
        return InsetText::editXY(cur, x, y);
@@ -493,7 +519,7 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
                                cur.noUpdate();
                                break;
                        }
-               } else if (geometry() != ButtonOnly)
+               } else if (geometry(cur.bv()) != ButtonOnly)
                        InsetText::doDispatch(cur, cmd);
                else
                        cur.undispatched();
@@ -504,7 +530,7 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
        case LFUN_MOUSE_TRIPLE:
                if (hitButton(cmd)) 
                        cur.noUpdate();
-               else if (geometry() != ButtonOnly)
+               else if (geometry(cur.bv()) != ButtonOnly)
                        InsetText::doDispatch(cur, cmd);
                else
                        cur.undispatched();
@@ -513,7 +539,7 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
        case LFUN_MOUSE_RELEASE:
                if (!hitButton(cmd)) {
                        // The mouse click has to be within the inset!
-                       if (geometry() != ButtonOnly)
+                       if (geometry(cur.bv()) != ButtonOnly)
                                InsetText::doDispatch(cur, cmd);
                        else
                                cur.undispatched();                     
@@ -532,7 +558,7 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
                // toggle the inset visual state.
                cur.dispatched();
                cur.updateFlags(Update::Force | Update::FitCursor);
-               if (geometry() == ButtonOnly) {
+               if (geometry(cur.bv()) == ButtonOnly) {
                        setStatus(cur, Open);
                        edit(cur, true);
                }
@@ -549,7 +575,7 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
                else if (cmd.argument() == "toggle" || cmd.argument().empty())
                        if (status_ == Open) {
                                setStatus(cur, Collapsed);
-                               if (geometry() == ButtonOnly)
+                               if (geometry(cur.bv()) == ButtonOnly)
                                        cur.top().forwardPos();
                        } else
                                setStatus(cur, Open);
@@ -595,8 +621,7 @@ bool InsetCollapsable::allowMultiPar() const
 
 void InsetCollapsable::resetParagraphsFont()
 {
-       Font font;
-       font.fontInfo() = inherit_font;
+       Font font(inherit_font, buffer().params().language);
        if (layout_->isForceLtr())
                font.setLanguage(latex_language);
        if (layout_->isPassThru()) {
@@ -685,6 +710,7 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
        case LFUN_NOTE_INSERT:
        case LFUN_NOTE_NEXT:
        case LFUN_OPTIONAL_INSERT:
+       case LFUN_PHANTOM_INSERT:
        case LFUN_REFERENCE_NEXT:
        case LFUN_SERVER_GOTO_FILE_ROW:
        case LFUN_SERVER_NOTIFY:
@@ -756,19 +782,19 @@ docstring InsetCollapsable::floatName(
 InsetLayout::InsetDecoration InsetCollapsable::decoration() const
 {
        if (!layout_)
-               return InsetLayout::Classic;
+               return InsetLayout::CLASSIC;
        InsetLayout::InsetDecoration const dec = layout_->decoration();
        switch (dec) {
-       case InsetLayout::Classic:
-       case InsetLayout::Minimalistic:
-       case InsetLayout::Conglomerate:
+       case InsetLayout::CLASSIC:
+       case InsetLayout::MINIMALISTIC:
+       case InsetLayout::CONGLOMERATE:
                return dec;
-       case InsetLayout::Default:
+       case InsetLayout::DEFAULT:
                break;
        }
        if (lyxCode() == FLEX_CODE)
-               return InsetLayout::Conglomerate;
-       return InsetLayout::Classic;
+               return InsetLayout::CONGLOMERATE;
+       return InsetLayout::CLASSIC;
 }
 
 
@@ -777,7 +803,7 @@ int InsetCollapsable::latex(odocstream & os,
 {
        // FIXME: What should we do layout_ is 0?
        // 1) assert
-       // 2) through an error
+       // 2) throw an error
        if (!layout_)
                return 0;
 
@@ -786,7 +812,7 @@ int InsetCollapsable::latex(odocstream & os,
        // collapsable insets should not redefine this, non-standard ones may
        // call this.
        if (!layout_->latexname().empty()) {
-               if (layout_->latextype() == "command") {
+               if (layout_->latextype() == InsetLayout::COMMAND) {
                        // FIXME UNICODE
                        if (runparams.moving_arg)
                                os << "\\protect";
@@ -794,7 +820,7 @@ int InsetCollapsable::latex(odocstream & os,
                        if (!layout_->latexparam().empty())
                                os << from_utf8(layout_->latexparam());
                        os << '{';
-               } else if (layout_->latextype() == "environment") {
+               } else if (layout_->latextype() == InsetLayout::ENVIRONMENT) {
                        os << "%\n\\begin{" << from_utf8(layout_->latexname()) << "}\n";
                        if (!layout_->latexparam().empty())
                                os << from_utf8(layout_->latexparam());
@@ -807,9 +833,9 @@ int InsetCollapsable::latex(odocstream & os,
                rp.moving_arg = true;
        int i = InsetText::latex(os, rp);
        if (!layout_->latexname().empty()) {
-               if (layout_->latextype() == "command") {
+               if (layout_->latextype() == InsetLayout::COMMAND) {
                        os << "}";
-               } else if (layout_->latextype() == "environment") {
+               } else if (layout_->latextype() == InsetLayout::ENVIRONMENT) {
                        os << "\n\\end{" << from_utf8(layout_->latexname()) << "}\n";
                        i += 4;
                }
@@ -818,6 +844,31 @@ int InsetCollapsable::latex(odocstream & os,
 }
 
 
+// FIXME It seems as if it ought to be possible to do this more simply,
+// maybe by calling InsetText::docbook() in the middle there.
+int InsetCollapsable::docbook(odocstream & os, OutputParams const & runparams) const
+{
+       ParagraphList::const_iterator const beg = paragraphs().begin();
+       ParagraphList::const_iterator par = paragraphs().begin();
+       ParagraphList::const_iterator const end = paragraphs().end();
+
+       if (!undefined())
+               sgml::openTag(os, getLayout().latexname(),
+                             par->getID(buffer(), runparams) + getLayout().latexparam());
+
+       for (; par != end; ++par) {
+               par->simpleDocBookOnePar(buffer(), os, runparams,
+                                        outerFont(distance(beg, par),
+                                                  paragraphs()));
+       }
+
+       if (!undefined())
+               sgml::closeTag(os, getLayout().latexname());
+
+       return 0;
+}
+
+
 void InsetCollapsable::validate(LaTeXFeatures & features) const
 {
        string const preamble = getLayout().preamble();
@@ -838,17 +889,25 @@ bool InsetCollapsable::undefined() const
 docstring InsetCollapsable::contextMenu(BufferView const & bv, int x,
        int y) const
 {
-       if (decoration() == InsetLayout::Conglomerate)
+       if (decoration() == InsetLayout::CONGLOMERATE)
                return from_ascii("context-conglomerate");
 
-       if (geometry() == NoButton)
+       if (geometry(bv) == NoButton)
                return from_ascii("context-collapsable");
 
-       Dimension dim = dimensionCollapsed();
+       Dimension dim = dimensionCollapsed(bv);
        if (x < xo(bv) + dim.wid && y < yo(bv) + dim.des)
                return from_ascii("context-collapsable");
 
        return InsetText::contextMenu(bv, x, y);
 }
 
+void InsetCollapsable::tocString(odocstream & os) const
+{
+       if (!getLayout().isInToc())
+               return;
+       os << text().asString(0, 1, AS_STR_LABEL | AS_STR_INSETS);
+}
+
+
 } // namespace lyx