]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetcollapsable.C
Clean up InsetGraphics::Cache and rename as GraphicsInset.
[lyx.git] / src / insets / insetcollapsable.C
index b66e5e5e447cbffa910847631dcf8c089b0ac753..facf2f5f362fd3f6cfcfd26aa19105deab1eaa21 100644 (file)
@@ -1,33 +1,38 @@
-/* This file is part of
- * ======================================================
+/**
+ * \file insetcollapsable.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
+ * \author Alejandro Aguilar Sierra
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
  *
- *          Copyright 1998-2001 The LyX Team.
- *
- * ======================================================
+ * Full author contact details are available in file CREDITS
  */
 
 #include <config.h>
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
 #include "insetcollapsable.h"
-#include "gettext.h"
-#include "lyxfont.h"
+#include "insettext.h"
+
 #include "BufferView.h"
-#include "frontends/Painter.h"
 #include "debug.h"
-#include "lyxtext.h"
-#include "frontends/font_metrics.h"
+#include "dimension.h"
+#include "gettext.h"
+#include "lyxfont.h"
 #include "lyxlex.h"
+#include "lyxtext.h"
+#include "WordLangTuple.h"
+#include "funcrequest.h"
+#include "buffer.h"
+#include "metricsinfo.h"
 
-#include "insets/insettext.h"
+#include "frontends/font_metrics.h"
+#include "frontends/Painter.h"
+#include "frontends/LyXView.h"
 
+#include "support/LAssert.h"
 #include "support/LOstream.h"
-#include "support/lstrings.h"
 
 using std::vector;
 using std::ostream;
@@ -35,13 +40,10 @@ using std::endl;
 using std::max;
 
 
-class LyXText;
-
-
 InsetCollapsable::InsetCollapsable(BufferParams const & bp, bool collapsed)
        : UpdatableInset(), collapsed_(collapsed), inset(bp),
          button_length(0), button_top_y(0), button_bottom_y(0),
-         need_update(NONE), label("Label"),
+         label("Label"),
 #if 0
        autocollapse(false),
 #endif
@@ -55,17 +57,17 @@ InsetCollapsable::InsetCollapsable(BufferParams const & bp, bool collapsed)
 }
 
 
-InsetCollapsable::InsetCollapsable(InsetCollapsable const & in, bool same_id)
-       : UpdatableInset(in, same_id), collapsed_(in.collapsed_),
+InsetCollapsable::InsetCollapsable(InsetCollapsable const & in)
+       : UpdatableInset(in), collapsed_(in.collapsed_),
          framecolor(in.framecolor), labelfont(in.labelfont), inset(in.inset),
          button_length(0), button_top_y(0), button_bottom_y(0),
-         need_update(NONE), label(in.label),
+         label(in.label),
 #if 0
          autocollapse(in.autocollapse),
 #endif
          oldWidth(0), in_update(false), first_after_edit(false)
 {
-       inset.init(&(in.inset), same_id);
+       inset.init(&(in.inset));
        inset.setOwner(this);
 }
 
@@ -83,12 +85,11 @@ bool InsetCollapsable::insertInset(BufferView * bv, Inset * in)
 
 void InsetCollapsable::write(Buffer const * buf, ostream & os) const
 {
-       os << "collapsed " << tostr(collapsed_) << "\n";
+       os << "collapsed " << (collapsed_ ? "true" : "false") << "\n";
        inset.writeParagraphData(buf, os);
 }
 
 
