]> git.lyx.org Git - lyx.git/blobdiff - src/insets/inset.C
First step towards unified insets...
[lyx.git] / src / insets / inset.C
index 9673978b3d866601ea4a6cef5cf079f8b803fc08..21ca38df6c5f569c926d1714fdae411304a1423b 100644 (file)
@@ -1,30 +1,35 @@
-/* This file is part of
- * ====================================================== 
- * 
- *           LyX, The Document Processor
- *      
- *         Copyright 1995 Matthias Ettrich
- *          Copyright 1995-2001 The LyX Team.
+/**
+ * \file inset.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- * ====================================================== */
+ * \author Alejandro Aguilar Sierra
+ * \author Jürgen Vigna
+ * \author Lars Gullik Bjønnes
+ * \author Matthias Ettrich
+ *
+ * Full author contact details are available in file CREDITS
+ */
 
 #include <config.h>
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
 
 #include "inset.h"
-#include "debug.h"
+
 #include "BufferView.h"
-#include "support/lstrings.h"
-#include "Painter.h"
-#include "commandtags.h"
-#include "support/lstrings.h"
+#include "debug.h"
+#include "funcrequest.h"
 #include "gettext.h"
-#include "lyxfont.h"
 #include "lyxcursor.h"
+#include "lyxfont.h"
 #include "lyxtext.h"
+#include "WordLangTuple.h"
+
+#include "frontends/Painter.h"
+#include "frontends/mouse_state.h"
+
+#include "support/lstrings.h"
+#include "support/lstrings.h"
 
 using std::endl;
 
@@ -34,14 +39,16 @@ using std::endl;
 unsigned int Inset::inset_id = 0;
 
 Inset::Inset()
-       : top_x(0), topx_set(false), top_baseline(0), scx(0),
+       :       InsetBase(),
+               top_x(0), topx_set(false), top_baseline(0), scx(0),
          id_(inset_id++), owner_(0), par_owner_(0),
          background_color_(LColor::inherit)
 {}
 
 
 Inset::Inset(Inset const & in, bool same_id)
-       : top_x(0), topx_set(false), top_baseline(0), scx(0), owner_(0),
+       :       InsetBase(),
+               top_x(0), topx_set(false), top_baseline(0), scx(0), owner_(0),
          name_(in.name_), background_color_(in.background_color_)
 {
        if (same_id)
@@ -51,12 +58,6 @@ Inset::Inset(Inset const & in, bool same_id)
 }
 
 
-bool Inset::deletable() const
-{
-       return true;
-}
-
-
 bool Inset::directWrite() const
 {
        return false;
@@ -69,6 +70,10 @@ Inset::EDITABLE Inset::editable() const
 }
 
 
+void Inset::edit(BufferView *, int, int, mouse_button::state)
+{}
+
+
 void Inset::validate(LaTeXFeatures &) const
 {}
 
@@ -79,12 +84,14 @@ bool Inset::autoDelete() const
 }
 
 
-void Inset::edit(BufferView *, int, int, unsigned int)
+void Inset::edit(BufferView *, bool)
 {}
 
 
-void Inset::edit(BufferView *, bool)
-{}
+Inset::RESULT Inset::localDispatch(FuncRequest const &)
+{
+       return UNDISPATCHED;
+}
 
 
 #if 0
@@ -99,7 +106,7 @@ LyXFont const Inset::convertFont(LyXFont const & font) const
 #endif
 
 
-string const Inset::editMessage() const 
+string const Inset::editMessage() const
 {
        return _("Opened inset");
 }
@@ -142,7 +149,7 @@ void Inset::id(int id_arg)
        id_ = id_arg;
 }
 
-void Inset::setFont(BufferView *, LyXFont const &, bool, bool )
+void Inset::setFont(BufferView *, LyXFont const &, bool, bool)
 {}
 
 
@@ -153,6 +160,12 @@ bool Inset::forceDefaultParagraphs(Inset const * in) const
        return false;
 }
 
+int Inset::latexTextWidth(BufferView * bv) const
+{
+       if (owner())
+               return (owner()->latexTextWidth(bv));
+       return bv->workWidth();
+}
 
 // some stuff for inset locking
 
@@ -166,34 +179,6 @@ UpdatableInset::UpdatableInset(UpdatableInset const & in, bool same_id)
 {}
 
 
