]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCollapsable.cpp
Inset::addToToc(): change signature. Use DocIterator instead of ParConstIterator...
[lyx.git] / src / insets / InsetCollapsable.cpp
index 4dc2f96d14951b9bdbc32535d7f62d3fe9d262d5..c255d24709b367f42d91db9bcd62cfe43fc6e094 100644 (file)
 #include "frontends/FontMetrics.h"
 #include "frontends/Painter.h"
 
+#include "support/lassert.h"
 #include "support/debug.h"
 #include "support/docstream.h"
 #include "support/gettext.h"
 
 using namespace std;
 
-namespace lyx {
 
+namespace lyx {
 
 InsetCollapsable::CollapseStatus InsetCollapsable::status() const
 {
+       if (decoration() == InsetLayout::Conglomerate)
+               return status_;
        return autoOpen_ ? Open : status_;
 }
 
@@ -53,13 +56,9 @@ InsetCollapsable::Geometry InsetCollapsable::geometry() const
 {
        switch (decoration()) {
        case InsetLayout::Classic:
-               if (status() == Open) {
-                       if (openinlined_)
-                               return LeftButton;
-                       else
-                               return TopButton;
-               } else
-                       return ButtonOnly;
+               if (status() == Open)
+                       return openinlined_ ? LeftButton : TopButton;
+               return ButtonOnly;
 
        case InsetLayout::Minimalistic:
                return status() == Open ? NoButton : ButtonOnly ;
@@ -77,22 +76,22 @@ InsetCollapsable::Geometry InsetCollapsable::geometry() const
 }
 
 
-InsetCollapsable::InsetCollapsable(BufferParams const & bp,
-               CollapseStatus status, TextClassPtr tc)
-       : InsetText(bp), status_(status),
+InsetCollapsable::InsetCollapsable(Buffer const & buf,
+               CollapseStatus status)
+       : InsetText(buf), status_(status),
          openinlined_(false), autoOpen_(false), mouse_hover_(false)
 {
-       setLayout(tc);
+       DocumentClass const & dc = buf.params().documentClass();
+       setLayout(&dc);
        setAutoBreakRows(true);
        setDrawFrame(true);
        setFrameColor(Color_collapsableframe);
-       paragraphs().back().setLayout(bp.getTextClass().emptyLayout());
+       paragraphs().back().setLayout(dc.emptyLayout());
 }
 
 
 InsetCollapsable::InsetCollapsable(InsetCollapsable const & rhs)
        : InsetText(rhs),
-               textClass_(rhs.textClass_),
                layout_(rhs.layout_),
                labelstring_(rhs.labelstring_),
                button_dim(rhs.button_dim),
@@ -109,34 +108,46 @@ docstring InsetCollapsable::toolTip(BufferView const & bv, int x, int y) const
 {
        Dimension dim = dimensionCollapsed();
        if (geometry() == NoButton)
-               return layout_->labelstring();
-       else if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des)
+               return translateIfPossible(layout_->labelstring());
+       if (x > xo(bv) + dim.wid || y > yo(bv) + dim.des)
                return docstring();
 
+       docstring default_tip;
        switch (status_) {
        case Open:
-               return _("Left-click to collapse the inset");
+               default_tip = _("Left-click to collapse the inset");
+               break;
        case Collapsed:
-               return _("Left-click to open the inset");
+               default_tip = _("Left-click to open the inset");
+               break;
        }
-       return docstring();
+
+       OutputParams rp(&buffer().params().encoding());
+       odocstringstream ods;
+       InsetText::plaintext(ods, rp);
+       docstring content_tip = ods.str();
+       // shorten it if necessary
+       if (content_tip.size() > 200)
+               content_tip = content_tip.substr(0, 200) + "...";
+       if (!isOpen() && !content_tip.empty())
+               return content_tip + '\n' + default_tip;
+       return default_tip;
 }
 
 
 void InsetCollapsable::setLayout(BufferParams const & bp)
 {
-       setLayout(bp.getTextClassPtr());
+       setLayout(bp.documentClassPtr());
 }
 
 
-void InsetCollapsable::setLayout(TextClassPtr tc)
+void InsetCollapsable::setLayout(DocumentClass const * const dc)
 {
-       textClass_ = tc;
-       if ( tc.get() != 0 ) {
-               layout_ = &tc->insetLayout(name());
-               labelstring_ = layout_->labelstring();
+       if (dc) {
+               layout_ = &(dc->insetLayout(name()));
+               labelstring_ = translateIfPossible(layout_->labelstring());
        } else {
-               layout_ = &TextClass::emptyInsetLayout();
+               layout_ = &DocumentClass::emptyInsetLayout();
                labelstring_ = _("UNDEFINED");
        }
 
@@ -144,7 +155,7 @@ void InsetCollapsable::setLayout(TextClassPtr tc)
 }
 
 
-void InsetCollapsable::write(Buffer const & buf, ostream & os) const
+void InsetCollapsable::write(ostream & os) const
 {
        os << "status ";
        switch (status_) {
@@ -156,45 +167,23 @@ void InsetCollapsable::write(Buffer const & buf, ostream & os) const
                break;
        }
        os << "\n";
-       text_.write(buf, os);
+       text_.write(buffer(), os);
 }
 
 
-void InsetCollapsable::read(Buffer const & buf, Lexer & lex)
+void InsetCollapsable::read(Lexer & lex)
 {
-       bool token_found = false;
-       if (lex.isOK()) {
-               lex.next();
-               string const token = lex.getString();
-               if (token == "status") {
-                       lex.next();
-                       string const tmp_token = lex.getString();
-
-                       if (tmp_token == "collapsed") {
-                               status_ = Collapsed;
-                               token_found = true;
-                       } else if (tmp_token == "open") {
-                               status_ = Open;
-                               token_found = true;
-                       } else {
-                               lyxerr << "InsetCollapsable::read: Missing status!"
-                                      << endl;
-                               // Take countermeasures
-                               lex.pushToken(token);
-                       }
-               } else {
-                       LYXERR0("InsetCollapsable::read: Missing 'status'-tag!");
-                       // take countermeasures
-                       lex.pushToken(token);
-               }
-       }
-       //this must be set before we enter InsetText::read()
-       setLayout(buf.params());
+       lex.setContext("InsetCollapsable::read");
+       string tmp_token;
+       status_ = Collapsed;
+       lex >> "status" >> tmp_token;
+       if (tmp_token == "open")
+               status_ = Open;
 
-       InsetText::read(buf, lex);
+       // this must be set before we enter InsetText::read()
+       setLayout(buffer().params());
 
-       if (!token_found)
-               status_ = isOpen() ? Open : Collapsed;
+       InsetText::read(lex);
 
        // Force default font, if so requested
        // This avoids paragraphs in buffer language that would have a
@@ -209,7 +198,7 @@ void InsetCollapsable::read(Buffer const & buf, Lexer & lex)
 
 Dimension InsetCollapsable::dimensionCollapsed() const
 {
-       BOOST_ASSERT(layout_);
+       LASSERT(layout_, /**/);
        Dimension dim;
        theFontMetrics(layout_->labelfont()).buttonText(
                labelstring_, dim.wid, dim.asc, dim.des);
@@ -219,7 +208,7 @@ Dimension InsetCollapsable::dimensionCollapsed() const
 
 void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
 {
-       BOOST_ASSERT(layout_);
+       LASSERT(layout_, /**/);
 
        autoOpen_ = mi.base.bv->cursor().isInside(this);
 
@@ -254,8 +243,7 @@ void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
        case LeftButton:
        case ButtonOnly:
                dim = dimensionCollapsed();
-               if (geometry() == TopButton
-                || geometry() == LeftButton) {
+               if (geometry() == TopButton || geometry() == LeftButton) {
                        Dimension textdim;
                        InsetText::metrics(mi, textdim);
                        openinlined_ = (textdim.wid + dim.wid) < mi.base.textwidth;
@@ -285,7 +273,7 @@ bool InsetCollapsable::setMouseHover(bool mouse_hover)
 
 void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 {
-       BOOST_ASSERT(layout_);
+       LASSERT(layout_, /**/);
 
        autoOpen_ = pi.base.bv->cursor().isInside(this);
        ColorCode const old_color = pi.background_color;
@@ -410,7 +398,7 @@ void InsetCollapsable::cursorPos(BufferView const & bv,
 {
        if (geometry() == ButtonOnly)
                status_ = Open;
-       BOOST_ASSERT(geometry() != ButtonOnly);
+       LASSERT(geometry() != ButtonOnly, /**/);
 
        InsetText::cursorPos(bv, sl, boundary, x, y);
        Dimension const textdim = InsetText::dimension(bv);
@@ -474,8 +462,7 @@ docstring const InsetCollapsable::getNewLabel(docstring const & l) const
 }
 
 
-void InsetCollapsable::edit(
-               Cursor & cur, bool front, EntryDirection entry_from)
+void InsetCollapsable::edit(Cursor & cur, bool front, EntryDirection entry_from)
 {
        //lyxerr << "InsetCollapsable: edit left/right" << endl;
        cur.push(*this);
@@ -502,21 +489,28 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
 
        switch (cmd.action) {
        case LFUN_MOUSE_PRESS:
-               if (cmd.button() == mouse_button::button1 
-                && hitButton(cmd) 
-                && geometry() != NoButton) {
-                       // reset selection if necessary (see bug 3060)
-                       if (cur.selection())
-                               cur.bv().cursor().clearSelection();
-                       else
-                               cur.noUpdate();
-                       cur.dispatched();
-                       break;
+               if (hitButton(cmd) && geometry() != NoButton) {
+                       switch (cmd.button()) {
+                       case mouse_button::button1:
+                               // reset selection if necessary (see bug 3060)
+                               if (cur.selection())
+                                       cur.bv().cursor().clearSelection();
+                               else
+                                       cur.noUpdate();
+                               cur.dispatched();
+                               return;
+                       case mouse_button::none:
+                       case mouse_button::button2:
+                       case mouse_button::button3:
+                       case mouse_button::button4:
+                       case mouse_button::button5:
+                               // Nothing to do.
+                               cur.undispatched();
+                               return;
+                       }
                }
-               if (geometry() == NoButton)
-                       InsetText::doDispatch(cur, cmd);
-               else if (geometry() != ButtonOnly 
-                    && !hitButton(cmd))
+               if (geometry() == NoButton 
+                       || (geometry() != ButtonOnly && !hitButton(cmd)))
                        InsetText::doDispatch(cur, cmd);
                else
                        cur.undispatched();
@@ -535,56 +529,30 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
                break;
 
        case LFUN_MOUSE_RELEASE:
-               if (cmd.button() == mouse_button::button3) {
-                       // There is no button to right click:
-                       if (decoration() == InsetLayout::Minimalistic ||
-                           geometry() == Corners ||
-                           geometry() == SubLabel ||
-                           geometry() == NoButton
-                          )  {
-                               if (status_ == Open)
-                                       setStatus(cur, Collapsed);
-                               else
-                                       setStatus(cur, Open);
-                               break;
-                       } else {
-                               // Open the Inset 
-                               // configuration dialog
-                               showInsetDialog(&cur.bv());
-                               break;
-                       }
-               }
-
-               if (geometry() == NoButton) {
+               if (geometry() == NoButton || !hitButton(cmd)) {
                        // The mouse click has to be within the inset!
                        InsetText::doDispatch(cur, cmd);
                        break;
                }
-
-               if (cmd.button() == mouse_button::button1 && hitButton(cmd)) {
-                       // if we are selecting, we do not want to
-                       // toggle the inset.
-                       if (cur.selection())
-                               break;
-                       // Left button is clicked, the user asks to
-                       // toggle the inset visual state.
+               if (cmd.button() != mouse_button::button1) {
                        cur.dispatched();
-                       cur.updateFlags(Update::Force | Update::FitCursor);
-                       if (geometry() == ButtonOnly) {
-                               setStatus(cur, Open);
-                               edit(cur, true);
-                       }
-                       else {
-                               setStatus(cur, Collapsed);
-                       }
-                       cur.bv().cursor() = cur;
                        break;
                }
-
-               // The mouse click is within the opened inset.
-               if (geometry() == TopButton
-                || geometry() == LeftButton)
-                       InsetText::doDispatch(cur, cmd);
+               // if we are selecting, we do not want to
+               // toggle the inset.
+               if (cur.selection())
+                       break;
+               // Left button is clicked, the user asks to
+               // toggle the inset visual state.
+               cur.dispatched();
+               cur.updateFlags(Update::Force | Update::FitCursor);
+               if (geometry() == ButtonOnly) {
+                       setStatus(cur, Open);
+                       edit(cur, true);
+               }
+               else
+                       setStatus(cur, Collapsed);
+               cur.bv().cursor() = cur;
                break;
 
        case LFUN_INSET_TOGGLE:
@@ -673,7 +641,6 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
        case LFUN_ACCENT_HUNGARIAN_UMLAUT:
        case LFUN_ACCENT_MACRON:
        case LFUN_ACCENT_OGONEK:
-       case LFUN_ACCENT_SPECIAL_CARON:
        case LFUN_ACCENT_TIE:
        case LFUN_ACCENT_TILDE:
        case LFUN_ACCENT_UMLAUT:
@@ -683,10 +650,8 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
        case LFUN_BIBITEM_INSERT:
        case LFUN_BOX_INSERT:
        case LFUN_BRANCH_INSERT:
-       case LFUN_NEW_LINE:
+       case LFUN_NEWLINE_INSERT:
        case LFUN_CAPTION_INSERT:
-       case LFUN_CLEARPAGE_INSERT:
-       case LFUN_CLEARDOUBLEPAGE_INSERT:
        case LFUN_DEPTH_DECREMENT:
        case LFUN_DEPTH_INCREMENT:
        case LFUN_ENVIRONMENT_INSERT:
@@ -711,7 +676,6 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
        case LFUN_FONT_STATE:
        case LFUN_FONT_UNDERLINE:
        case LFUN_FOOTNOTE_INSERT:
-       case LFUN_HFILL_INSERT:
        case LFUN_HYPERLINK_INSERT:
        case LFUN_INDEX_INSERT:
        case LFUN_INDEX_PRINT:
@@ -720,7 +684,6 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
        case LFUN_LABEL_INSERT:
        case LFUN_LINE_INSERT:
        case LFUN_NEWPAGE_INSERT:
-       case LFUN_PAGEBREAK_INSERT:
        case LFUN_LAYOUT:
        case LFUN_LAYOUT_PARAGRAPH:
        case LFUN_LAYOUT_TABULAR:
@@ -749,17 +712,21 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
        case LFUN_TABULAR_INSERT:
        case LFUN_TOC_INSERT:
        case LFUN_WRAP_INSERT:
-       if (layout_->isPassThru()) {
-               flag.enabled(false);
-               return true;
-       } else
+               if (layout_->isPassThru()) {
+                       flag.enabled(false);
+                       return true;
+               }
                return InsetText::getStatus(cur, cmd, flag);
 
        case LFUN_INSET_TOGGLE:
-               if (cmd.argument() == "open" || cmd.argument() == "close" ||
-                   cmd.argument() == "toggle")
+               if (cmd.argument() == "open")
+                       flag.enabled(status_ != Open);
+               else if (cmd.argument() == "close")
+                       flag.enabled(status_ == Open);
+               else if (cmd.argument() == "toggle" || cmd.argument().empty()) {
                        flag.enabled(true);
-               else
+                       flag.setOnOff(status_ == Open);
+               } else
                        flag.enabled(false);
                return true;
 
@@ -788,15 +755,17 @@ void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
 {
        status_ = status;
        setButtonLabel();
-       if (status_ == Collapsed)
+       if (status_ == Collapsed) {
                cur.leaveInset(*this);
+               mouse_hover_ = false;
+       }
 }
 
 
 docstring InsetCollapsable::floatName(
                string const & type, BufferParams const & bp) const
 {
-       FloatList const & floats = bp.getTextClass().floats();
+       FloatList const & floats = bp.documentClass().floats();
        FloatList::const_iterator it = floats[type];
        // FIXME UNICODE
        return (it == floats.end()) ? from_ascii(type) : bp.B_(it->second.name());
@@ -817,29 +786,12 @@ InsetLayout::InsetDecoration InsetCollapsable::decoration() const
                break;
        }
        if (lyxCode() == FLEX_CODE)
-               // FIXME: Is this really necessary?
                return InsetLayout::Conglomerate;
        return InsetLayout::Classic;
 }
 
 
-bool InsetCollapsable::isMacroScope(Buffer const &) const
-{
-       // layout_ == 0 leads to no latex output, so ignore 
-       // the macros outside
-       if (!layout_)
-               return true;
-
-       // see InsetCollapsable::latex(...) below. In these case
-       // an environment is opened there
-       if (!layout_->latexname().empty())
-               return true;
-
-       return false;
-}
-
-
-int InsetCollapsable::latex(Buffer const & buf, odocstream & os,
+int InsetCollapsable::latex(odocstream & os,
                          OutputParams const & runparams) const
 {
        // FIXME: What should we do layout_ is 0?
@@ -872,7 +824,7 @@ int InsetCollapsable::latex(Buffer const & buf, odocstream & os,
                rp.verbatim = true;
        if (layout_->isNeedProtect())
                rp.moving_arg = true;
-       int i = InsetText::latex(buf, os, rp);
+       int i = InsetText::latex(os, rp);
        if (!layout_->latexname().empty()) {
                if (layout_->latextype() == "command") {
                        os << "}";
@@ -899,8 +851,24 @@ void InsetCollapsable::validate(LaTeXFeatures & features) const
 bool InsetCollapsable::undefined() const
 {
        docstring const & n = getLayout().name();
-       return n.empty() || n == TextClass::emptyInsetLayout().name();
+       return n.empty() || n == DocumentClass::emptyInsetLayout().name();
 }
 
 
+docstring InsetCollapsable::contextMenu(BufferView const & bv, int x,
+       int y) const
+{
+       if (decoration() == InsetLayout::Conglomerate)
+               return from_ascii("context-conglomerate");
+
+       if (geometry() == NoButton)
+               return from_ascii("context-collapsable");
+
+       Dimension dim = dimensionCollapsed();
+       if (x < xo(bv) + dim.wid && y < yo(bv) + dim.des)
+               return from_ascii("context-collapsable");
+
+       return InsetText::contextMenu(bv, x, y);
+}
+
 } // namespace lyx