src/mathed/formulamacro.h

   1 // -*- C++ -*-
   2
   3 /*
   4  *  Main LyX Inset for defining math macros
   5  *
   6  *  \author Alejandro Aguilar Sierra
   7  *  \author André Pönitz
   8  *
   9  *  Full author contact details are available in file CREDITS
  10  *
  11  *  You are free to use and modify this code under the terms of
  12  *  the GNU General Public Licence version 2 or later.
  13  */
  14
  15 #ifndef INSET_FORMULA_MACRO_H
  16 #define INSET_FORMULA_MACRO_H
  17
  18 #include "formulabase.h"
  19
  20
  21 class MathMacroTemplate;
  22
  23 // An InsetFormulaMacro only knows its name and asks the global
  24 // MathMacroTable if it needs to know more.
  25
  26 ///
  27 class InsetFormulaMacro : public InsetFormulaBase {
  28 public:
  29         ///
  30         InsetFormulaMacro();
  31         /// construct a macro hull from its name and the number of arguments
  32         explicit InsetFormulaMacro(string const & name, int nargs);
  33         /// constructs a mocro from its LaTeX definition
  34         explicit InsetFormulaMacro(string const & s);
  35         ///
  36         int ascent(BufferView *, LyXFont const &) const;
  37         ///
  38         int descent(BufferView *, LyXFont const &) const;
  39         ///
  40         int width(BufferView *, LyXFont const &) const;
  41         ///
  42         void draw(BufferView *, LyXFont const &, int, float &) const;
  43
  44         ///
  45         void read(Buffer const *, LyXLex & lex);
  46         ///
  47         void write(Buffer const *, std::ostream & os) const;
  48         ///
  49         int ascii(Buffer const *, std::ostream &, int linelen) const;
  50         ///
  51         int latex(Buffer const *, std::ostream & os, bool fragile, bool free_spc) const;
  52         ///
  53         int linuxdoc(Buffer const *, std::ostream & os) const;
  54         ///
  55         int docbook(Buffer const *, std::ostream &, bool mixcont) const;
  56
  57         ///
  58         Inset * clone(Buffer const &, bool same_id = false) const;
  59         ///
  60         Inset::Code lyxCode() const;
  61         ///
  62         MathAtom const & par() const;
  63         ///
  64         MathAtom & par();
  65 private:
  66         ///
  67         void read(std::istream & is);
  68         /// prefix in inset
  69         string prefix() const;
  70 };
  71
  72 #endif