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 #include "insets/updatableinset.h"
  17 #include "dimension.h"
  18
  19 #include <boost/weak_ptr.hpp>
  20 #include <iosfwd>
  21
  22 class Buffer;
  23 class BufferView;
  24 class MathAtom;
  25
  26
  27 /// An abstract base class for all math related LyX insets
  28 class InsetFormulaBase : public UpdatableInset {
  29 public:
  30         ///
  31         InsetFormulaBase();
  32         /// lowest x coordinate
  33         virtual int xlow() const;
  34         /// highest x coordinate
  35         virtual int xhigh() const;
  36         /// lowest y coordinate
  37         virtual int ylow() const;
  38         /// highest y coordinate
  39         virtual int yhigh() const;
  40
  41 public:
  42         ///
  43         // Don't use this for AMS validation as long as there is no
  44         // user-accessible way to override "false positives"
  45         virtual void validate(LaTeXFeatures &) const;
  46         ///
  47         virtual Inset::Code lyxCode() const;
  48         /// what appears in the minibuffer when opening
  49         virtual string const editMessage() const;
  50         ///
  51         virtual void fitInsetCursor(BufferView *) const;
  52         /// FIXME
  53         virtual void getCursorPos(BufferView *, int &, int &) const;
  54         /// get the absolute document x,y of the cursor
  55         virtual void getCursor(BufferView & bv, int & x, int & y) const;
  56         ///
  57         virtual void toggleInsetSelection(BufferView * bv);
  58         ///
  59         virtual void insetUnlock(BufferView *);
  60
  61         /// To allow transparent use of math editing functions
  62         virtual dispatch_result localDispatch(FuncRequest const &);
  63         /// To allow transparent use of math editing functions
  64         //virtual void status(FuncRequest const &);
  65
  66         ///
  67         virtual std::vector<string> const getLabelList() const;
  68         ///
  69         virtual MathAtom const & par() const = 0;
  70         ///
  71         virtual MathAtom & par() = 0;
  72         ///
  73         // And shouldn't this really return a shared_ptr<BufferView> instead?
  74         BufferView * view() const;
  75
  76         ///
  77         virtual bool searchForward(BufferView *, string const &,
  78                                    bool = true, bool = false);
  79         ///
  80         virtual bool searchBackward(BufferView *, string const &,
  81                                     bool = true, bool = false);
  82         ///
  83         virtual bool isTextInset() const { return true; }
  84         ///
  85         virtual void mutateToText();
  86         ///
  87         virtual void revealCodes(BufferView *) const;
  88         ///
  89         virtual EDITABLE editable() const { return HIGHLY_EDITABLE; }
  90         ///
  91         bool display() const;
  92         // return the selection as string
  93         string selectionAsString() const;
  94
  95 private:
  96         /// unimplemented
  97         void operator=(const InsetFormulaBase &);
  98         /// common base for handling accents
  99         void handleAccent(BufferView * bv, string const & arg, string const & name);
 100         /// lfun handler
 101         dispatch_result lfunMousePress(FuncRequest const &);
 102         ///
 103         dispatch_result lfunMouseRelease(FuncRequest const &);
 104         ///
 105         dispatch_result lfunMouseMotion(FuncRequest const &);
 106
 107 protected:
 108         ///
 109         //mutable boost::weak_ptr<BufferView> view_;
 110         mutable BufferView * view_;
 111
 112 protected:
 113         ///
 114         void handleFont(BufferView * bv, string const & arg, string const & font);
 115
 116         ///
 117         mutable int xo_;
 118         ///
 119         mutable int yo_;
 120 };
 121
 122 // We don't really mess want around with mathed stuff outside mathed.
 123 // So do it here.
 124 void mathDispatch(FuncRequest const &);
 125
 126 ///
 127 void releaseMathCursor(BufferView * bv);
 128
 129 #endif