src/mathed/formulamacro.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_MACRO_H
  18 #define INSET_FORMULA_MACRO_H
  19
  20 #include "formulabase.h"
  21
  22 #ifdef __GNUG__
  23 #pragma interface
  24 #endif
  25
  26 class MathMacroTemplate;
  27
  28 // InsetFormulaMacro's ParInset is the ParInset of the macro definition
  29 // which in turn is stored in the global MathMacroTable.
  30 // No copying/updating needed anymore...
  31
  32 ///
  33 class InsetFormulaMacro: public InsetFormulaBase {
  34 public:
  35         ///
  36         explicit InsetFormulaMacro();
  37         ///
  38         explicit InsetFormulaMacro(string name, int na);
  39         ///
  40         ~InsetFormulaMacro();
  41         ///
  42         int ascent(BufferView *, LyXFont const &) const;
  43         ///
  44         int descent(BufferView *, LyXFont const &) const;
  45         ///
  46         int width(BufferView *, LyXFont const &) const;
  47         ///
  48         void draw(BufferView *,LyXFont const &, int, float &, bool) const;
  49
  50         ///
  51         void read(LyXLex & lex);
  52         ///
  53         void write(std::ostream & os) const;
  54         ///
  55         int ascii(std::ostream &, int linelen) const;
  56         ///
  57         int latex(std::ostream & os, bool fragile, bool free_spc) const;
  58         ///
  59         int linuxdoc(std::ostream & os) const;
  60         ///
  61         int docBook(std::ostream &) const;
  62
  63         ///
  64         Inset * clone(Buffer const &, bool same_id = false) const;
  65         ///
  66         Inset::Code lyxCode() const;
  67         ///
  68         RESULT localDispatch(BufferView *, kb_action, string const &);
  69         ///
  70         MathInsetTypes getType() const;
  71         ///
  72         MathInset * par() const;
  73         ///
  74         void metrics() const;
  75 private:
  76         ///
  77         MathMacroTemplate const & tmacro() const;
  78         /// prefix in inset
  79         string prefix() const;
  80         ///
  81         MathMacroTemplate const * tmacro_;
  82 };
  83
  84 #endif