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
22 #include "insets/inset.h"
23 #include "frontends/mouse_state.h"
26 #include <boost/weak_ptr.hpp>
34 /// An abstract base class for all math related LyX insets
35 class InsetFormulaBase : public UpdatableInset {
40 virtual int ascent(BufferView *, LyXFont const &) const = 0;
42 virtual int descent(BufferView *, LyXFont const &) const = 0;
44 virtual int width(BufferView *, LyXFont const &) const = 0;
46 virtual void draw(BufferView *,LyXFont const &, int, float &, bool) const = 0;
48 virtual string hullType() const { return "none"; }
49 /// lowest x coordinate
50 virtual int xlow() const;
51 /// highest x coordinate
52 virtual int xhigh() const;
53 /// lowest y coordinate
54 virtual int ylow() const;
55 /// highest y coordinate
56 virtual int yhigh() const;
60 virtual void validate(LaTeXFeatures &) const;
62 virtual Inset * clone(Buffer const &, bool same_id = false) const = 0;
64 virtual Inset::Code lyxCode() const;
65 /// what appears in the minibuffer when opening
66 virtual string const editMessage() const;
68 virtual void edit(BufferView *, int x, int y, mouse_button::state button);
70 virtual void edit(BufferView *, bool front = true);
72 virtual void toggleInsetCursor(BufferView *);
74 virtual void showInsetCursor(BufferView *, bool show = true);
76 virtual void hideInsetCursor(BufferView *);
78 virtual void fitInsetCursor(BufferView *) const;
80 virtual void getCursorPos(BufferView *, int &, int &) const;
82 virtual void toggleInsetSelection(BufferView * bv);
84 virtual void insetButtonPress(BufferView *, int x, int y, mouse_button::state button);
86 virtual bool insetButtonRelease(BufferView *, int x, int y, mouse_button::state button);
88 virtual void insetMotionNotify(BufferView *, int x, int y, mouse_button::state state);
90 virtual void insetUnlock(BufferView *);
92 /// To allow transparent use of math editing functions
93 virtual RESULT localDispatch(BufferView *, kb_action, string const &);
96 virtual std::vector<string> const getLabelList() const;
98 virtual MathAtom const & par() const = 0;
100 virtual MathAtom & par() = 0;
102 virtual void updateLocal(BufferView * bv, bool mark_dirty);
104 BufferView * view() const { return view_.get(); }
107 virtual bool searchForward(BufferView *, string const &,
108 bool = true, bool = false);
110 virtual bool searchBackward(BufferView *, string const &,
111 bool = true, bool = false);
113 virtual bool isTextInset() const { return true; }
115 virtual void mutateToText();
117 virtual void revealCodes(BufferView *) const;
119 virtual Inset::EDITABLE editable() const { return HIGHLY_EDITABLE; }
123 void operator=(const InsetFormulaBase &);
124 /// common base for handling accents
125 void handleAccent(BufferView * bv, string const & arg, string const & name);
129 mutable boost::weak_ptr<BufferView> view_;
131 mutable LyXFont font_;
135 void metrics(BufferView * bv, LyXFont const & font) const;
137 void metrics(BufferView * bv = 0) const;
139 void handleFont(BufferView * bv, string const & arg, string const & font);
147 // We don't really mess want around with mathed stuff outside mathed.
150 void mathDispatchCreation(BufferView *, string const &, bool);
152 void mathDispatchMathDisplay(BufferView *, string const &);
154 void mathDispatchMathMode(BufferView *, string const &);
156 void mathDispatchMathMacro(BufferView *, string const &);
158 void mathDispatchMathDelim(BufferView *, string const &);
160 void mathDispatchInsertMath(BufferView *, string const &);
162 void mathDispatchInsertMatrix(BufferView *, string const &);
164 void mathDispatchGreek(BufferView *, string const &);
166 void mathDispatchMathImportSelection(BufferView *, string const &);
168 void mathDispatch(BufferView *, kb_action, string const &);
170 void mathDispatch(BufferView *, string const &);