-
 void InsetCollapsable::read(Buffer const * buf, LyXLex & lex)
 {
        if (lex.isOK()) {
@@ -108,188 +109,91 @@ void InsetCollapsable::read(Buffer const * buf, LyXLex & lex)
 }
 
 
-int InsetCollapsable::ascent_collapsed() const
+void InsetCollapsable::dimension_collapsed(Dimension & dim) const
 {
-       int width = 0;
-       int ascent = 0;
-       int descent = 0;
-       font_metrics::buttonText(label, labelfont, width, ascent, descent);
-       return ascent;
+       font_metrics::buttonText(label, labelfont, dim.wid, dim.asc, dim.des);
+       dim.wid += 2 * TEXT_TO_INSET_OFFSET;
 }
 
 
-int InsetCollapsable::descent_collapsed() const
+int InsetCollapsable::height_collapsed() const
 {
-       int width = 0;
-       int ascent = 0;
-       int descent = 0;
-       font_metrics::buttonText(label, labelfont, width, ascent, descent);
-       return descent;
+       Dimension dim;
+       font_metrics::buttonText(label, labelfont, dim.wid, dim.asc, dim.des);
+       return dim.asc + dim.des;
 }
 
 
-//int InsetCollapsable::width_collapsed(Painter & pain) const
-int InsetCollapsable::width_collapsed() const
-{
-       int width;
-       int ascent;
-       int descent;
-       font_metrics::buttonText(label, labelfont, width, ascent, descent);
-       return width + (2*TEXT_TO_INSET_OFFSET);
-}
-
-
-int InsetCollapsable::ascent(BufferView * /*bv*/, LyXFont const &) const
-{
-       return ascent_collapsed();
-}
-
-
-int InsetCollapsable::descent(BufferView * bv, LyXFont const & font) const
+void InsetCollapsable::metrics(MetricsInfo & mi, Dimension & dim) const
 {
+       dimension_collapsed(dim);
        if (collapsed_)
-               return descent_collapsed();
-
-       return descent_collapsed()
-               + inset.descent(bv, font)
-               + inset.ascent(bv, font)
-               + TEXT_TO_BOTTOM_OFFSET;
+               return;
+       Dimension insetdim;
+       inset.metrics(mi, insetdim);
+       dim.des += insetdim.height() + TEXT_TO_BOTTOM_OFFSET;
+       dim.wid = max(dim.wid, insetdim.wid);
 }
 
 
-int InsetCollapsable::width(BufferView * bv, LyXFont const & font) const
+void InsetCollapsable::draw_collapsed(PainterInfo & pi, int x, int y) const
 {
-       if (collapsed_)
-               return width_collapsed();
-
-       int widthCollapsed = width_collapsed();
-
-       return (inset.width(bv, font) > widthCollapsed) ?
-               inset.width(bv, font) : widthCollapsed;
+       pi.pain.buttonText(x + TEXT_TO_INSET_OFFSET, y, label, labelfont);
 }
 
 
-void InsetCollapsable::draw_collapsed(Painter & pain,
-                                     int baseline, float & x) const
+void InsetCollapsable::draw(PainterInfo & pi, int x, int y, bool inlined) const
 {
-       pain.buttonText(int(x) + TEXT_TO_INSET_OFFSET,
-                       baseline, label, labelfont);
-       x += width_collapsed();
-}
-
+       lyx::Assert(pi.base.bv);
+       cache(pi.base.bv);
 
-void InsetCollapsable::draw(BufferView * bv, LyXFont const & f,
-                           int baseline, float & x, bool cleared) const
-{
-       if (need_update != NONE) {
-               const_cast<InsetText *>(&inset)->update(bv, f, true);
-               bv->text->status(bv, LyXText::CHANGED_IN_DRAW);
-               need_update = NONE;
-               return;
-       }
        if (nodraw())
                return;
 
-       Painter & pain = bv->painter();
+       Dimension dim_collapsed;
+       dimension_collapsed(dim_collapsed);
 
-       button_length = width_collapsed();
-       button_top_y = -ascent(bv, f);
-       button_bottom_y = -ascent(bv, f) + ascent_collapsed() +
-               descent_collapsed();
+       int const aa    = ascent(pi.base.bv, pi.base.font);
+       button_length   = dim_collapsed.width();
+       button_top_y    = -aa;
+       button_bottom_y = -aa + dim_collapsed.height();
 
        if (!isOpen()) {
-               draw_collapsed(pain, baseline, x);
+               draw_collapsed(pi, x, y);
                return;
        }
 
-       float old_x = x;
+       int old_x = x;
 
        if (!owner())
-               x += static_cast<float>(scroll());
+               x += scroll();
 
-       if (!cleared && (inset.need_update == InsetText::FULL ||
-                        inset.need_update == InsetText::INIT ||
-                        top_x != int(x) ||
-                        top_baseline != baseline))
-       {
-               // we don't need anymore to clear here we just have to tell
-               // the underlying LyXText that it should do the RowClear!
-               inset.setUpdateStatus(bv, InsetText::FULL);
-               bv->text->status(bv, LyXText::CHANGED_IN_DRAW);
-               return;
-       }
-
-       top_x = int(x);
-       topx_set = true;
-       top_baseline = baseline;
-
-       int const bl = baseline - ascent(bv, f) + ascent_collapsed();
-
-       draw_collapsed(pain, bl, old_x);
-       inset.draw(bv, f,
-                          bl + descent_collapsed() + inset.ascent(bv, f),
-                          x, cleared);
-       if (x < (top_x + button_length + TEXT_TO_INSET_OFFSET))
-               x = top_x + button_length + TEXT_TO_INSET_OFFSET;
-}
+       top_x = x;
+       top_baseline = y;
 
+       int const bl = y - aa + dim_collapsed.ascent();
 
-void InsetCollapsable::edit(BufferView * bv, int xp, int yp,
-                            mouse_button::state button)
-{
-       UpdatableInset::edit(bv, xp, yp, button);
-
-       if (collapsed_) {
-               collapsed_ = false;
-               // set this only here as it should be recollapsed only if
-               // it was already collapsed!
-               first_after_edit = true;
-               if (!bv->lockInset(this))
-                       return;
-               bv->updateInset(this, false);
-               inset.edit(bv);
+       if (inlined) {
+               inset.draw(pi, x, y);
        } else {
-               if (!bv->lockInset(this))
-                       return;
-               if (yp <= button_bottom_y) {
-                       inset.edit(bv, xp, 0, button);
-               } else {
-                       LyXFont font(LyXFont::ALL_SANE);
-                       int yy = ascent(bv, font) + yp -
-                               (ascent_collapsed() +
-                                descent_collapsed() +
-                                inset.ascent(bv, font));
-                       inset.edit(bv, xp, yy, button);
-               }
+               draw_collapsed(pi, old_x, bl);
+               int const yy = bl + dim_collapsed.descent()
+                       + inset.ascent(pi.base.bv, pi.base.font);
+               inset.draw(pi, x, yy);
        }
 }
 
 
-void InsetCollapsable::edit(BufferView * bv, bool front)
+void InsetCollapsable::draw(PainterInfo & pi, int x, int y) const
 {
-       UpdatableInset::edit(bv, front);
-
-       if (collapsed_) {
-               collapsed_ = false;
-               if (!bv->lockInset(this))
-                       return;
-               inset.setUpdateStatus(bv, InsetText::FULL);
-               bv->updateInset(this, false);
-               inset.edit(bv, front);
-               first_after_edit = true;
-       } else {
-               if (!bv->lockInset(this))
-                       return;
-               inset.edit(bv, front);
-       }
+       // by default, we are not inlined-drawing
+       draw(pi, x, y, false);
 }
 
 
 Inset::EDITABLE InsetCollapsable::editable() const
 {
-       if (collapsed_)
-               return IS_EDITABLE;
-       return HIGHLY_EDITABLE;
+       return collapsed_ ? IS_EDITABLE : HIGHLY_EDITABLE;
 }
 
 
@@ -308,75 +212,59 @@ void InsetCollapsable::insetUnlock(BufferView * bv)
        inset.insetUnlock(bv);
        if (scroll())
                scroll(bv, 0.0F);
-       bv->updateInset(this, false);
+       bv->updateInset(this);
 }
 
 
-void InsetCollapsable::insetButtonPress(BufferView * bv,
-       int x, int y, mouse_button::state button)
+FuncRequest InsetCollapsable::adjustCommand(FuncRequest const & cmd)
 {
-       if (!collapsed_ && (y > button_bottom_y)) {
-               LyXFont font(LyXFont::ALL_SANE);
-               int yy = ascent(bv, font) + y -
-                   (ascent_collapsed() +
-                    descent_collapsed() +
-                    inset.ascent(bv, font));
-               inset.insetButtonPress(bv, x, yy, button);
-       }
+       LyXFont font(LyXFont::ALL_SANE);
+       FuncRequest cmd1 = cmd;
+       cmd1.y = ascent(cmd.view(), font) + cmd.y -
+           (height_collapsed() + inset.ascent(cmd.view(), font));
+       return cmd1;
 }
 
 
-bool InsetCollapsable::insetButtonRelease(BufferView * bv,
-       int x, int y, mouse_button::state button)
+void InsetCollapsable::lfunMouseRelease(FuncRequest const & cmd)
 {
        bool ret = false;
-       if ((button != mouse_button::button3) && (x < button_length) &&
-           (y >= button_top_y) &&  (y <= button_bottom_y))
+       BufferView * bv = cmd.view();
+
+       if (collapsed_ && cmd.button() != mouse_button::button3) {
+               collapsed_ = false;
+               inset.setUpdateStatus(bv, InsetText::FULL);
+               bv->updateInset(this);
+               bv->buffer()->markDirty();
+               return;
+       }
+
+       if ((cmd.button() != mouse_button::button3) && (cmd.x < button_length) &&
+           (cmd.y >= button_top_y) && (cmd.y <= button_bottom_y))
        {
                if (collapsed_) {
                        collapsed_ = false;
-// should not be called on inset open!
-//                     inset.insetButtonRelease(bv, 0, 0, button);
                        inset.setUpdateStatus(bv, InsetText::FULL);
-                       bv->updateInset(this, false);
+                       bv->updateInset(this);
+                       bv->buffer()->markDirty();
                } else {
                        collapsed_ = true;
                        bv->unlockInset(this);
-                       bv->updateInset(this, false);
+                       bv->updateInset(this);
+                       bv->buffer()->markDirty();
                }
-       } else if (!collapsed_ && (y > button_bottom_y)) {
-               LyXFont font(LyXFont::ALL_SANE);
-               int yy = ascent(bv, font) + y -
-                   (ascent_collapsed() +
-                    descent_collapsed() +
-                    inset.ascent(bv, font));
-               ret = inset.insetButtonRelease(bv, x, yy, button);
-       }
-       if ((button == mouse_button::button3) && !ret) {
-               return showInsetDialog(bv);
-       }
-       return ret;
-}
-
-
-void InsetCollapsable::insetMotionNotify(BufferView * bv,
-       int x, int y, mouse_button::state state)
-{
-       if (y > button_bottom_y) {
-               LyXFont font(LyXFont::ALL_SANE);
-               int yy = ascent(bv, font) + y -
-                   (ascent_collapsed() +
-                    descent_collapsed() +
-                    inset.ascent(bv, font));
-               inset.insetMotionNotify(bv, x, yy, state);
+       } else if (!collapsed_ && (cmd.y > button_bottom_y)) {
+               ret = (inset.localDispatch(adjustCommand(cmd)) == DISPATCHED);
        }
+       if (cmd.button() == mouse_button::button3 && !ret)
+               showInsetDialog(bv);
 }
 
 
 int InsetCollapsable::latex(Buffer const * buf, ostream & os,
-                           bool fragile, bool free_spc) const
+                           LatexRunParams const & runparams) const
 {
-       return inset.latex(buf, os, fragile, free_spc);
+       return inset.latex(buf, os, runparams);
 }
 
 
