]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCollapsable.cpp
Revert r27129. We can't get rid of these until we have something else positive to do.
[lyx.git] / src / insets / InsetCollapsable.cpp
index e2b7f8a9f705165370cd80a060a3456396fa627c..84eb4e319b21c822e8e90adf5226743953f51774 100644 (file)
 #include "Dimension.h"
 #include "DispatchResult.h"
 #include "FloatList.h"
+#include "FuncRequest.h"
 #include "FuncStatus.h"
 #include "InsetLayout.h"
 #include "Language.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
-#include "FuncRequest.h"
 #include "MetricsInfo.h"
 #include "ParagraphParameters.h"
 #include "TextClass.h"
 #include "support/debug.h"
 #include "support/docstream.h"
 #include "support/gettext.h"
+#include "support/lassert.h"
 
 using namespace std;
 
-namespace lyx {
 
+namespace lyx {
 
 InsetCollapsable::CollapseStatus InsetCollapsable::status() const
 {
-       if (decoration() == InsetLayout::Conglomerate)
+       if (decoration() == InsetLayout::CONGLOMERATE)
                return status_;
        return autoOpen_ ? Open : status_;
 }
@@ -54,18 +55,18 @@ InsetCollapsable::CollapseStatus InsetCollapsable::status() const
 InsetCollapsable::Geometry InsetCollapsable::geometry() const
 {
        switch (decoration()) {
-       case InsetLayout::Classic:
+       case InsetLayout::CLASSIC:
                if (status() == Open)
                        return openinlined_ ? LeftButton : TopButton;
                return ButtonOnly;
 
-       case InsetLayout::Minimalistic:
+       case InsetLayout::MINIMALISTIC:
                return status() == Open ? NoButton : ButtonOnly ;
 
-       case InsetLayout::Conglomerate:
+       case InsetLayout::CONGLOMERATE:
                return status() == Open ? SubLabel : Corners ;
 
-       case InsetLayout::Default:
+       case InsetLayout::DEFAULT:
                break; // this shouldn't happen
        }
 
@@ -75,16 +76,16 @@ InsetCollapsable::Geometry InsetCollapsable::geometry() const
 }
 
 
-InsetCollapsable::InsetCollapsable(Buffer const & buf,
-               CollapseStatus status, DocumentClass * dc)
-       : InsetText(buf), status_(status),
+InsetCollapsable::InsetCollapsable(Buffer const & buf)
+       : InsetText(buf), status_(Inset::Open),
          openinlined_(false), autoOpen_(false), mouse_hover_(false)
 {
-       setLayout(dc);
+       DocumentClass const & dc = buf.params().documentClass();
+       setLayout(&dc);
        setAutoBreakRows(true);
        setDrawFrame(true);
        setFrameColor(Color_collapsableframe);
-       paragraphs().back().setLayout(buf.params().documentClass().emptyLayout());
+       paragraphs().back().setLayout(dc.plainLayout()); 
 }
 
 
@@ -106,17 +107,18 @@ docstring InsetCollapsable::toolTip(BufferView const & bv, int x, int y) const
 {
        Dimension dim = dimensionCollapsed();
        if (geometry() == NoButton)
-               return layout_->labelstring();
-       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 || isOpen())
                return docstring();
 
-       switch (status_) {
-       case Open:
-               return _("Left-click to collapse the inset");
-       case Collapsed:
-               return _("Left-click to open the inset");
-       }
-       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) + "...";
+       return content_tip;
 }
 
 
@@ -130,9 +132,9 @@ void InsetCollapsable::setLayout(DocumentClass const * const dc)
 {
        if (dc) {
                layout_ = &(dc->insetLayout(name()));
-               labelstring_ = layout_->labelstring();
+               labelstring_ = translateIfPossible(layout_->labelstring());
        } else {
-               layout_ = &DocumentClass::emptyInsetLayout();
+               layout_ = &DocumentClass::plainInsetLayout();
                labelstring_ = _("UNDEFINED");
        }
 
@@ -152,45 +154,25 @@ void InsetCollapsable::write(ostream & os) const
                break;
        }
        os << "\n";
-       text_.write(buffer(), os);
+       text().write(buffer(), os);
 }
 
 
 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);
-               }
-       }
+       lex.setContext("InsetCollapsable::read");
+       string tmp_token;
+       status_ = Collapsed;
+       lex >> "status" >> tmp_token;
+       if (tmp_token == "open")
+               status_ = Open;
+
        // this must be set before we enter InsetText::read()
        setLayout(buffer().params());
-
        InsetText::read(lex);
