]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCollapsable.cpp
Fix text frame drawing.
[lyx.git] / src / insets / InsetCollapsable.cpp
index 6e421d31c073dc3a42f8d27666635c0ce6ce1cdc..3cd5c58c716a5d5fcae8fcb243eaae7a7bcc059b 100644 (file)
@@ -24,6 +24,7 @@
 #include "FuncStatus.h"
 #include "gettext.h"
 #include "Color.h"
+#include "LaTeXFeatures.h"
 #include "Lexer.h"
 #include "FuncRequest.h"
 #include "MetricsInfo.h"
 
 namespace lyx {
 
-using graphics::PreviewLoader;
-
 using std::endl;
 using std::string;
-using std::max;
-using std::min;
 using std::ostream;
 
 
 InsetCollapsable::CollapseStatus InsetCollapsable::status() const
 {
-       return (autoOpen_ && status_ != Inlined) ? Open : status_;
+       return autoOpen_ ? Open : status_;
+}
+
+
+InsetCollapsable::Geometry InsetCollapsable::geometry() const
+{
+       switch (decoration()) {
+       case Classic:
+               if (status() == Open) {
+                       if (openinlined_)
+                               return LeftButton;
+                       else
+                               return TopButton;
+               } else
+                       return ButtonOnly;
+
+       case Minimalistic:
+               return status() == Open ? NoButton : ButtonOnly ;
+
+       case Conglomerate:
+               return status() == Open ? SubLabel : Corners ;
+       }
+
+       // dummy return value to shut down a warning,
+       // this is dead code.
+       return NoButton;
 }
 
 
 InsetCollapsable::InsetCollapsable
                (BufferParams const & bp, CollapseStatus status)
-       : InsetText(bp), label(from_ascii("Label")), status_(status),
+       : InsetText(bp), status_(status),
          openinlined_(false), autoOpen_(false), mouse_hover_(false)
 {
        setAutoBreakRows(true);
        setDrawFrame(true);
        setFrameColor(Color::collapsableframe);
        setButtonLabel();
+       // Fallback for lacking inset layout item
+       layout_.bgcolor = Color::background;
 }
 
 
 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
        : InsetText(rhs),
-               layout_(rhs.layout_),
                button_dim(rhs.button_dim),
                topx(rhs.topx),
                topbaseline(rhs.topbaseline),
-               label(rhs.label),
+               layout_(rhs.layout_),
                status_(rhs.status_),
                openinlined_(rhs.openinlined_),
                autoOpen_(rhs.autoOpen_),
-               textdim_(rhs.textdim_),
                // the sole purpose of this copy constructor
                mouse_hover_(false)
 {
@@ -80,8 +102,7 @@ InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
 
 void  InsetCollapsable::setLayout(BufferParams const & bp)
 {
-       setLabelFont(getLayout(bp).labelfont);
-       setLabel(getLayout(bp).labelstring);
+       layout_ = getLayout(bp);
 }
 
 
@@ -95,9 +116,6 @@ void InsetCollapsable::write(Buffer const & buf, ostream & os) const
        case Collapsed:
                os << "collapsed";
                break;
-       case Inlined:
-               os << "inlined";
-               break;
        }
        os << "\n";
        text_.write(buf, os);
@@ -114,10 +132,7 @@ void InsetCollapsable::read(Buffer const & buf, Lexer & lex)
                        lex.next();
                        string const tmp_token = lex.getString();
 
-                       if (tmp_token == "inlined") {
-                               status_ = Inlined;
-                               token_found = true;
-                       } else if (tmp_token == "collapsed") {
+                       if (tmp_token == "collapsed") {
                                status_ = Collapsed;
                                token_found = true;
                        } else if (tmp_token == "open") {
@@ -149,44 +164,70 @@ Dimension InsetCollapsable::dimensionCollapsed() const
 {
        Dimension dim;
        theFontMetrics(layout_.labelfont).buttonText(
-               label, dim.wid, dim.asc, dim.des);
+               layout_.labelstring, dim.wid, dim.asc, dim.des);
        return dim;
 }
 
 
 bool InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
 {
+       using std::max;
+
        autoOpen_ = mi.base.bv->cursor().isInside(this);
-       mi.base.textwidth -= (int) (1.5 * TEXT_TO_INSET_OFFSET);
+       mi.base.textwidth -= int(1.5 * TEXT_TO_INSET_OFFSET);
 
-       if (status() == Inlined) {
+       switch (geometry()) {
+       case NoButton:
                InsetText::metrics(mi, dim);
-       } else {
+               break;
+       case Corners:
+               InsetText::metrics(mi, dim);
+               dim.des -= 3;
+               dim.asc -= 3;
+               break;
+       case SubLabel: {
+               InsetText::metrics(mi, dim);
+               // consider width of the inset label
+               Font font(layout_.labelfont);
+               font.realize(Font(Font::ALL_SANE));
+               font.decSize();
+               font.decSize();
+               int w = 0;
+               int a = 0;
+               int d = 0;
+               docstring s = layout_.labelstring;
+               theFontMetrics(font).rectText(s, w, a, d);
+               dim.wid = max(dim.wid, w);
+               dim.des += ascent();
+               break;
+               }
+       case TopButton:
+       case LeftButton:
+       case ButtonOnly:
                dim = dimensionCollapsed();
-               if (status() == Open) {
-                       InsetText::metrics(mi, textdim_);
-                       // This expression should not contain mi.base.texwidth
-                       openinlined_ = !hasFixedWidth()
-                               && textdim_.wid < 0.5 * mi.base.bv->workWidth();
+               if (geometry() == TopButton
+                || geometry() == LeftButton) {
+                       Dimension textdim;
+                       InsetText::metrics(mi, textdim);
+                       openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
                        if (openinlined_) {
-                               // Correct for button width, and re-fit
-                               mi.base.textwidth -= dim.wid;
-                               InsetText::metrics(mi, textdim_);
-                               dim.wid += textdim_.wid;
-                               dim.des = max(dim.des - textdim_.asc + dim.asc, textdim_.des);
-                               dim.asc = textdim_.asc;
+                               // Correct for button width.
+                               dim.wid += textdim.wid;
+                               dim.des = max(dim.des - textdim.asc + dim.asc, textdim.des);
+                               dim.asc = textdim.asc;
                        } else {
-                               dim.des += textdim_.height() + TEXT_TO_BOTTOM_OFFSET;
-                               dim.wid = max(dim.wid, textdim_.wid);
+                               dim.des += textdim.height() + TEXT_TO_BOTTOM_OFFSET;
+                               dim.wid = max(dim.wid, textdim.wid);
                                if (hasFixedWidth())
                                        dim.wid = max(dim.wid, mi.base.textwidth);
                        }
                }
+               break;
        }
        dim.asc += TEXT_TO_INSET_OFFSET;
        dim.des += TEXT_TO_INSET_OFFSET;
-       dim.wid += (int) (1.5 * TEXT_TO_INSET_OFFSET);
-       mi.base.textwidth += (int) (1.5 * TEXT_TO_INSET_OFFSET);
+       dim.wid += int(1.5 * TEXT_TO_INSET_OFFSET);
+       mi.base.textwidth += int(1.5 * TEXT_TO_INSET_OFFSET);
        bool const changed = dim_ != dim;
        dim_ = dim;
        return changed;
@@ -202,62 +243,168 @@ bool InsetCollapsable::setMouseHover(bool mouse_hover)
 
 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 {
-       const int xx = x + TEXT_TO_INSET_OFFSET;
-       if (status() == Inlined) {
-               InsetText::draw(pi, xx, y);
-       } else {
-               Dimension dimc = dimensionCollapsed();
-               int const top  = y - ascent() + TEXT_TO_INSET_OFFSET;
+       autoOpen_ = pi.base.bv->cursor().isInside(this);
+       int const old_color = pi.background_color;
+       pi.background_color = backgroundColor();
+       int const xx = x + TEXT_TO_INSET_OFFSET;
+
+       // Draw button first -- top, left or only
+       Dimension dimc = dimensionCollapsed();
+       int const top  = y - ascent() + TEXT_TO_INSET_OFFSET;
+       if (geometry() == TopButton ||
+           geometry() == LeftButton ||
+           geometry() == ButtonOnly) {
                button_dim.x1 = xx + 0;
                button_dim.x2 = xx + dimc.width();
                button_dim.y1 = top;
                button_dim.y2 = top + dimc.height();
 
-               pi.pain.buttonText(xx, top + dimc.asc, label, layout_.labelfont, mouse_hover_);
+               pi.pain.buttonText(xx, top + dimc.asc, layout_.labelstring, layout_.labelfont, mouse_hover_);
+       } else {
+               button_dim.x1 = 0;
+               button_dim.y1 = 0;
+               button_dim.x2 = 0;
+               button_dim.y2 = 0;
+       }
 
-               if (status() == Open) {
-                       int textx, texty;
-                       if (openinlined_) {
-                               textx = xx + dimc.width();
-                               texty = top + textdim_.asc;
-                       } else {
-                               textx = xx;
-                               texty = top + dimc.height() + textdim_.asc;
-                       }
-                       InsetText::draw(pi, textx, texty);
+       int textx, texty;
+       switch (geometry()) {
+       case LeftButton:
+               textx = xx + dimc.width();
+               texty = top;
+               InsetText::draw(pi, textx, texty);
+               break;
+       case TopButton:
+               textx = xx;
+               texty = top + dimc.height();
+               InsetText::draw(pi, textx, texty);
+               break;
+       case ButtonOnly:
+               break;
+       case NoButton:
+               textx = xx;
+               texty = y;
+               InsetText::draw(pi, textx, texty);
+               break;
+       case SubLabel:
+       case Corners:
+               textx = xx;
+               texty = y;
+               const_cast<InsetCollapsable *>(this)->setDrawFrame(false);
+               InsetText::draw(pi, textx, texty);
+               const_cast<InsetCollapsable *>(this)->setDrawFrame(true);
+
+               int desc = InsetText::descent();
+               if (geometry() == SubLabel)
+                       desc -= ascent();
+               else
+                       desc -= 3;
+
+               const int xx1 = xx + border_ - 1;
+               const int xx2 = x + dim_.wid - border_ 
+                       - TEXT_TO_INSET_OFFSET + 1;
+               pi.pain.line(xx1, y + desc - 4, 
+                            xx1, y + desc, 
+                       layout_.labelfont.color());
+               if (internalStatus() == Open)
+                       pi.pain.line(xx1, y + desc, 
+                               xx2, y + desc,
+                               layout_.labelfont.color());
+               else {
+                       // Make status_ value visible:
+                       pi.pain.line(xx1, y + desc,
+                               xx1 + 4, y + desc,
+                               layout_.labelfont.color());
+                       pi.pain.line(xx2 - 4, y + desc,
+                               xx2, y + desc,
+                               layout_.labelfont.color());
+               }
+               pi.pain.line(x + dim_.wid - 3, y + desc, x + dim_.wid - 3, y + desc - 4,
+                       layout_.labelfont.color());
+
+               // the label below the text. Can be toggled.
+               if (geometry() == SubLabel) {
+                       Font font(layout_.labelfont);
+                       font.realize(Font(Font::ALL_SANE));
+                       font.decSize();
+                       font.decSize();
+                       int w = 0;
+                       int a = 0;
+                       int d = 0;
+                       // FIXME UNICODE
+                       docstring s = layout_.labelstring;
+                       theFontMetrics(font).rectText(s, w, a, d);
+                       pi.pain.rectText(x + (dim_.wid - w) / 2, y + desc + a,
+                               s, font, Color::none, Color::none);
+               }
+
+               // a visual clue when the cursor is inside the inset
+               Cursor & cur = pi.base.bv->cursor();
+               if (cur.isInside(this)) {
+                       y -= ascent();
+                       y += 3;
+                       pi.pain.line(xx1, y + 4, xx1, y, layout_.labelfont.color());
+                       pi.pain.line(xx1 + 4, y, xx1, y, layout_.labelfont.color());
+                       pi.pain.line(xx2, y + 4, x + dim_.wid - 3, y,
+                               layout_.labelfont.color());
+                       pi.pain.line(xx2 - 4, y, xx2, y,
+                               layout_.labelfont.color());
                }
+               break;
        }
        setPosCache(pi, x, y);
+       pi.background_color = old_color;
 }
 
 
 void InsetCollapsable::drawSelection(PainterInfo & pi, int x, int y) const
 {
        x += TEXT_TO_INSET_OFFSET;
-       if (status() == Open) {
-               if (openinlined_)
-                       x += dimensionCollapsed().wid;
-               else
-                       y += dimensionCollapsed().des + textdim_.asc;
-       }
-       if (status() != Collapsed)
+       switch (geometry()) {
+       case LeftButton:
+               x += dimensionCollapsed().wid;
+               InsetText::drawSelection(pi, x, y);
+               break;
+       case TopButton:
+               y += dimensionCollapsed().des;
                InsetText::drawSelection(pi, x, y);
+               break;
+       case ButtonOnly:
+               break;
+       case NoButton:
+       case SubLabel:
+       case Corners:
+               InsetText::drawSelection(pi, x, y);
+               break;
+       }
 }
 
 
 void InsetCollapsable::cursorPos(BufferView const & bv,
                CursorSlice const & sl, bool boundary, int & x, int & y) const
 {
-       BOOST_ASSERT(status() != Collapsed);
+       BOOST_ASSERT(geometry() != ButtonOnly);
 
        InsetText::cursorPos(bv, sl, boundary, x, y);
 
-       if (status() == Open) {
-               if (openinlined_)
-                       x += dimensionCollapsed().wid;
-               else
-                       y += dimensionCollapsed().height() - ascent()
-                               + TEXT_TO_INSET_OFFSET + textdim_.asc;
+       switch (geometry()) {
+       case LeftButton:
+               x += dimensionCollapsed().wid;
+               break;
+       case TopButton: {
+               TextMetrics const & tm = bv.textMetrics(&text_);
+               y += dimensionCollapsed().height() - ascent()
+                       + TEXT_TO_INSET_OFFSET + tm.ascent();
+               break;
+       }
+       case NoButton:
+       case SubLabel:
+       case Corners:
+               // Do nothing
+               break;
+       case ButtonOnly:
+               // Cannot get here
+               break;
        }
        x += TEXT_TO_INSET_OFFSET;
 }
@@ -265,13 +412,13 @@ void InsetCollapsable::cursorPos(BufferView const & bv,
 
 Inset::EDITABLE InsetCollapsable::editable() const
 {
-       return status() != Collapsed ? HIGHLY_EDITABLE : IS_EDITABLE;
+       return geometry() != ButtonOnly? HIGHLY_EDITABLE : IS_EDITABLE;
 }
 
 
 bool InsetCollapsable::descendable() const
 {
-       return status() != Collapsed;
+       return geometry() != ButtonOnly;
 }
 
 
@@ -286,7 +433,7 @@ docstring const InsetCollapsable::getNewLabel(docstring const & l) const
        docstring label;
        pos_type const max_length = 15;
        pos_type const p_siz = paragraphs().begin()->size();
-       pos_type const n = min(max_length, p_siz);
+       pos_type const n = std::min(max_length, p_siz);
        pos_type i = 0;
        pos_type j = 0;
        for (; i < n && j < p_siz; ++j) {
@@ -313,7 +460,9 @@ void InsetCollapsable::edit(Cursor & cur, bool left)
 Inset * InsetCollapsable::editXY(Cursor & cur, int x, int y)
 {
        //lyxerr << "InsetCollapsable: edit xy" << endl;
-       if (status() == Collapsed || (button_dim.contains(x, y) && status() != Inlined))
+       if (geometry() == ButtonOnly
+        || (button_dim.contains(x, y) 
+         && geometry() != NoButton))
                return this;
        cur.push(*this);
        return InsetText::editXY(cur, x, y);
@@ -327,7 +476,9 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
 
        switch (cmd.action) {
        case LFUN_MOUSE_PRESS:
-               if (cmd.button() == mouse_button::button1 && hitButton(cmd) && status() != Inlined) {
+               if (cmd.button() == mouse_button::button1 
+                && hitButton(cmd) 
+                && geometry() != NoButton) {
                        // reset selection if necessary (see bug 3060)
                        if (cur.selection())
                                cur.bv().cursor().clearSelection();
@@ -336,9 +487,10 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
                        cur.dispatched();
                        break;
                }
-               if (status() == Inlined)
+               if (geometry() == NoButton)
                        InsetText::doDispatch(cur, cmd);
-               else if (status() == Open && !hitButton(cmd))
+               else if (geometry() != ButtonOnly 
+                    && !hitButton(cmd))
                        InsetText::doDispatch(cur, cmd);
                else
                        cur.undispatched();
@@ -347,9 +499,10 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
        case LFUN_MOUSE_MOTION:
        case LFUN_MOUSE_DOUBLE:
        case LFUN_MOUSE_TRIPLE:
-               if (status_ == Inlined)
+               if (geometry() == NoButton)
                        InsetText::doDispatch(cur, cmd);
-               else if (status() && !hitButton(cmd))
+               else if (geometry() != ButtonOnly
+                    && !hitButton(cmd))
                        InsetText::doDispatch(cur, cmd);
                else
                        cur.undispatched();
@@ -357,12 +510,24 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
 
        case LFUN_MOUSE_RELEASE:
                if (cmd.button() == mouse_button::button3) {
-                       // Open the Inset configuration dialog
-                       showInsetDialog(&cur.bv());
-                       break;
+                       // There is no button to right click:
+                       if (geometry() == Corners ||
+                           geometry() == SubLabel ||
+                           geometry() == NoButton)  {
+                               if (internalStatus() == Open)
+                                       setStatus(cur, Collapsed);
+                               else
+                                       setStatus(cur, Open);
+                               break;
+                       } else {
+                               // Open the Inset 
+                               // configuration dialog
+                               showInsetDialog(&cur.bv());
+                               break;
+                       }
                }
 
-               if (status() == Inlined) {
+               if (geometry() == NoButton) {
                        // The mouse click has to be within the inset!
                        InsetText::doDispatch(cur, cmd);
                        break;
@@ -377,7 +542,7 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
                        // toggle the inset visual state.
                        cur.dispatched();
                        cur.updateFlags(Update::Force | Update::FitCursor);
-                       if (status() == Collapsed) {
+                       if (geometry() == ButtonOnly) {
                                setStatus(cur, Open);
                                edit(cur, true);
                        }
@@ -389,7 +554,8 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
                }
 
                // The mouse click is within the opened inset.
-               if (status() == Open)
+               if (geometry() == TopButton
+                || geometry() == LeftButton)
                        InsetText::doDispatch(cur, cmd);
                break;
 
@@ -399,11 +565,11 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
                else if (cmd.argument() == "close")
                        setStatus(cur, Collapsed);
                else if (cmd.argument() == "toggle" || cmd.argument().empty())
-                       if (isOpen()) {
+                       if (internalStatus() == Open) {
                                setStatus(cur, Collapsed);
-                               cur.forwardPosNoDescend();
-                       }
-                       else
+                               if (geometry() == ButtonOnly)
+                                       cur.top().forwardPos();
+                       else
                                setStatus(cur, Open);
                else // if assign or anything else
                        cur.undispatched();
@@ -438,7 +604,7 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
 
 void InsetCollapsable::setLabel(docstring const & l)
 {
-       label = l;
+       layout_.labelstring = l;
 }
 
 
@@ -448,10 +614,6 @@ void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
        setButtonLabel();
        if (status_ == Collapsed)
                cur.leaveInset(*this);
-       // Because the collapse status is part of the inset and thus an
-       // integral part of the Buffer contents a changed status must be
-       // signaled to all views of current buffer.
-       cur.bv().buffer()->changed();
 }
 
 
@@ -469,4 +631,58 @@ docstring InsetCollapsable::floatName(string const & type, BufferParams const &
 }
 
 
+InsetCollapsable::Decoration InsetCollapsable::decoration() const
+{
+       if (layout_.decoration == "classic")
+               return Classic;
+       if (layout_.decoration == "minimalistic")
+               return Minimalistic;
+       if (layout_.decoration == "conglomerate")
+               return Conglomerate;
+       if (name() == from_ascii("CharStyle"))
+               return Conglomerate;
+       return Classic;
+}
+
+
+int InsetCollapsable::latex(Buffer const & buf, odocstream & os,
+                         OutputParams const & runparams) const
+{
+       // This implements the standard way of handling the LaTeX output of
+       // a collapsable inset, either a command or an environment. Standard 
+       // collapsable insets should not redefine this, non-standard ones may
+       // call this.
+       if (!layout_.latexname.empty()) {
+               if (layout_.latextype == "command") {
+                       // FIXME UNICODE
+                       os << '\\' << from_utf8(layout_.latexname);
+                       if (!layout_.latexparam.empty())
+                               os << from_utf8(layout_.latexparam);
+                       os << '{';
+               } else if (layout_.latextype == "environment") {
+                       os << "%\n\\begin{" << from_utf8(layout_.latexname) << "}\n";
+                       if (!layout_.latexparam.empty())
+                               os << from_utf8(layout_.latexparam);
+               }
+       }
+       int i = InsetText::latex(buf, os, runparams);
+       if (!layout_.latexname.empty())
+               if (layout_.latextype == "command") {
+                       os << "}";
+               } else if (layout_.latextype == "environment") {
+                       os << "\n\\end{" << from_utf8(layout_.latexname) << "}\n";
+                       i += 4;
+               }
+       return i;
+}
+
+
+void InsetCollapsable::validate(LaTeXFeatures & features) const
+{
+       // Force inclusion of preamble snippet in layout file
+       features.addPreambleSnippet(layout_.preamble);
+       InsetText::validate(features);
+}
+
+
 } // namespace lyx