// -*- C++ -*-
-/*
- * File: formulabase.h
- * Purpose: Common parts of the math LyX insets
- * Author: André Pönitz
- * Created: May 2001
- * Description: Allows the edition of math paragraphs inside Lyx.
+/**
+ * \file formulabase.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * Copyright: 2001, The LyX Project
+ * \author André Pönitz
*
- * You are free to use and modify this code under the terms of
- * the GNU General Public Licence version 2 or later.
+ * Full author contact details are available in file CREDITS.
+ *
+ * Common parts of the math LyX insets.
*/
-#ifndef INSET_FORMULABASE_H
+#ifndef INSET_FORMULABASE_H
#define INSET_FORMULABASE_H
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include <iosfwd>
-#include "insets/inset.h"
+#include "insets/updatableinset.h"
class Buffer;
class BufferView;
-class MathInset;
+class MathAtom;
+class CursorSlice;
-///
+
+/// An abstract base class for all math related LyX insets
class InsetFormulaBase : public UpdatableInset {
public:
- ///
- InsetFormulaBase(InsetFormulaBase const & p);
- ///
- explicit InsetFormulaBase(MathInset *);
///
- virtual ~InsetFormulaBase();
- ///
- virtual int ascent(BufferView *, LyXFont const &) const = 0;
- ///
- virtual int descent(BufferView *, LyXFont const &) const = 0;
- ///
- virtual int width(BufferView *, LyXFont const &) const = 0;
- ///
- virtual void draw(BufferView *,LyXFont const &, int, float &, bool) const = 0;
+ InsetFormulaBase();
+ /// 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;
- /// These are just wrappers taking the unused Buffer * dummy parameter
- ///
- virtual void write(Buffer const *, std::ostream &) const;
- ///
- virtual void read(Buffer const *, LyXLex & lex);
- ///
- virtual int latex(Buffer const *, std::ostream &,
- bool fragile, bool free_spc) const;
- ///
- virtual int ascii(Buffer const *, std::ostream &, int linelen) const;
- ///
- virtual int linuxdoc(Buffer const *, std::ostream &) const;
- ///
- virtual int docBook(Buffer const *, std::ostream &) const;
-
-protected:
- /// the actual functions don't use the Buffer * parameter
+public:
///
- virtual void write(std::ostream &) const = 0;
+ // Don't use this for AMS validation as long as there is no
+ // user-accessible way to override "false positives"
+ virtual void validate(LaTeXFeatures &) const;
///
- virtual void read(LyXLex & lex) = 0;
+ virtual InsetOld::Code lyxCode() const;
+ /// what appears in the minibuffer when opening
+ virtual std::string const editMessage() const;
///
- virtual int latex(std::ostream &, bool fragile, bool free_spc) const = 0;
+ virtual void getCursorPos(int cell, int & x, int & y) const;
///
- virtual int ascii(std::ostream &, int linelen) const = 0;
+ virtual void getCursorDim(int &, int &) const;
+ /// get the absolute document x,y of the cursor
+ virtual void getCursor(BufferView & bv, int & x, int & y) const;
///
- virtual int linuxdoc(std::ostream &) const = 0;
+ virtual void toggleInsetSelection(BufferView * bv);
///
- virtual int docBook(std::ostream &) const = 0;
+ virtual void insetUnlock(BufferView *);
+
+ /// To allow transparent use of math editing functions
+ //virtual void status(FuncRequest const &);
-public:
- ///
- virtual void validate(LaTeXFeatures &) const;
- ///
- virtual Inset * clone(Buffer const &, bool same_id = false) const = 0;
///
- virtual Inset::Code lyxCode() const;
+ virtual MathAtom const & par() const = 0;
///
- virtual LyXFont const convertFont(LyXFont const & f) const;
- /// what appears in the minibuffer when opening
- virtual string const editMessage() const;
+ virtual MathAtom & par() = 0;
///
- virtual void edit(BufferView *, int x, int y, unsigned int button);
///
- virtual void toggleInsetCursor(BufferView *);
+ virtual bool searchForward(BufferView *, std::string const &,
+ bool = true, bool = false);
///
- virtual void showInsetCursor(BufferView *, bool show = true);
+ virtual bool searchBackward(BufferView *, std::string const &,
+ bool = true, bool = false);
///
- virtual void hideInsetCursor(BufferView *);
+ virtual bool isTextInset() const { return true; }
///
- virtual void getCursorPos(BufferView *, int &, int &) const;
- ///
- virtual void toggleInsetSelection(BufferView * bv);
+ virtual void mutateToText();
///
- virtual void insetButtonPress(BufferView *, int x, int y, int button);
+ virtual void revealCodes(BufferView *) const;
///
- virtual void insetButtonRelease(BufferView *, int x, int y, int button);
+ virtual EDITABLE editable() const { return HIGHLY_EDITABLE; }
///
- virtual void insetKeyPress(XKeyEvent * ev);
+ bool display() const;
+ // return the selection as std::string
+ std::string selectionAsString() const;
///
- virtual void insetMotionNotify(BufferView *, int x, int y, int state);
+ void edit(BufferView * bv, bool);
///
- virtual void insetUnlock(BufferView *);
-
+ void edit(BufferView * bv, int, int);
+protected:
/// To allow transparent use of math editing functions
- virtual RESULT localDispatch(BufferView *, kb_action, string const &);
-
- ///
- virtual std::vector<string> const getLabelList() const;
- ///
- MathInset * par() const;
+ virtual
+ DispatchResult
+ priv_dispatch(FuncRequest const &, idx_type &, pos_type &);
+private:
+ /// unimplemented
+ void operator=(const InsetFormulaBase &);
+ /// common base for handling accents
+ void handleAccent(BufferView * bv, std::string const & arg, std::string const & name);
+ /// lfun handler
+ DispatchResult lfunMousePress(FuncRequest const &);
+ ///
+ DispatchResult lfunMouseRelease(FuncRequest const &);
+ ///
+ DispatchResult lfunMouseMotion(FuncRequest const &);
+
protected:
- ///
- virtual void updateLocal(BufferView * bv);
+ /** Find the PreviewLoader, add a LaTeX snippet to it and
+ * start the loading process.
+ *
+ * Most insets have no interest in this capability, so the method
+ * defaults to empty.
+ */
+ virtual void generatePreview(Buffer const &) const {}
+
+ ///
+ void handleFont(BufferView * bv, std::string const & arg, std::string const & font);
///
- MathInset * par_;
+ void handleFont2(BufferView * bv, std::string const & arg);
};
// We don't really mess want around with mathed stuff outside mathed.
// So do it here.
-//
-void mathDispatchCreation(BufferView *, string const &, bool);
-//
-void mathDispatchMathDisplay(BufferView *, string const &);
-//
-void mathDispatchMathMode(BufferView *, string const &);
-//
-void mathDispatchMathMacro(BufferView *, string const &);
-//
-void mathDispatchMathDelim(BufferView *, string const &);
-//
-void mathDispatchInsertMath(BufferView *, string const &);
-//
-void mathDispatchInsertMatrix(BufferView *, string const &);
-//
-void mathDispatchMathImportSelection(BufferView *, string const &);
+void mathDispatch(FuncRequest const &);
+
+///
+void releaseMathCursor(BufferView * bv);
#endif