]> git.lyx.org Git - lyx.git/blobdiff - src/mathed/formula.h
Rename ascii to plaintext and LatexRunParams to OutputParams.
[lyx.git] / src / mathed / formula.h
index 89919d528887359eb8d4e2243efc7aa4bf4baa69..19acb55cea660525d64b3a5d227ca580b292cd26 100644 (file)
 // -*- 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. 
+/**
+ * \file formula.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *  Copyright: 1996, Alejandro Aguilar Sierra
+ * \author Alejandro Aguilar Sierra
+ * \author André Pönitz
  *
- *  Version: 0.4, Lyx project.
- *
- *   You are free to use and modify this code under the terms of
- *   the GNU General Public Licence version 2 or later.
+ * Full author contact details are available in file CREDITS.
  */
 
-#ifndef INSET_FORMULA_H 
+#ifndef INSET_FORMULA_H
 #define INSET_FORMULA_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "formulabase.h"
+#include "math_atom.h"
 
-#include <iosfwd>
+#include <boost/scoped_ptr.hpp>
 
-#include "insets/lyxinset.h"
-#include <boost/smart_ptr.hpp>
+class RenderPreview;
 
-class MathParInset;
-class Buffer;
 
-///
-class InsetFormula: public UpdatableInset {
+/// The main LyX math inset
+class InsetFormula : public InsetFormulaBase {
 public:
        ///
-       explicit
-       InsetFormula(bool display = false);
-       ///
-       explicit
-       InsetFormula(MathParInset *);
-       ///
-       ~InsetFormula();
-       ///
-       int ascent(BufferView *, LyXFont const &) const;
-       ///
-       int descent(BufferView *, LyXFont const &) const;
-       ///
-       int width(BufferView *, LyXFont const &) const;
-       ///
-       void draw(BufferView *,LyXFont const &, int, float &, bool) const;
-       ///
-       void Write(Buffer const *, std::ostream &) const;
-       ///
-       void Read(Buffer const *, LyXLex & lex);
-       ///
-       int Latex(Buffer const *, std::ostream &,
-                 bool fragile, bool free_spc) const;
-       ///
-       int Ascii(Buffer const *, std::ostream &, int linelen) const;
-       ///
-       int Linuxdoc(Buffer const *, std::ostream &) const;
+       InsetFormula(bool chemistry = false);
        ///
-       int DocBook(Buffer const *, std::ostream &) const;
+       explicit InsetFormula(BufferView *);
        ///
-       void Validate(LaTeXFeatures &) const;
+       explicit InsetFormula(std::string const & data);
        ///
-       Inset * Clone(Buffer const &) const;
+       InsetFormula(InsetFormula const &);
        ///
-       Inset::Code LyxCode() const;
-       ///
-       LyXFont const ConvertFont(LyXFont const & f) const;
-       /// what appears in the minibuffer when opening
-       string const EditMessage() const;
-       ///
-       void Edit(BufferView *, int x, int y, unsigned int button);
-       ///
-       bool display() const;
-       ///
-       void display(bool);
+       ~InsetFormula();
        ///
-       void ToggleInsetCursor(BufferView *);
+       void metrics(MetricsInfo & mi, Dimension & dim) const;
        ///
-       void ShowInsetCursor(BufferView *, bool show = true);
+       void draw(PainterInfo & pi, int x, int y) const;
+
        ///
-       void HideInsetCursor(BufferView *);
+       void write(Buffer const &, std::ostream &) const;
        ///
-       void GetCursorPos(BufferView *, int &, int &) const;
+       void read(Buffer const &, LyXLex & lex);
        ///
-       void ToggleInsetSelection(BufferView * bv);
+       int latex(Buffer const &, std::ostream &,
+                 OutputParams const &) const;
        ///
-       void InsetButtonPress(BufferView *, int x, int y, int button);
+       int plaintext(Buffer const &, std::ostream &,
+                 OutputParams const &) const;
        ///
-       void InsetButtonRelease(BufferView *, int x, int y, int button);
+       int linuxdoc(Buffer const &, std::ostream &,
+                    OutputParams const &) const;
        ///
-       void InsetKeyPress(XKeyEvent * ev);
+       int docbook(Buffer const &, std::ostream &,
+                   OutputParams const &) const;
+
        ///
-       void InsetMotionNotify(BufferView *, int x, int y, int state);
+       virtual std::auto_ptr<InsetBase> clone() const;
        ///
-       void InsetUnlock(BufferView *);
-   
-       ///  To allow transparent use of math editing functions
-       virtual RESULT LocalDispatch(BufferView *, kb_action, string const &);
-    
+       void validate(LaTeXFeatures & features) const;
        ///
-       void InsertSymbol(BufferView *, string const &);
+       InsetOld::Code lyxCode() const;
        ///
-       bool SetNumber(bool);
+       bool insetAllowed(InsetOld::Code code) const;
+       /// Appends \c list with all labels found within this inset.
+       void getLabelList(Buffer const &,
+                         std::vector<std::string> & list) const;
        ///
-       std::vector<string> const getLabelList() const;
+       MathAtom const & par() const { return par_; }
        ///
-       void HandleExtern(string const & arg, BufferView * bv);
-   
-protected:
+       MathAtom & par() { return par_; }
        ///
-       void UpdateLocal(BufferView * bv);
+       void generatePreview(Buffer const &) const;
        ///
-       //boost::shared_ptr<MathParInset> par;
-       MathParInset * par;
-    
-private:
+       void addPreview(lyx::graphics::PreviewLoader &) const;
        ///
-       bool disp_flag_;
-};
-
-
-inline
-Inset::Code InsetFormula::LyxCode() const
-{
-       return Inset::MATH_CODE;
-}
+       void mutate(std::string const & type);
 
+private:
+       /// Slot receiving a signal that the preview is ready to display.
+       void statusChanged() const;
+       /// available in AMS only?
+       bool ams() const;
 
-inline
-LyXFont const InsetFormula::ConvertFont(LyXFont const & f) const
-{
-       // We have already discussed what was here
-       LyXFont font(f);
-       font.setLatex(LyXFont::OFF);
-       return font;
-}
-
+       /// contents
+       MathAtom par_;
 
-inline
-bool InsetFormula::display() const
-{
-       return disp_flag_;
-}
+       /// The pointer never changes although *preview_'s contents may.
+       boost::scoped_ptr<RenderPreview> const preview_;
+};
 #endif