]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/formulabase.h
rename commandtags.h to lfuns.h and renumber/cleanup. Rebuild the tree !
[lyx.git] / src / mathed / formulabase.h
index aa330d6568eb99ef2ad3a00c16768e65ca7232f8..1459c894a3b14bf30b2dc482ea6ad33858e1e853 100644 (file)
@@ -1,40 +1,35 @@
 // -*- 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 "insets/updatableinset.h"
+#include "frontends/mouse_state.h"
+#include "lyxfont.h"
+
+#include <boost/weak_ptr.hpp>
 #include <iosfwd>
-#include "insets/inset.h"
 
 class Buffer;
 class BufferView;
-class MathInset;
+class MathAtom;
 
-///
+/// An abstract base class for all math related LyX insets
 class InsetFormulaBase : public UpdatableInset {
 public:
-       /// 
-       InsetFormulaBase(InsetFormulaBase const & p);
-       ///
-       explicit InsetFormulaBase(MathInset *);
        ///
-       virtual ~InsetFormulaBase();
+       InsetFormulaBase();
        ///
        virtual int ascent(BufferView *, LyXFont const &) const = 0;
        ///
@@ -42,104 +37,117 @@ public:
        ///
        virtual int width(BufferView *, LyXFont const &) const = 0;
        ///
-       virtual void draw(BufferView *,LyXFont const &, int, float &, bool) const = 0;
+       virtual void draw(BufferView *,LyXFont const &, int, float &) const = 0;
+       /// 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;
 
-       /// These are just wrappers taking the unused Buffer * dummy parameter
-       /// 
-       virtual void write(Buffer const *, std::ostream &) const;
+public:
        ///
-       virtual void read(Buffer const *, LyXLex & lex);
+       // Don't use this for AMS validation as long as there is no
+       // user-accessible way to override "false positives"
+       virtual void validate(LaTeXFeatures &) const;
        ///
-       virtual int latex(Buffer const *, std::ostream &,
-                 bool fragile, bool free_spc) const;
+       virtual Inset * clone(Buffer const &, bool same_id = false) const = 0;
        ///
-       virtual int ascii(Buffer const *, std::ostream &, int linelen) const;
+       virtual Inset::Code lyxCode() const;
+       /// what appears in the minibuffer when opening
+       virtual string const editMessage() const;
        ///
-       virtual int linuxdoc(Buffer const *, std::ostream &) const;
+       virtual void edit(BufferView *, int x, int y, mouse_button::state button);
        ///
-       virtual int docBook(Buffer const *, std::ostream &) const;
-
-protected:
-       /// the actual functions don't use the Buffer * parameter
+       virtual void edit(BufferView *, bool front = true);
+       ///
+       virtual void toggleInsetCursor(BufferView *);
        ///
-       virtual void write(std::ostream &) const = 0;
+       virtual void showInsetCursor(BufferView *, bool show = true);
        ///
-       virtual void read(LyXLex & lex) = 0;
+       virtual void hideInsetCursor(BufferView *);
        ///
-       virtual int latex(std::ostream &, bool fragile, bool free_spc) const = 0;
+       virtual void fitInsetCursor(BufferView *) const;
        ///
-       virtual int ascii(std::ostream &, int linelen) const = 0;
+       virtual void getCursorPos(BufferView *, int &, int &) const;
        ///
-       virtual int linuxdoc(std::ostream &) const = 0;
+       virtual void toggleInsetSelection(BufferView * bv);
        ///
-       virtual int docBook(std::ostream &) const = 0;
+       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 void status(FuncRequest const &);
 
-public:
        ///
-       virtual void validate(LaTeXFeatures &) const;
+       virtual std::vector<string> const getLabelList() const;
        ///
-       virtual Inset * clone(Buffer const &, bool same_id = false) const = 0;
+       virtual MathAtom const & par() const = 0;
        ///
-       virtual Inset::Code lyxCode() const;
+       virtual MathAtom & par() = 0;
        ///
-       virtual LyXFont const convertFont(LyXFont const & f) const;
-       /// what appears in the minibuffer when opening
-       virtual string const editMessage() const;
+       // And shouldn't this really return a shared_ptr<BufferView> instead?
+       BufferView * view() const;
+
        ///
-       virtual void edit(BufferView *, int x, int y, unsigned int button);
+       virtual bool searchForward(BufferView *, string const &,
+                                  bool = true, bool = false);
        ///
-       virtual void toggleInsetCursor(BufferView *);
+       virtual bool searchBackward(BufferView *, string const &,
+                                   bool = true, bool = false);
        ///
-       virtual void showInsetCursor(BufferView *, bool show = true);
+       virtual bool isTextInset() const { return true; }
        ///
-       virtual void hideInsetCursor(BufferView *);
+       virtual void mutateToText();
        ///
-       virtual void getCursorPos(BufferView *, int &, int &) const;
+       virtual void revealCodes(BufferView *) const;
        ///
-       virtual void toggleInsetSelection(BufferView * bv);
+       virtual EDITABLE editable() const { return HIGHLY_EDITABLE; }
        ///
-       virtual void insetButtonPress(BufferView *, int x, int y, int button);
+       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 &);
        ///
-       virtual void insetButtonRelease(BufferView *, int x, int y, int button);
+       dispatch_result lfunMouseRelease(FuncRequest const &);
        ///
-       virtual void insetKeyPress(XKeyEvent * ev);
+       dispatch_result lfunMouseMotion(FuncRequest const &);
+
+protected:
        ///
-       virtual void insetMotionNotify(BufferView *, int x, int y, int state);
+       mutable boost::weak_ptr<BufferView> view_;
        ///
-       virtual void insetUnlock(BufferView *);
-   
-       /// To allow transparent use of math editing functions
-       virtual RESULT localDispatch(BufferView *, kb_action, string const &);
-    
+       mutable LyXFont font_;
+
+protected:
        ///
-       virtual std::vector<string> const getLabelList() const;
+       void metrics(BufferView * bv, LyXFont const & font) const;
        ///
-       MathInset * par() const;
-protected:
+       void metrics(BufferView * bv = 0) const;
        ///
-       virtual void updateLocal(BufferView * bv);
+       void handleFont(BufferView * bv, string const & arg, string const & font);
 
        ///
-       MathInset * par_;
+       mutable int xo_;
+       ///
+       mutable int yo_;
 };
 
 // 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 mathDispatchMathImportSelection(BufferView *, string const &);
+void mathDispatch(FuncRequest const &);
+
+///
+void releaseMathCursor(BufferView * bv);
 
 #endif