-void UpdatableInset::insetButtonPress(BufferView *, int x, int y, int button)
-{
-       lyxerr[Debug::INFO] << "Inset Button Press x=" << x
-                      << ", y=" << y << ", button=" << button << endl;
-}
-
-
-bool UpdatableInset::insetButtonRelease(BufferView *, int x, int y, int button)
-{
-       lyxerr[Debug::INFO] << "Inset Button Release x=" << x
-                      << ", y=" << y << ", button=" << button << endl;
-       return false;
-}
-
-
-void UpdatableInset::insetKeyPress(XKeyEvent *)
-{
-       lyxerr[Debug::INFO] << "Inset Keypress" << endl;
-}
-
-
-void UpdatableInset::insetMotionNotify(BufferView *, int x, int y, int state)
-{
-       lyxerr[Debug::INFO] << "Inset Motion Notify x=" << x
-                      << ", y=" << y << ", state=" << state << endl;
-}
-
-
 void UpdatableInset::insetUnlock(BufferView *)
 {
        lyxerr[Debug::INFO] << "Inset Unlock" << endl;
@@ -223,7 +208,7 @@ void UpdatableInset::fitInsetCursor(BufferView *) const
 {}
 
 
-void UpdatableInset::edit(BufferView *, int, int, unsigned int)
+void UpdatableInset::edit(BufferView *, int, int, mouse_button::state)
 {}
 
 
@@ -245,7 +230,7 @@ void UpdatableInset::draw(BufferView *, LyXFont const &,
 void UpdatableInset::scroll(BufferView * bv, float s) const
 {
        LyXFont font;
-       
+
        if (!s) {
                scx = 0;
                return;
@@ -253,8 +238,8 @@ void UpdatableInset::scroll(BufferView * bv, float s) const
 
        int const workW = bv->workWidth();
        int const tmp_top_x = top_x - scx;
-       
-       if (tmp_top_x > 0 && 
+
+       if (tmp_top_x > 0 &&
            (tmp_top_x + width(bv, font)) < workW)
                return;
        if (s > 0 && top_x > 0)
@@ -262,7 +247,7 @@ void UpdatableInset::scroll(BufferView * bv, float s) const
 
        // int mx_scx=abs((width(bv,font) - bv->workWidth())/2);
        //int const save_scx = scx;
-    
+
        scx = int(s * workW / 2);
        // if (!display())
        // scx += 20;
@@ -289,7 +274,7 @@ void UpdatableInset::scroll(BufferView * bv, int offset) const
                if (!scx && (top_x + width(bv, font)) < (bv->workWidth() - 20))
                        return;
                if ((top_x - scx + offset + width(bv, font)) < (bv->workWidth() - 20)) {
-                       scx = bv->workWidth() - width(bv, font) - top_x + scx - 20; 
+                       scx = bv->workWidth() - width(bv, font) - top_x + scx - 20;
                } else {
                        scx += offset;
                }
@@ -299,30 +284,31 @@ void UpdatableInset::scroll(BufferView * bv, int offset) const
 
 
 ///  An updatable inset could handle lyx editing commands
-UpdatableInset::RESULT
-UpdatableInset::localDispatch(BufferView * bv, 
-                             kb_action action, string const & arg) 
+Inset::RESULT UpdatableInset::localDispatch(FuncRequest const & ev)
 {
-       if (!arg.empty() && (action==LFUN_SCROLL_INSET)) {
-               if (arg.find('.') != arg.npos) {
-                       float const xx = static_cast<float>(strToDbl(arg));
-                       scroll(bv, xx);
+       if (ev.action == LFUN_MOUSE_RELEASE)
+               return (editable() == IS_EDITABLE) ? DISPATCHED : UNDISPATCHED;
+
+       if (!ev.argument.empty() && ev.action == LFUN_SCROLL_INSET) {
+               if (ev.argument.find('.') != ev.argument.npos) {
+                       float const xx = static_cast<float>(strToDbl(ev.argument));
+                       scroll(ev.view(), xx);
                } else {
-                       int const xx = strToInt(arg);
-                       scroll(bv, xx);
+                       int const xx = strToInt(ev.argument);
+                       scroll(ev.view(), xx);
                }
-               bv->updateInset(this, false);
-               
+               ev.view()->updateInset(this, false);
+
                return DISPATCHED;
        }
-       return UNDISPATCHED; 
+       return UNDISPATCHED;
 }
 
 
 int UpdatableInset::getMaxWidth(BufferView * bv, UpdatableInset const *) const
 {
        int w;
-       if (owner()){
+       if (owner()) {
                w = static_cast<UpdatableInset*>
                        (owner())->getMaxWidth(bv, this);
        } else {
@@ -337,16 +323,12 @@ int UpdatableInset::getMaxWidth(BufferView * bv, UpdatableInset const *) const
        if (topx_set && owner()) {
                w -= top_x;
                w += owner()->x();
-       }
-#if 0 // already handled above now!!!
-       else if (!owner()) {
-               // give some left margin this should be made better!
-               // Idea: LyXText::giveLeftMargin(Inset * inset) will search the
-               //       inset in the text and return the LeftMargin of that row!
-               lyxerr << "w -= 20\n";
+       } else if (owner()) {
+               // this is needed as otherwise we might have a too large inset if
+               // its top_x afterwards changes to LeftMargin so we try to put at
+               // least the default margin as top_x
                w -= 20;
        }
-#endif
        if (w < 10) {
                w = 10;
        }
@@ -362,18 +344,26 @@ LyXCursor const & Inset::cursor(BufferView * bv) const
 }
 
 
-string const UpdatableInset::selectNextWordToSpellcheck(BufferView *bv,
-                                           float & value) const
+WordLangTuple const
+UpdatableInset::selectNextWordToSpellcheck(BufferView *bv, float & value) const
 {
        // we have to unlock ourself in this function by default!
        bv->unlockInset(const_cast<UpdatableInset *>(this));
        value = 0;
-       return string();
+       return WordLangTuple();
 }
 
 
+bool UpdatableInset::nextChange(BufferView * bv, lyx::pos_type &)
+{
+       // we have to unlock ourself in this function by default!
+       bv->unlockInset(const_cast<UpdatableInset *>(this));
+       return false;
+}
+
 bool UpdatableInset::searchForward(BufferView * bv, string const &,
-                                   bool const &, bool const &)
+                                  bool, bool)
 {
        // we have to unlock ourself in this function by default!
        bv->unlockInset(const_cast<UpdatableInset *>(this));
@@ -382,7 +372,7 @@ bool UpdatableInset::searchForward(BufferView * bv, string const &,
 
 
 bool UpdatableInset::searchBackward(BufferView * bv, string const &,
-                                    bool const &, bool const &)
+                                   bool, bool)
 {
        // we have to unlock ourself in this function by default!
        bv->unlockInset(const_cast<UpdatableInset *>(this));