-
-       if (!token_found)
-               status_ = isOpen() ? Open : Collapsed;
+       // 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
@@ -205,7 +187,7 @@ void InsetCollapsable::read(Lexer & lex)
 
 Dimension InsetCollapsable::dimensionCollapsed() const
 {
-       BOOST_ASSERT(layout_);
+       LASSERT(layout_, /**/);
        Dimension dim;
        theFontMetrics(layout_->labelfont()).buttonText(
                labelstring_, dim.wid, dim.asc, dim.des);
@@ -215,7 +197,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);
 
@@ -280,11 +262,9 @@ 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;
-       pi.background_color = backgroundColor();
 
        FontInfo tmpfont = pi.base.font;
        pi.base.font = layout_->font();
@@ -394,7 +374,6 @@ void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
                }
                break;
        }
-       pi.background_color = old_color;
 
        pi.base.font = tmpfont;
 }
@@ -405,7 +384,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);
@@ -432,7 +411,7 @@ void InsetCollapsable::cursorPos(BufferView const & bv,
 
 Inset::EDITABLE InsetCollapsable::editable() const
 {
-       return geometry() != ButtonOnly? HIGHLY_EDITABLE : IS_EDITABLE;
+       return geometry() != ButtonOnly ? HIGHLY_EDITABLE : IS_EDITABLE;
 }
 
 
@@ -469,8 +448,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);
@@ -497,25 +475,23 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
 
        switch (cmd.action) {
        case LFUN_MOUSE_PRESS:
-               if (hitButton(cmd) && geometry() != NoButton) {
+               if (hitButton(cmd)) {
                        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::button2:
                        case mouse_button::button3:
-                               // Nothing to do.
+                               // Pass the command to the enclosing InsetText,
+                               // so that the cursor gets set.
                                cur.undispatched();
-                               return;
+                               break;
+                       case mouse_button::none:
+                       case mouse_button::button2:
+                       case mouse_button::button4:
+                       case mouse_button::button5:
+                               // Nothing to do.
+                               cur.noUpdate();
+                               break;
                        }
-               }
-               if (geometry() == NoButton 
-                       || (geometry() != ButtonOnly && !hitButton(cmd)))
+               } else if (geometry() != ButtonOnly)
                        InsetText::doDispatch(cur, cmd);
                else
                        cur.undispatched();
@@ -524,23 +500,26 @@ void InsetCollapsable::doDispatch(Cursor & cur, FuncRequest & cmd)
        case LFUN_MOUSE_MOTION:
        case LFUN_MOUSE_DOUBLE:
        case LFUN_MOUSE_TRIPLE:
-               if (geometry() == NoButton)
-                       InsetText::doDispatch(cur, cmd);
-               else if (geometry() != ButtonOnly
-                    && !hitButton(cmd))
+               if (hitButton(cmd)) 
+                       cur.noUpdate();
+               else if (geometry() != ButtonOnly)
                        InsetText::doDispatch(cur, cmd);
                else
                        cur.undispatched();
                break;
 
        case LFUN_MOUSE_RELEASE:
