split inset -> inset + updatableinset

[lyx.git] / src / mathed / formulabase.h

diff --git a/src/mathed/formulabase.h b/src/mathed/formulabase.h
index c1ab91937086c5494cff687d3a8d0a949549a99a..9c53c47c57bb8aabd727eee9afadb9c512a620e3 100644 (file)
--- a/src/mathed/formulabase.h
+++ b/src/mathed/formulabase.h
@@ -1,36 +1,31 @@
 // -*- C++ -*-
+
 /*
- *  File:        formulabase.h
- *  Purpose:     Common parts of the math LyX insets
- *  Author:      André Pönitz
- *  Created:     May 2001
- *  Description: Allows the edition of math paragraphs inside Lyx. 
+ * Common parts of the math LyX insets
+ * \author  André Pönitz
  *
- *  Copyright: 2001, The LyX Project
+ * Full author contact details are available in file CREDITS
  *
- *   You are free to use and modify this code under the terms of
- *   the GNU General Public Licence version 2 or later.
+ * You are free to use and modify this code under the terms of
+ * the GNU General Public Licence version 2 or later.
  */
 
-#ifndef INSET_FORMULABASE_H 
+#ifndef INSET_FORMULABASE_H
 #define INSET_FORMULABASE_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
 
-#include <iosfwd>
-#include "insets/inset.h"
+#include "insets/updatableinset.h"
+#include "frontends/mouse_state.h"
 #include "lyxfont.h"
 
-// only for getType():
-#include "math_defs.h"
+#include <boost/weak_ptr.hpp>
+#include <iosfwd>
 
 class Buffer;
 class BufferView;
 class MathAtom;
 
-///
+/// An abstract base class for all math related LyX insets
 class InsetFormulaBase : public UpdatableInset {
 public:
        ///
@@ -43,12 +38,14 @@ public:
        virtual int width(BufferView *, LyXFont const &) const = 0;
        ///
        virtual void draw(BufferView *,LyXFont const &, int, float &, bool) const = 0;
-       ///
-       virtual MathInsetTypes getType() const = 0;
-       /// upper y coordinate
-       virtual int upperY() const;
-       /// lower y coordinate
-       virtual int lowerY() const;
+       /// lowest x coordinate
+       virtual int xlow() const;
+       /// highest x coordinate
+       virtual int xhigh() const;
+       /// lowest y coordinate
+       virtual int ylow() const;
+       /// highest y coordinate
+       virtual int yhigh() const;
 
 public:
        ///
@@ -60,7 +57,7 @@ public:
        /// what appears in the minibuffer when opening
        virtual string const editMessage() const;
        ///
-       virtual void edit(BufferView *, int x, int y, unsigned int button);
+       virtual void edit(BufferView *, int x, int y, mouse_button::state button);
        ///
        virtual void edit(BufferView *, bool front = true);
        ///
@@ -70,23 +67,19 @@ public:
        ///
        virtual void hideInsetCursor(BufferView *);
        ///
+       virtual void fitInsetCursor(BufferView *) const;
+       ///
        virtual void getCursorPos(BufferView *, int &, int &) const;
        ///
        virtual void toggleInsetSelection(BufferView * bv);
        ///
-       virtual void insetButtonPress(BufferView *, int x, int y, int button);
-       ///
-       virtual void insetButtonRelease(BufferView *, int x, int y, int button);
-       ///
-       virtual void insetKeyPress(XKeyEvent * ev);
-       ///
-       virtual void insetMotionNotify(BufferView *, int x, int y, int state);
-       ///
        virtual void insetUnlock(BufferView *);
-   
+
+       /// To allow transparent use of math editing functions
+       virtual dispatch_result localDispatch(FuncRequest const &);
        /// To allow transparent use of math editing functions
-       virtual RESULT localDispatch(BufferView *, kb_action, string const &);
-    
+       //virtual void status(FuncRequest const &);
+
        ///
        virtual std::vector<string> const getLabelList() const;
        ///
@@ -94,23 +87,55 @@ public:
        ///
        virtual MathAtom & par() = 0;
        ///
-       virtual void metrics(BufferView * bv = 0, LyXFont const & font = LyXFont()) const;
-       ///
        virtual void updateLocal(BufferView * bv, bool mark_dirty);
        ///
-       int xo() const { return xo_; }
+       BufferView * view() const { return view_.get(); }
+
+       ///
+       virtual bool searchForward(BufferView *, string const &,
+                                  bool = true, bool = false);
        ///
-       int yo() const { return yo_; }
+       virtual bool searchBackward(BufferView *, string const &,
+                                   bool = true, bool = false);
        ///
-       BufferView * view() const { return view_; }
+       virtual bool isTextInset() const { return true; }
+       ///
+       virtual void mutateToText();
+       ///
+       virtual void revealCodes(BufferView *) const;
+       ///
+       virtual EDITABLE editable() const { return HIGHLY_EDITABLE; }
+       ///
+       bool display() const;
+       // return the selection as string
+       string selectionAsString() const;
+
 private:
        /// unimplemented
        void operator=(const InsetFormulaBase &);
+       /// common base for handling accents
+       void handleAccent(BufferView * bv, string const & arg, string const & name);
+       /// lfun handler
+       dispatch_result lfunMousePress(FuncRequest const &);
+       ///
+       dispatch_result lfunMouseRelease(FuncRequest const &);
+       ///
+       dispatch_result lfunMouseMotion(FuncRequest const &);
+
+protected:
        ///
-       mutable BufferView * view_;     
+       mutable boost::weak_ptr<BufferView> view_;
        ///
        mutable LyXFont font_;
+
 protected:
+       ///
+       void metrics(BufferView * bv, LyXFont const & font) const;
+       ///
+       void metrics(BufferView * bv = 0) const;
+       ///
+       void handleFont(BufferView * bv, string const & arg, string const & font);
+
        ///
        mutable int xo_;
        ///
@@ -119,23 +144,9 @@ protected:
 
 // We don't really mess want around with mathed stuff outside mathed.
 // So do it here.
-//
-void mathDispatchCreation(BufferView *, string const &, bool);
-//
-void mathDispatchMathDisplay(BufferView *, string const &);
-//
-void mathDispatchMathMode(BufferView *, string const &);
-//
-void mathDispatchMathMacro(BufferView *, string const &);
-//
-void mathDispatchMathDelim(BufferView *, string const &);
-//
-void mathDispatchInsertMath(BufferView *, string const &);
-//
-void mathDispatchInsertMatrix(BufferView *, string const &);
-//
-void mathDispatchGreek(BufferView *, string const &);
-//
-void mathDispatchMathImportSelection(BufferView *, string const &);
+void mathDispatch(FuncRequest const &);
+
+///
+void releaseMathCursor(BufferView * bv);
 
 #endif