@@ -397,54 +285,103 @@ int InsetCollapsable::docbook(Buffer const * buf, ostream & os, bool mixcont) co
        return inset.docbook(buf, os, mixcont);
 }
 
-#if 0
-int InsetCollapsable::getMaxWidth(BufferView * bv,
-                                 UpdatableInset const * in) const
-{
-#if 0
-       int const w = UpdatableInset::getMaxWidth(bv, in);
-
-       if (w < 0) {
-               // What does a negative max width signify? (Lgb)
-               // Use the max width of the draw-area (Jug)
-               return w;
-       }
-       // should be at least 30 pixels !!!
-       return max(30, w - width_collapsed());
-#else
-       return UpdatableInset::getMaxWidth(bv, in);
-#endif
-}
-#endif
 
-
-void InsetCollapsable::update(BufferView * bv, LyXFont const & font,
-                             bool reinit)
+void InsetCollapsable::update(BufferView * bv, bool reinit)
 {
        if (in_update) {
                if (reinit && owner()) {
-                       owner()->update(bv, font, true);
+                       owner()->update(bv, true);
                }
                return;
        }
        in_update = true;
-       inset.update(bv, font, reinit);
+       inset.update(bv, reinit);
        if (reinit && owner()) {
-               owner()->update(bv, font, true);
+               owner()->update(bv, true);
        }
        in_update = false;
 }
 
 
