4 * Purpose: Common parts of the math LyX insets
7 * Description: Allows the edition of math paragraphs inside Lyx.
9 * Copyright: 2001, The LyX Project
11 * You are free to use and modify this code under the terms of
12 * the GNU General Public Licence version 2 or later.
15 #ifndef INSET_FORMULABASE_H
16 #define INSET_FORMULABASE_H
23 #include "insets/inset.h"
25 // only for getType():
26 #include "math_defs.h"
33 class InsetFormulaBase : public UpdatableInset {
38 virtual int ascent(BufferView *, LyXFont const &) const = 0;
40 virtual int descent(BufferView *, LyXFont const &) const = 0;
42 virtual int width(BufferView *, LyXFont const &) const = 0;
44 virtual void draw(BufferView *,LyXFont const &, int, float &, bool) const = 0;
46 /// These are just wrappers taking the unused Buffer * dummy parameter
48 virtual void write(Buffer const *, std::ostream &) const;
50 virtual void read(Buffer const *, LyXLex & lex);
52 virtual int latex(Buffer const *, std::ostream &,
53 bool fragile, bool free_spc) const;
55 virtual int ascii(Buffer const *, std::ostream &, int linelen) const;
57 virtual int linuxdoc(Buffer const *, std::ostream &) const;
59 virtual int docBook(Buffer const *, std::ostream &) const;
61 virtual MathInsetTypes getType() const = 0;
64 /// the actual functions don't use the Buffer * parameter
66 virtual void write(std::ostream &) const = 0;
68 virtual void read(LyXLex & lex) = 0;
70 virtual int latex(std::ostream &, bool fragile, bool free_spc) const = 0;
72 virtual int ascii(std::ostream &, int linelen) const = 0;
74 virtual int linuxdoc(std::ostream &) const = 0;
76 virtual int docBook(std::ostream &) const = 0;
80 virtual void validate(LaTeXFeatures &) const;
82 virtual Inset * clone(Buffer const &, bool same_id = false) const = 0;
84 virtual Inset::Code lyxCode() const;
87 virtual LyXFont const convertFont(LyXFont const & f) const;
89 /// what appears in the minibuffer when opening
90 virtual string const editMessage() const;
92 virtual void edit(BufferView *, int x, int y, unsigned int button);
93 virtual void edit(BufferView *, bool front = true);
95 virtual void toggleInsetCursor(BufferView *);
97 virtual void showInsetCursor(BufferView *, bool show = true);
99 virtual void hideInsetCursor(BufferView *);
101 virtual void getCursorPos(BufferView *, int &, int &) const;
103 virtual void toggleInsetSelection(BufferView * bv);
105 virtual void insetButtonPress(BufferView *, int x, int y, int button);
107 virtual void insetButtonRelease(BufferView *, int x, int y, int button);
109 virtual void insetKeyPress(XKeyEvent * ev);
111 virtual void insetMotionNotify(BufferView *, int x, int y, int state);
113 virtual void insetUnlock(BufferView *);
115 /// To allow transparent use of math editing functions
116 virtual RESULT localDispatch(BufferView *, kb_action, string const &);
119 virtual std::vector<string> const getLabelList() const;
121 virtual MathInset const * par() const = 0;
123 virtual void metrics() const = 0;
126 virtual void updateLocal(BufferView * bv, bool mark_dirty);
129 void operator=(const InsetFormulaBase &);
132 // We don't really mess want around with mathed stuff outside mathed.
135 void mathDispatchCreation(BufferView *, string const &, bool);
137 void mathDispatchMathDisplay(BufferView *, string const &);
139 void mathDispatchMathMode(BufferView *, string const &);
141 void mathDispatchMathMacro(BufferView *, string const &);
143 void mathDispatchMathDelim(BufferView *, string const &);
145 void mathDispatchInsertMath(BufferView *, string const &);
147 void mathDispatchInsertMatrix(BufferView *, string const &);
149 void mathDispatchMathImportSelection(BufferView *, string const &);