// -*- C++ -*-
+
/*
- * File: formula.h
- * Purpose: Declaration of formula inset
- * Author: Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
- * Created: January 1996
- * Description: Allows the edition of math paragraphs inside Lyx.
- *
- * Copyright: 1996, Alejandro Aguilar Sierra
+ * Common parts of the math LyX insets
+ * \author André Pönitz
*
- * Version: 0.4, 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 <iosfwd>
-#include <boost/smart_ptr.hpp>
-
#include "insets/inset.h"
+#include "frontends/mouse_state.h"
+#include "lyxfont.h"
+
+#include <boost/weak_ptr.hpp>
+#include <iosfwd>
class Buffer;
-class MathInset;
+class BufferView;
+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;
///
virtual int width(BufferView *, LyXFont const &) const = 0;
///
virtual void draw(BufferView *,LyXFont const &, int, float &, bool) 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;
+
+public:
///
- virtual void Write(Buffer const *, std::ostream &) const = 0;
+ virtual void validate(LaTeXFeatures &) const;
///
- virtual void Read(Buffer const *, LyXLex & lex) = 0;
+ virtual Inset * clone(Buffer const &, bool same_id = false) const = 0;
///
- virtual int Latex(Buffer const *, std::ostream &,
- bool fragile, bool free_spc) const = 0;
+ virtual Inset::Code lyxCode() const;
+ /// what appears in the minibuffer when opening
+ virtual string const editMessage() const;
///
- virtual int Ascii(Buffer const *, std::ostream &, int linelen) const = 0;
+ virtual void edit(BufferView *, int x, int y, mouse_button::state button);
///
- virtual int Linuxdoc(Buffer const *, std::ostream &) const = 0;
+ virtual void edit(BufferView *, bool front = true);
///
- virtual int DocBook(Buffer const *, std::ostream &) const = 0;
+ virtual void toggleInsetCursor(BufferView *);
///
- virtual void Validate(LaTeXFeatures &) const;
+ virtual void showInsetCursor(BufferView *, bool show = true);
///
- virtual Inset * Clone(Buffer const &) const = 0;
+ virtual void hideInsetCursor(BufferView *);
///
- virtual Inset::Code LyxCode() const;
+ virtual void fitInsetCursor(BufferView *) const;
///
- virtual LyXFont const ConvertFont(LyXFont const & f) const;
- /// what appears in the minibuffer when opening
- virtual string const EditMessage() const;
+ virtual void getCursorPos(BufferView *, int &, int &) const;
+ ///
+ virtual void toggleInsetSelection(BufferView * bv);
+ ///
+ virtual void insetUnlock(BufferView *);
+
+ /// To allow transparent use of math editing functions
+ virtual RESULT localDispatch(FuncRequest const &);
+ /// To allow transparent use of math editing functions
+ //virtual void status(FuncRequest const &);
+
///
- virtual void Edit(BufferView *, int x, int y, unsigned int button);
+ virtual std::vector<string> const getLabelList() const;
///
- virtual void ToggleInsetCursor(BufferView *);
+ virtual MathAtom const & par() const = 0;
///
- virtual void ShowInsetCursor(BufferView *, bool show = true);
+ virtual MathAtom & par() = 0;
///
- virtual void HideInsetCursor(BufferView *);
+ virtual void updateLocal(BufferView * bv, bool mark_dirty);
///
- virtual void GetCursorPos(BufferView *, int &, int &) const;
+ BufferView * view() const { return view_.get(); }
+
///
- virtual void ToggleInsetSelection(BufferView * bv);
+ virtual bool searchForward(BufferView *, string const &,
+ bool = true, bool = false);
///
- virtual void InsetButtonPress(BufferView *, int x, int y, int button);
+ virtual bool searchBackward(BufferView *, string const &,
+ bool = true, bool = false);
///
- virtual void InsetButtonRelease(BufferView *, int x, int y, int button);
+ virtual bool isTextInset() const { return true; }
///
- virtual void InsetKeyPress(XKeyEvent * ev);
+ virtual void mutateToText();
///
- virtual void InsetMotionNotify(BufferView *, int x, int y, int state);
+ virtual void revealCodes(BufferView *) const;
///
- virtual void InsetUnlock(BufferView *);
-
- /// To allow transparent use of math editing functions
- virtual RESULT LocalDispatch(BufferView *, kb_action, string const &);
-
+ virtual EDITABLE editable() const { return HIGHLY_EDITABLE; }
///
- virtual std::vector<string> const getLabelList() const;
+ 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
+ RESULT lfunMousePress(FuncRequest const &);
+ ///
+ RESULT lfunMouseRelease(FuncRequest const &);
+ ///
+ RESULT lfunMouseMotion(FuncRequest const &);
+
+protected:
///
- MathInset * par() const;
+ mutable boost::weak_ptr<BufferView> view_;
+ ///
+ mutable LyXFont font_;
+
protected:
///
- virtual void UpdateLocal(BufferView * bv);
+ void metrics(BufferView * bv, LyXFont const & font) const;
+ ///
+ void metrics(BufferView * bv = 0) const;
+ ///
+ 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 mathDispatch(FuncRequest const &);
+
+///
+void releaseMathCursor(BufferView * bv);
+
#endif