-UpdatableInset::RESULT
-InsetCollapsable::localDispatch(BufferView * bv, kb_action action,
-                               string const & arg)
-{
-       UpdatableInset::RESULT result = inset.localDispatch(bv, action, arg);
-       if (result >= FINISHED)
-               bv->unlockInset(this);
-       first_after_edit = false;
-       return result;
+Inset::RESULT InsetCollapsable::localDispatch(FuncRequest const & cmd)
+{
+       //lyxerr << "InsetCollapsable::localDispatch: " << cmd.action << "\n";
+       BufferView * bv = cmd.view();
+       switch (cmd.action) {
+               case LFUN_INSET_EDIT: {
+                       if (!cmd.argument.empty()) {
+                               UpdatableInset::localDispatch(cmd);
+                               if (collapsed_) {
+                                       collapsed_ = false;
+                                       if (bv->lockInset(this)) {
+                                               inset.setUpdateStatus(bv, InsetText::FULL);
+                                               bv->updateInset(this);
+                                               bv->buffer()->markDirty();
+                                               inset.localDispatch(cmd);
+                                               first_after_edit = true;
+                                       }
+                               } else {
+                                       if (bv->lockInset(this))
+                                               inset.localDispatch(cmd);
+                               }
+                               return DISPATCHED;
+                       }
+
+#ifdef WITH_WARNINGS
+#warning Fix this properly in BufferView_pimpl::workAreaButtonRelease
+#endif
+                       if (cmd.button() == mouse_button::button3)
+                               return DISPATCHED;
+
+                       UpdatableInset::localDispatch(cmd);
+
+                       if (collapsed_) {
+                               collapsed_ = false;
+                               // set this only here as it should be recollapsed only if
+                               // it was already collapsed!
+                               first_after_edit = true;
+                               if (!bv->lockInset(this))
+                                       return DISPATCHED;
+                               bv->updateInset(this);
+                               bv->buffer()->markDirty();
+                               inset.localDispatch(cmd);
+                       } else {
+                               FuncRequest cmd1 = cmd;
+                               if (!bv->lockInset(this))
+                                       return DISPATCHED;
+                               if (cmd.y <= button_bottom_y) {
+                                       cmd1.y = 0;
+                               } else {
+                                       LyXFont font(LyXFont::ALL_SANE);
+                                       cmd1.y = ascent(bv, font) + cmd.y -
+                                               (height_collapsed() + inset.ascent(bv, font));
+                               }
+                               inset.localDispatch(cmd);
+                       }
+                       return DISPATCHED;
+               }
+
+               case LFUN_MOUSE_PRESS:
+                       if (!collapsed_ && cmd.y > button_bottom_y)
+                               inset.localDispatch(adjustCommand(cmd));
+                       return DISPATCHED;
+
+               case LFUN_MOUSE_MOTION:
+                       if (!collapsed_ && cmd.y > button_bottom_y)
+                               inset.localDispatch(adjustCommand(cmd));
+                       return DISPATCHED;
+
+               case LFUN_MOUSE_RELEASE:
+                       lfunMouseRelease(cmd);
+                       return DISPATCHED;
+
+               default:
+                       UpdatableInset::RESULT result = inset.localDispatch(cmd);
+                       if (result >= FINISHED)
+                               bv->unlockInset(this);
+                       first_after_edit = false;
+                       return result;
+       }
 }
 
 
@@ -487,27 +424,15 @@ void InsetCollapsable::validate(LaTeXFeatures & features) const
 }
 
 
