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 "insets/lyxinset.h"
  25 #include "support/LOstream.h"
  26
  27 class MathParInset;
  28 class MathedCursor;
  29
  30 ///
  31 class InsetFormula: public UpdatableInset {
  32 public:
  33         ///
  34         InsetFormula(bool display = false);
  35         ///
  36         InsetFormula(MathParInset *);
  37         ///
  38         ~InsetFormula();
  39         ///
  40         int ascent(Painter &, LyXFont const &) const;
  41         ///
  42         int descent(Painter &, LyXFont const &) const;
  43         ///
  44         int width(Painter &, LyXFont const &) const;
  45         ///
  46         void draw(Painter &, LyXFont const &, int baseline, float & x) const;
  47         ///
  48         void Write(ostream &) const;
  49         ///
  50         void Read(LyXLex & lex);
  51         ///
  52         int Latex(ostream &, signed char fragile, bool free_spc) const;
  53         ///
  54         int Linuxdoc(ostream &) const;
  55         ///
  56         int DocBook(ostream &) const;
  57         ///
  58         void Validate(LaTeXFeatures &) const;
  59         ///
  60         Inset * Clone() const;
  61         ///
  62         Inset::Code LyxCode() const { return Inset::MATH_CODE; }
  63         ///
  64         LyXFont ConvertFont(LyXFont font) {
  65                 // We have already discussed what was here
  66                 font.setLatex(LyXFont::OFF);
  67                 return font;
  68         }
  69
  70         /// what appears in the minibuffer when opening
  71         const char * EditMessage() const {return _("Math editor mode");}
  72         ///
  73         void Edit(BufferView *, int x, int y, unsigned int button);
  74         ///
  75         bool display() const { return (disp_flag) ? true: false; }
  76         ///
  77         void display(bool);
  78         ///
  79         void ToggleInsetCursor(BufferView *);
  80         ///
  81         void ShowInsetCursor(BufferView *);
  82         ///
  83         void HideInsetCursor(BufferView *);
  84         ///
  85         void GetCursorPos(int &, int &) const;
  86         ///
  87         void ToggleInsetSelection(BufferView * bv);
  88         ///
  89         void InsetButtonPress(BufferView *, int x, int y, int button);
  90         ///
  91         void InsetButtonRelease(BufferView *, int x, int y, int button);
  92         ///
  93         void InsetKeyPress(XKeyEvent * ev);
  94         ///
  95         void InsetMotionNotify(BufferView *, int x, int y, int state);
  96         ///
  97         void InsetUnlock(BufferView *);
  98
  99         ///  To allow transparent use of math editing functions
 100         virtual RESULT LocalDispatch(BufferView *, int, string const &);
 101
 102         ///
 103         void InsertSymbol(BufferView *, char const *);
 104         ///
 105         bool SetNumber(bool);
 106         ///
 107         int GetNumberOfLabels() const;
 108         ///
 109         string getLabel(int) const;
 110
 111 protected:
 112         void UpdateLocal(BufferView * bv);
 113         MathParInset * par;
 114         static MathedCursor * mathcursor;
 115
 116 private:
 117         bool disp_flag;
 118         string label;
 119 };
 120
 121
 122 // If a mathinset exist at cursor pos, just lock it.
 123 // Otherwise create a new one, and lock it.
 124 bool OpenMathInset(Buffer *);
 125
 126 #endif