4 * Common parts of the math LyX insets
7 * Full author contact details are available in file CREDITS
9 * You are free to use and modify this code under the terms of
10 * the GNU General Public Licence version 2 or later.
13 #ifndef INSET_FORMULABASE_H
14 #define INSET_FORMULABASE_H
20 #include "insets/inset.h"
21 #include "frontends/mouse_state.h"
24 #include <boost/weak_ptr.hpp>
31 /// An abstract base class for all math related LyX insets
32 class InsetFormulaBase : public UpdatableInset {
37 virtual int ascent(BufferView *, LyXFont const &) const = 0;
39 virtual int descent(BufferView *, LyXFont const &) const = 0;
41 virtual int width(BufferView *, LyXFont const &) const = 0;
43 virtual void draw(BufferView *,LyXFont const &, int, float &, bool) const = 0;
44 /// lowest x coordinate
45 virtual int xlow() const;
46 /// highest x coordinate
47 virtual int xhigh() const;
48 /// lowest y coordinate
49 virtual int ylow() const;
50 /// highest y coordinate
51 virtual int yhigh() const;
55 virtual void validate(LaTeXFeatures &) const;
57 virtual Inset * clone(Buffer const &, bool same_id = false) const = 0;
59 virtual Inset::Code lyxCode() const;
60 /// what appears in the minibuffer when opening
61 virtual string const editMessage() const;
63 virtual void edit(BufferView *, int x, int y, mouse_button::state button);
65 virtual void edit(BufferView *, bool front = true);
67 virtual void toggleInsetCursor(BufferView *);
69 virtual void showInsetCursor(BufferView *, bool show = true);
71 virtual void hideInsetCursor(BufferView *);
73 virtual void fitInsetCursor(BufferView *) const;
75 virtual void getCursorPos(BufferView *, int &, int &) const;
77 virtual void toggleInsetSelection(BufferView * bv);
79 virtual void insetUnlock(BufferView *);
81 /// To allow transparent use of math editing functions
82 virtual RESULT localDispatch(FuncRequest const &);
83 /// To allow transparent use of math editing functions
84 //virtual void status(FuncRequest const &);
87 virtual std::vector<string> const getLabelList() const;
89 virtual MathAtom const & par() const = 0;
91 virtual MathAtom & par() = 0;
93 virtual void updateLocal(BufferView * bv, bool mark_dirty);
95 BufferView * view() const { return view_.get(); }
98 virtual bool searchForward(BufferView *, string const &,
99 bool = true, bool = false);
101 virtual bool searchBackward(BufferView *, string const &,
102 bool = true, bool = false);
104 virtual bool isTextInset() const { return true; }
106 virtual void mutateToText();
108 virtual void revealCodes(BufferView *) const;
110 virtual EDITABLE editable() const { return HIGHLY_EDITABLE; }
112 bool display() const;
113 // return the selection as string
114 string selectionAsString() const;
118 void operator=(const InsetFormulaBase &);
119 /// common base for handling accents
120 void handleAccent(BufferView * bv, string const & arg, string const & name);
122 RESULT lfunMousePress(FuncRequest const &);
124 RESULT lfunMouseRelease(FuncRequest const &);
126 RESULT lfunMouseMotion(FuncRequest const &);
130 mutable boost::weak_ptr<BufferView> view_;
132 mutable LyXFont font_;
136 void metrics(BufferView * bv, LyXFont const & font) const;
138 void metrics(BufferView * bv = 0) const;
140 void handleFont(BufferView * bv, string const & arg, string const & font);
148 // We don't really mess want around with mathed stuff outside mathed.
150 void mathDispatch(FuncRequest const &);
153 void releaseMathCursor(BufferView * bv);