-void InsetCollapsable::getCursorPos(BufferView * bv, int & x, int & y) const
+void InsetCollapsable::getCursor(BufferView & bv, int & x, int & y) const
 {
-       inset.getCursorPos(bv, x , y);
+       inset.getCursor(bv, x, y);
 }
 
 
-void InsetCollapsable::toggleInsetCursor(BufferView * bv)
-{
-       inset.toggleInsetCursor(bv);
-}
-
-
-void InsetCollapsable::showInsetCursor(BufferView * bv, bool show)
-{
-       inset.showInsetCursor(bv, show);
-}
-
-
-void InsetCollapsable::hideInsetCursor(BufferView * bv)
+void InsetCollapsable::getCursorPos(BufferView * bv, int & x, int & y) const
 {
-       inset.hideInsetCursor(bv);
+       inset.getCursorPos(bv, x , y);
 }
 
 
@@ -535,12 +460,6 @@ void InsetCollapsable::setFont(BufferView * bv, LyXFont const & font,
 }
 
 
-bool InsetCollapsable::doClearArea() const
-{
-       return inset.doClearArea();
-}
-
-
 LyXText * InsetCollapsable::getLyXText(BufferView const * bv,
                                       bool const recursive) const
 {
@@ -585,22 +504,9 @@ int InsetCollapsable::scroll(bool recursive) const
 }
 
 
