// -*- 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 "lyxfont.h"
-
-// only for getType():
-#include "math_defs.h"
+#include "insets/updatableinset.h"
class Buffer;
class BufferView;
class MathAtom;
+class CursorSlice;
-///
+
+/// An abstract base class for all math related LyX insets
class InsetFormulaBase : public UpdatableInset {
public:
///
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;
- ///
- virtual MathInsetTypes getType() const = 0;
- /// upper y coordinate
- virtual int upperY() const;
- /// lower y coordinate
- virtual int lowerY() const;
+ /// 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:
///
+ // 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 Inset * clone(Buffer const &, bool same_id = false) const = 0;
- ///
- virtual Inset::Code lyxCode() const;
+ virtual InsetOld::Code lyxCode() const;
/// what appears in the minibuffer when opening
- virtual string const editMessage() const;
- ///
- virtual void edit(BufferView *, int x, int y, unsigned int button);
+ virtual std::string const editMessage() const;
///
- virtual void edit(BufferView *, bool front = true);
+ virtual void getCursorPos(BufferView & bv, int & x, int & y) const;
///
- virtual void toggleInsetCursor(BufferView *);
- ///
- virtual void showInsetCursor(BufferView *, bool show = true);
- ///
- virtual void hideInsetCursor(BufferView *);
- ///
- virtual void getCursorPos(BufferView *, int &, int &) const;
+ 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 void toggleInsetSelection(BufferView * bv);
///
- virtual void insetButtonPress(BufferView *, int x, int y, int button);
+ virtual void insetUnlock(BufferView & bv);
+
+ /// To allow transparent use of math editing functions
+ //virtual void status(FuncRequest const &);
+
+ ///
+ virtual MathAtom const & par() const = 0;
///
- virtual void insetButtonRelease(BufferView *, int x, int y, int button);
+ virtual MathAtom & par() = 0;
///
- virtual void insetKeyPress(XKeyEvent * ev);
///
- virtual void insetMotionNotify(BufferView *, int x, int y, int state);
+ virtual bool searchForward(BufferView *, std::string const &,
+ bool = true, bool = false);
///
- virtual void insetUnlock(BufferView *);
-
- /// To allow transparent use of math editing functions
- virtual RESULT localDispatch(BufferView *, kb_action, string const &);
-
+ virtual bool searchBackward(BufferView *, std::string const &,
+ bool = true, bool = false);
///
- virtual std::vector<string> const getLabelList() const;
+ virtual bool isTextInset() const { return true; }
///
- virtual MathAtom const & par() const = 0;
+ virtual void mutateToText();
///
- virtual MathAtom & par() = 0;
+ virtual void revealCodes(BufferView & bv) const;
///
- virtual void updateLocal(BufferView * bv, bool mark_dirty);
+ virtual EDITABLE editable() const { return HIGHLY_EDITABLE; }
///
- int xo() const { return xo_; }
+ bool display() const;
+ // return the selection as std::string
+ std::string selectionAsString(BufferView & bv) const;
///
- int yo() const { return yo_; }
+ void edit(BufferView * bv, bool);
///
- BufferView * view() const { return view_; }
-
+ void edit(BufferView * bv, int, int);
+protected:
+ /// To allow transparent use of math editing functions
+ virtual
+ DispatchResult priv_dispatch(BufferView & bv, FuncRequest const & cmd);
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(BufferView &, FuncRequest const &);
///
- mutable BufferView * view_;
+ DispatchResult lfunMouseRelease(BufferView &, FuncRequest const &);
///
- mutable LyXFont font_;
+ DispatchResult lfunMouseMotion(BufferView &, FuncRequest const &);
protected:
- ///
- void metrics(BufferView * bv, LyXFont const & font) const;
- ///
- void metrics(BufferView * bv = 0) const;
+
+ /** 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 {}
///
- mutable int xo_;
+ void handleFont(BufferView & bv, std::string const & arg, std::string const & font);
///
- mutable int yo_;
+ 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 mathDispatchGreek(BufferView *, string const &);
-//
-void mathDispatchMathImportSelection(BufferView *, string const &);
-//
-void mathDispatch(BufferView *, kb_action, string const &);
+void mathDispatch(BufferView & bv, FuncRequest const & cmd);
+
+///
+void releaseMathCursor(BufferView & bv);
#endif
projects / lyx.git / blobdiff