small up/down tweaking

[lyx.git] / src / mathed / formulamacro.h

diff --git a/src/mathed/formulamacro.h b/src/mathed/formulamacro.h
index 8243e2a777a1bc416b5e888b475219acf76c04b9..291d3d5e0cd56585df02786ab5699edef6dda8bd 100644 (file)
--- a/src/mathed/formulamacro.h
+++ b/src/mathed/formulamacro.h
@@ -1,20 +1,18 @@
 // -*- C++ -*-
+
 /*
- *  File:        formula.h
- *  Purpose:     Declaration of formula inset
- *  Author:      Alejandro Aguilar Sierra <asierra@servidor.unam.mx> 
- *  Created:     January 1996
- *  Description: Allows the edition of math paragraphs inside Lyx. 
+ *  Main LyX Inset for defining math macros
  *
- *  Copyright: 1996, Alejandro Aguilar Sierra
+ *  \author Alejandro Aguilar Sierra
+ *  \author André Pönitz
  *
- *  Version: 0.4, Lyx project.
+ *  Full author contact details are available in file CREDITS
  *
- *   You are free to use and modify this code under the terms of
- *   the GNU General Public Licence version 2 or later.
+ *  You are free to use and modify this code under the terms of
+ *  the GNU General Public Licence version 2 or later.
  */
 
-#ifndef INSET_FORMULA_MACRO_H 
+#ifndef INSET_FORMULA_MACRO_H
 #define INSET_FORMULA_MACRO_H
 
 #include "formulabase.h"
@@ -25,17 +23,18 @@
 
 class MathMacroTemplate;
 
-// InsetFormulaMacro's ParInset is the ParInset of the macro definition
-// which in turn is stored in the global MathMacroTable.
-// No copying/updating needed anymore...
+// An InsetFormulaMacro only knows its name and asks the global
+// MathMacroTable if it needs to know more.
 
 ///
-class InsetFormulaMacro: public InsetFormulaBase {
+class InsetFormulaMacro : public InsetFormulaBase {
 public:
        ///
-       explicit InsetFormulaMacro();
-       ///
-       explicit InsetFormulaMacro(string name, int na);
+       InsetFormulaMacro();
+       /// construct a macro hull from its name and the number of arguments
+       explicit InsetFormulaMacro(string const & name, int nargs);
+       /// constructs a mocro from its LaTeX definition
+       explicit InsetFormulaMacro(string const & s);
        ///
        int ascent(BufferView *, LyXFont const &) const;
        ///
@@ -43,32 +42,34 @@ public:
        ///
        int width(BufferView *, LyXFont const &) const;
        ///
-       void draw(BufferView *,LyXFont const &, int, float &, bool) const;
+       void draw(BufferView *, LyXFont const &, int, float &, bool) const;
 
        ///
-       void read(LyXLex & lex);
+       void read(Buffer const *, LyXLex & lex);
        ///
-       void write(std::ostream & os) const;
+       void write(Buffer const *, std::ostream & os) const;
        ///
-       int ascii(std::ostream &, int linelen) const;
+       int ascii(Buffer const *, std::ostream &, int linelen) const;
        ///
-       int latex(std::ostream & os, bool fragile, bool free_spc) const;
+       int latex(Buffer const *, std::ostream & os, bool fragile, bool free_spc) const;
        ///
-       int linuxdoc(std::ostream & os) const;
+       int linuxdoc(Buffer const *, std::ostream & os) const;
        ///
-       int docBook(std::ostream &) const;
+       int docbook(Buffer const *, std::ostream &, bool mixcont) const;
 
        ///
-       Inset * clone(Buffer const &) const;
+       Inset * clone(Buffer const &, bool same_id = false) const;
        ///
        Inset::Code lyxCode() const;
        ///
-       RESULT localDispatch(BufferView *, kb_action, string const &);
+       MathAtom const & par() const;
+       ///
+       MathAtom & par();
 private:
+       ///
+       void read(std::istream & is);
        /// prefix in inset
        string prefix() const;
-       ///
-       MathMacroTemplate * tmacro() const;
 };
 
 #endif