-Paragraph * InsetCollapsable::getParFromID(int id) const
+ParagraphList * InsetCollapsable::getParagraphs(int i) const
 {
-       lyxerr[Debug::INFO] << "Looking for paragraph " << id << endl;
-       return inset.getParFromID(id);
-}
-
-
-Paragraph * InsetCollapsable::firstParagraph() const
-{
-       return inset.firstParagraph();
-}
-
-
-Paragraph * InsetCollapsable::getFirstParagraph(int i) const
-{
-       return inset.getFirstParagraph(i);
+       return inset.getParagraphs(i);
 }
 
 
@@ -623,7 +529,7 @@ void InsetCollapsable::open(BufferView * bv)
        if (!collapsed_) return;
 
        collapsed_ = false;
-       bv->updateInset(this, false);
+       bv->updateInset(this);
 }
 
 
@@ -633,7 +539,7 @@ void InsetCollapsable::close(BufferView * bv) const
                return;
 
        collapsed_ = true;
-       bv->updateInset(const_cast<InsetCollapsable *>(this), false);
+       bv->updateInset(const_cast<InsetCollapsable *>(this));
 }
 
 
@@ -643,6 +549,24 @@ void InsetCollapsable::setLabel(string const & l) const
 }
 
 
+void InsetCollapsable::markErased()
+{
+       inset.markErased();
+}
+
+
+bool InsetCollapsable::nextChange(BufferView * bv, lyx::pos_type & length)
+{
+       bool found = inset.nextChange(bv, length);
+
+       if (first_after_edit && !found)
+               close(bv);
+       else if (!found)
+               first_after_edit = false;
+       return found;
+}
+
+
 bool InsetCollapsable::searchForward(BufferView * bv, string const & str,
                                     bool cs, bool mw)
 {
@@ -667,12 +591,30 @@ bool InsetCollapsable::searchBackward(BufferView * bv, string const & str,
 }
 
 
-string const InsetCollapsable::selectNextWordToSpellcheck(BufferView * bv,
-                                             float & value) const
+WordLangTuple const
+InsetCollapsable::selectNextWordToSpellcheck(BufferView * bv, float & value) const
 {
-       string const str = inset.selectNextWordToSpellcheck(bv, value);
-       if (first_after_edit && str.empty())
+       WordLangTuple word = inset.selectNextWordToSpellcheck(bv, value);
+       if (first_after_edit && word.word().empty())
                close(bv);
        first_after_edit = false;
-       return str;
+       return word;
+}
+
+
+void InsetCollapsable::addPreview(grfx::PreviewLoader & loader) const
+{
+       inset.addPreview(loader);
+}
+
+
+void InsetCollapsable::cache(BufferView * bv) const
+{
+       view_ = bv->owner()->view();
+}
+
+
+BufferView * InsetCollapsable::view() const
+{
+       return view_.lock().get();
 }