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/updatableinset.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 &) 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         // 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;
  55         ///
  56         virtual Inset * clone(Buffer const &, bool same_id = false) const = 0;
  57         ///
  58         virtual Inset::Code lyxCode() const;
  59         /// what appears in the minibuffer when opening
  60         virtual string const editMessage() const;
  61         ///
  62         virtual void edit(BufferView *, int x, int y, mouse_button::state button);
  63         ///
  64         virtual void edit(BufferView *, bool front = true);
  65         ///
  66         virtual void toggleInsetCursor(BufferView *);
  67         ///
  68         virtual void showInsetCursor(BufferView *, bool show = true);
  69         ///
  70         virtual void hideInsetCursor(BufferView *);
  71         ///
  72         virtual void fitInsetCursor(BufferView *) const;
  73         ///
  74         virtual void getCursorPos(BufferView *, int &, int &) const;
  75         ///
  76         virtual void toggleInsetSelection(BufferView * bv);
  77         ///
  78         virtual void insetUnlock(BufferView *);
  79
  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 &);
  84
  85         ///
  86         virtual std::vector<string> const getLabelList() const;
  87         ///
  88         virtual MathAtom const & par() const = 0;
  89         ///
  90         virtual MathAtom & par() = 0;
  91         ///
  92         virtual void updateLocal(BufferView * bv, bool mark_dirty);
  93         ///
  94         // And shouldn't this really return a shared_ptr<BufferView> instead?
  95         BufferView * view() const;
  96
  97         ///
  98         virtual bool searchForward(BufferView *, string const &,
  99                                    bool = true, bool = false);
 100         ///
 101         virtual bool searchBackward(BufferView *, string const &,
 102                                     bool = true, bool = false);
 103         ///
 104         virtual bool isTextInset() const { return true; }
 105         ///
 106         virtual void mutateToText();
 107         ///
 108         virtual void revealCodes(BufferView *) const;
 109         ///
 110         virtual EDITABLE editable() const { return HIGHLY_EDITABLE; }
 111         ///
 112         bool display() const;
 113         // return the selection as string
 114         string selectionAsString() const;
 115
 116 private:
 117         /// unimplemented
 118         void operator=(const InsetFormulaBase &);
 119         /// common base for handling accents
 120         void handleAccent(BufferView * bv, string const & arg, string const & name);
 121         /// lfun handler
 122         dispatch_result lfunMousePress(FuncRequest const &);
 123         ///
 124         dispatch_result lfunMouseRelease(FuncRequest const &);
 125         ///
 126         dispatch_result lfunMouseMotion(FuncRequest const &);
 127
 128 protected:
 129         ///
 130         mutable boost::weak_ptr<BufferView> view_;
 131         ///
 132         mutable LyXFont font_;
 133
 134 protected:
 135         ///
 136         void metrics(BufferView * bv, LyXFont const & font) const;
 137         ///
 138         void metrics(BufferView * bv = 0) const;
 139         ///
 140         void handleFont(BufferView * bv, string const & arg, string const & font);
 141
 142         ///
 143         mutable int xo_;
 144         ///
 145         mutable int yo_;
 146 };
 147
 148 // We don't really mess want around with mathed stuff outside mathed.
 149 // So do it here.
 150 void mathDispatch(FuncRequest const &);
 151
 152 ///
 153 void releaseMathCursor(BufferView * bv);
 154
 155 #endif