src/mathed/formula.h

   1 // -*- C++ -*-
   2 /*
   3  *  File:        formula.h
   4  *  Purpose:     Declaration of formula inset
   5  *  Author:      Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
   6  *  Created:     January 1996
   7  *  Description: Allows the edition of math paragraphs inside Lyx.
   8  *
   9  *  Copyright: 1996, Alejandro Aguilar Sierra
  10  *
  11  *  Version: 0.4, Lyx project.
  12  *
  13  *   You are free to use and modify this code under the terms of
  14  *   the GNU General Public Licence version 2 or later.
  15  */
  16
  17 #ifndef INSET_FORMULA_H
  18 #define INSET_FORMULA_H
  19
  20 #ifdef __GNUG__
  21 #pragma interface
  22 #endif
  23
  24 #include "formulabase.h"
  25 #include "math_atom.h"
  26
  27 #include <boost/scoped_ptr.hpp>
  28
  29 class MathHullInset;
  30
  31 ///
  32 class InsetFormula : public InsetFormulaBase {
  33 public:
  34         ///
  35         InsetFormula();
  36         ///
  37         explicit InsetFormula(BufferView *);
  38         ///
  39         explicit InsetFormula(const string & data);
  40         ///
  41         InsetFormula(InsetFormula const &);
  42         ///
  43         ~InsetFormula();
  44         ///
  45         int ascent(BufferView *, LyXFont const &) const;
  46         ///
  47         int descent(BufferView *, LyXFont const &) const;
  48         ///
  49         int width(BufferView *, LyXFont const &) const;
  50         ///
  51         void draw(BufferView *, LyXFont const &, int, float &, bool) const;
  52
  53         ///
  54         void write(Buffer const *, std::ostream &) const;
  55         ///
  56         void read(Buffer const *, LyXLex & lex);
  57         ///
  58         int latex(Buffer const *, std::ostream &, bool fragile, bool free_spc) const;
  59         ///
  60         int ascii(Buffer const *, std::ostream &, int linelen) const;
  61         ///
  62         int linuxdoc(Buffer const *, std::ostream &) const;
  63         ///
  64         int docbook(Buffer const *, std::ostream &, bool mixcont) const;
  65
  66         ///
  67         Inset * clone(Buffer const &, bool same_id = false) const;
  68         ///
  69         void validate(LaTeXFeatures & features) const;
  70         ///
  71         Inset::Code lyxCode() const;
  72         ///
  73         bool insetAllowed(Inset::Code code) const;
  74         ///
  75         virtual RESULT localDispatch(BufferView *, kb_action, string const &);
  76         ///
  77         std::vector<string> const getLabelList() const;
  78         ///
  79         string hullType() const;
  80         ///
  81         MathAtom const & par() const { return par_; }
  82         ///
  83         MathAtom & par() { return par_; }
  84         ///
  85         void generatePreview(grfx::PreviewLoader &) const;
  86         ///
  87         void mutate(string const & type);
  88
  89 private:
  90         /// Is this a displayed environment?
  91         bool display() const;
  92         /// available in AMS only?
  93         bool ams() const;
  94         /// access to hull
  95         MathHullInset * hull() const;
  96         ///
  97         void handleExtern(string const & arg);
  98
  99         /// contents
 100         MathAtom par_;
 101
 102         /// Use the Pimpl idiom to hide the internals of the previewer.
 103         class PreviewImpl;
 104         friend class PreviewImpl;
 105         /// The pointer never changes although *preview_'s contents may.
 106         boost::scoped_ptr<PreviewImpl> const preview_;
 107 };
 108 #endif