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
17 #include "insets/updatableinset.h"
18 #include "frontends/mouse_state.h"
21 #include <boost/weak_ptr.hpp>
28 /// An abstract base class for all math related LyX insets
29 class InsetFormulaBase : public UpdatableInset {
34 virtual int ascent(BufferView *, LyXFont const &) const = 0;
36 virtual int descent(BufferView *, LyXFont const &) const = 0;
38 virtual int width(BufferView *, LyXFont const &) const = 0;
40 virtual void draw(BufferView *,LyXFont const &, int, float &) const = 0;
41 /// lowest x coordinate
42 virtual int xlow() const;
43 /// highest x coordinate
44 virtual int xhigh() const;
45 /// lowest y coordinate
46 virtual int ylow() const;
47 /// highest y coordinate
48 virtual int yhigh() const;
52 // Don't use this for AMS validation as long as there is no
53 // user-accessible way to override "false positives"
54 virtual void validate(LaTeXFeatures &) const;
56 virtual Inset * clone(Buffer const &, bool same_id = false) const = 0;
58 virtual Inset::Code lyxCode() const;
59 /// what appears in the minibuffer when opening
60 virtual string const editMessage() const;
62 virtual void edit(BufferView *, int x, int y, mouse_button::state button);
64 virtual void edit(BufferView *, bool front = true);
66 virtual void toggleInsetCursor(BufferView *);
68 virtual void showInsetCursor(BufferView *, bool show = true);
70 virtual void hideInsetCursor(BufferView *);
72 virtual void fitInsetCursor(BufferView *) const;
74 virtual void getCursorPos(BufferView *, int &, int &) const;
76 virtual void toggleInsetSelection(BufferView * bv);
78 virtual void insetUnlock(BufferView *);
80 /// To allow transparent use of math editing functions
81 virtual dispatch_result localDispatch(FuncRequest const &);
82 /// To allow transparent use of math editing functions
83 //virtual void status(FuncRequest const &);
86 virtual std::vector<string> const getLabelList() const;
88 virtual MathAtom const & par() const = 0;
90 virtual MathAtom & par() = 0;
92 // And shouldn't this really return a shared_ptr<BufferView> instead?
93 BufferView * view() const;
96 virtual bool searchForward(BufferView *, string const &,
97 bool = true, bool = false);
99 virtual bool searchBackward(BufferView *, string const &,
100 bool = true, bool = false);
102 virtual bool isTextInset() const { return true; }
104 virtual void mutateToText();
106 virtual void revealCodes(BufferView *) const;
108 virtual EDITABLE editable() const { return HIGHLY_EDITABLE; }
110 bool display() const;
111 // return the selection as string
112 string selectionAsString() const;
116 void operator=(const InsetFormulaBase &);
117 /// common base for handling accents
118 void handleAccent(BufferView * bv, string const & arg, string const & name);
120 dispatch_result lfunMousePress(FuncRequest const &);
122 dispatch_result lfunMouseRelease(FuncRequest const &);
124 dispatch_result lfunMouseMotion(FuncRequest const &);
128 mutable boost::weak_ptr<BufferView> view_;
130 mutable LyXFont font_;
134 void metrics(BufferView * bv, LyXFont const & font) const;
136 void metrics(BufferView * bv = 0) const;
138 void handleFont(BufferView * bv, string const & arg, string const & font);
146 // We don't really mess want around with mathed stuff outside mathed.
148 void mathDispatch(FuncRequest const &);
151 void releaseMathCursor(BufferView * bv);