-               if (geometry() == NoButton || !hitButton(cmd)) {
+               if (!hitButton(cmd)) {
                        // The mouse click has to be within the inset!
-                       InsetText::doDispatch(cur, cmd);
+                       if (geometry() != ButtonOnly)
+                               InsetText::doDispatch(cur, cmd);
+                       else
+                               cur.undispatched();                     
                        break;
                }
                if (cmd.button() != mouse_button::button1) {
-                       cur.dispatched();
+                       // Nothing to do.
+                       cur.noUpdate();
                        break;
                }
                // if we are selecting, we do not want to
@@ -634,7 +613,10 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
                FuncStatus & flag) const
 {
        switch (cmd.action) {
-       // suppress these
+       // FIXME At present, these are being enabled and disabled according to
+       // whether PASSTHRU has been set in the InsetLayout. This makes some
+       // sense, but there are other checks that should really be done. E.g.,
+       // one should not be able to inset IndexPrint inside an optional argument!!
        case LFUN_ACCENT_ACUTE:
        case LFUN_ACCENT_BREVE:
        case LFUN_ACCENT_CARON:
@@ -646,33 +628,31 @@ 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:
        case LFUN_ACCENT_UNDERBAR:
        case LFUN_ACCENT_UNDERDOT:
        case LFUN_APPENDIX:
-       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_DEPTH_DECREMENT:
        case LFUN_DEPTH_INCREMENT:
-       case LFUN_ENVIRONMENT_INSERT:
        case LFUN_ERT_INSERT:
        case LFUN_FILE_INSERT:
        case LFUN_FLEX_INSERT:
        case LFUN_FLOAT_INSERT:
-       case LFUN_FLOAT_LIST:
+       case LFUN_FLOAT_LIST_INSERT:
        case LFUN_FLOAT_WIDE_INSERT:
        case LFUN_FONT_BOLD:
+       case LFUN_FONT_BOLDSYMBOL:
        case LFUN_FONT_TYPEWRITER:
        case LFUN_FONT_DEFAULT:
        case LFUN_FONT_EMPH:
-       case LFUN_FONT_FREE_APPLY:
-       case LFUN_FONT_FREE_UPDATE:
+       case LFUN_TEXTSTYLE_APPLY:
+       case LFUN_TEXTSTYLE_UPDATE:
        case LFUN_FONT_NOUN:
        case LFUN_FONT_ROMAN:
        case LFUN_FONT_SANS:
@@ -690,8 +670,6 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
        case LFUN_LABEL_INSERT:
        case LFUN_LINE_INSERT:
        case LFUN_NEWPAGE_INSERT:
-       case LFUN_LAYOUT:
-       case LFUN_LAYOUT_PARAGRAPH:
        case LFUN_LAYOUT_TABULAR:
        case LFUN_MARGINALNOTE_INSERT:
        case LFUN_MATH_DISPLAY:
@@ -705,10 +683,6 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
        case LFUN_NOTE_INSERT:
        case LFUN_NOTE_NEXT:
        case LFUN_OPTIONAL_INSERT:
-       case LFUN_PARAGRAPH_PARAMS:
-       case LFUN_PARAGRAPH_PARAMS_APPLY:
-       case LFUN_PARAGRAPH_SPACING:
-       case LFUN_PARAGRAPH_UPDATE:
        case LFUN_REFERENCE_NEXT:
        case LFUN_SERVER_GOTO_FILE_ROW:
        case LFUN_SERVER_NOTIFY:
@@ -719,27 +693,29 @@ bool InsetCollapsable::getStatus(Cursor & cur, FuncRequest const & cmd,
        case LFUN_TOC_INSERT:
        case LFUN_WRAP_INSERT:
                if (layout_->isPassThru()) {
-                       flag.enabled(false);
+                       flag.setEnabled(false);
                        return true;
-               } else
-                       return InsetText::getStatus(cur, cmd, flag);
+               }
+               return InsetText::getStatus(cur, cmd, flag);
 
        case LFUN_INSET_TOGGLE:
-               if ((cmd.argument() == "open" && status_ != Open)
-                     || (cmd.argument() == "close" && status_ == Open)
-                     || cmd.argument() == "toggle" || cmd.argument().empty())
-                               flag.enabled(true);
-               else
-                       flag.enabled(false);
+               if (cmd.argument() == "open")
+                       flag.setEnabled(status_ != Open);
+               else if (cmd.argument() == "close")
+                       flag.setEnabled(status_ == Open);
+               else if (cmd.argument() == "toggle" || cmd.argument().empty()) {
+                       flag.setEnabled(true);
+                       flag.setOnOff(status_ == Open);
+               } else
+                       flag.setEnabled(false);
                return true;
 
        case LFUN_LANGUAGE:
-               flag.enabled(!layout_->isForceLtr());
+               flag.setEnabled(!layout_->isForceLtr());
                return InsetText::getStatus(cur, cmd, flag);
 
        case LFUN_BREAK_PARAGRAPH:
-       case LFUN_BREAK_PARAGRAPH_SKIP:
-               flag.enabled(layout_->isMultiPar());
+               flag.setEnabled(layout_->isMultiPar());
                return true;
 
        default:
@@ -758,8 +734,10 @@ void InsetCollapsable::setStatus(Cursor & cur, CollapseStatus status)
 {
        status_ = status;
        setButtonLabel();
-       if (status_ == Collapsed)
+       if (status_ == Collapsed) {
                cur.leaveInset(*this);
+               mouse_hover_ = false;
+       }
 }
 
 
@@ -776,19 +754,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;
 }
 
 
@@ -806,7 +784,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";
@@ -814,7 +792,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());
@@ -827,9 +805,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;
                }
@@ -840,11 +818,10 @@ int InsetCollapsable::latex(odocstream & os,
 
 void InsetCollapsable::validate(LaTeXFeatures & features) const
 {
-       if (!layout_)
-               return;
-
-       // Force inclusion of preamble snippet in layout file
-       features.require(to_utf8(layout_->name()));
+       string const preamble = getLayout().preamble();
+       if (!preamble.empty())
+               features.addPreambleSnippet(preamble);
+       features.require(getLayout().requires());
        InsetText::validate(features);
 }
 
@@ -852,14 +829,14 @@ void InsetCollapsable::validate(LaTeXFeatures & features) const
 bool InsetCollapsable::undefined() const
 {
        docstring const & n = getLayout().name();
-       return n.empty() || n == DocumentClass::emptyInsetLayout().name();
+       return n.empty() || n == DocumentClass::plainInsetLayout().name();
 }
 
 
 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)