src/mathed/formulabase.h

   1 // -*- C++ -*-
   2
   3 /*
   4  * Common parts of the math LyX insets
   5  * \author  André Pönitz
   6  *
   7  * Full author contact details are available in file CREDITS
   8  *
   9  * You are free to use and modify this code under the terms of
  10  * the GNU General Public Licence version 2 or later.
  11  */
  12
  13 #ifndef INSET_FORMULABASE_H
  14 #define INSET_FORMULABASE_H
  15
  16
  17 #include "insets/inset.h"
  18 #include "frontends/mouse_state.h"
  19 #include "lyxfont.h"
  20
  21 #include <boost/weak_ptr.hpp>
  22 #include <iosfwd>
  23
  24 class Buffer;
  25 class BufferView;
  26 class MathAtom;
  27
  28 /// An abstract base class for all math related LyX insets
  29 class InsetFormulaBase : public UpdatableInset {
  30 public:
  31         ///
  32         InsetFormulaBase();
  33         ///
  34         virtual int ascent(BufferView *, LyXFont const &) const = 0;
  35         ///
  36         virtual int descent(BufferView *, LyXFont const &) const = 0;
  37         ///
  38         virtual int width(BufferView *, LyXFont const &) const = 0;
  39         ///
  40         virtual void draw(BufferView *,LyXFont const &, int, float &, bool) 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;
  49
  50 public:
  51         ///
  52         virtual void validate(LaTeXFeatures &) const;
  53         ///
  54         virtual Inset * clone(Buffer const &, bool same_id = false) const = 0;
  55         ///
  56         virtual Inset::Code lyxCode() const;
  57         /// what appears in the minibuffer when opening
  58         virtual string const editMessage() const;
  59         ///
  60         virtual void edit(BufferView *, int x, int y, mouse_button::state button);
  61         ///
  62         virtual void edit(BufferView *, bool front = true);
  63         ///
  64         virtual void toggleInsetCursor(BufferView *);
  65         ///
  66         virtual void showInsetCursor(BufferView *, bool show = true);
  67         ///
  68         virtual void hideInsetCursor(BufferView *);
  69         ///
  70         virtual void fitInsetCursor(BufferView *) const;
  71         ///
  72         virtual void getCursorPos(BufferView *, int &, int &) const;
  73         ///
  74         virtual void toggleInsetSelection(BufferView * bv);
  75         ///
  76         virtual void insetUnlock(BufferView *);
  77
  78         /// To allow transparent use of math editing functions
  79         virtual RESULT localDispatch(FuncRequest const &);
  80         /// To allow transparent use of math editing functions
  81         //virtual void status(FuncRequest const &);
  82
  83         ///
  84         virtual std::vector<string> const getLabelList() const;
  85         ///
  86         virtual MathAtom const & par() const = 0;
  87         ///
  88         virtual MathAtom & par() = 0;
  89         ///
  90         virtual void updateLocal(BufferView * bv, bool mark_dirty);
  91         ///
  92         BufferView * view() const { return view_.get(); }
  93
  94         ///
  95         virtual bool searchForward(BufferView *, string const &,
  96                                    bool = true, bool = false);
  97         ///
  98         virtual bool searchBackward(BufferView *, string const &,
  99                                     bool = true, bool = false);
 100         ///
 101         virtual bool isTextInset() const { return true; }
 102         ///
 103         virtual void mutateToText();
 104         ///
 105         virtual void revealCodes(BufferView *) const;
 106         ///
 107         virtual EDITABLE editable() const { return HIGHLY_EDITABLE; }
 108         ///
 109         bool display() const;
 110         // return the selection as string
 111         string selectionAsString() const;
 112
 113 private:
 114         /// unimplemented
 115         void operator=(const InsetFormulaBase &);
 116         /// common base for handling accents
 117         void handleAccent(BufferView * bv, string const & arg, string const & name);
 118         /// lfun handler
 119         RESULT lfunMousePress(FuncRequest const &);
 120         ///
 121         RESULT lfunMouseRelease(FuncRequest const &);
 122         ///
 123         RESULT lfunMouseMotion(FuncRequest const &);
 124
 125 protected:
 126         ///
 127         mutable boost::weak_ptr<BufferView> view_;
 128         ///
 129         mutable LyXFont font_;
 130
 131 protected:
 132         ///
 133         void metrics(BufferView * bv, LyXFont const & font) const;
 134         ///
 135         void metrics(BufferView * bv = 0) const;
 136         ///
 137         void handleFont(BufferView * bv, string const & arg, string const & font);
 138
 139         ///
 140         mutable int xo_;
 141         ///
 142         mutable int yo_;
 143 };
 144
 145 // We don't really mess want around with mathed stuff outside mathed.
 146 // So do it here.
 147 void mathDispatch(FuncRequest const &);
 148
 149 ///
 150 void releaseMathCursor(BufferView * bv);
 151
 152 #endif