// -*- C++ -*-
/**
- * File: math_inset.h
- * Purpose: Declaration of insets for mathed
- * Author: Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
- * Created: January 1996
- * Description: Math paragraph and objects for a WYSIWYG math editor.
+ * \file math_inset.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * Dependencies: Xlib, XForms
+ * \author Alejandro Aguilar Sierra
+ * \author André Pönitz
*
- * Copyright: 1996, 1997 Alejandro Aguilar Sierra
- *
- * Version: 0.8beta, Math & 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 MATH_INSET_H
#define MATH_INSET_H
-#include <config.h>
-
-#include "LString.h"
#include "insets/insetbase.h"
+#include <string>
+
/**
Abstract base class for all math objects. A math insets is for use of the
*/
-
+class OutputParams;
class MathArrayInset;
class MathAMSArrayInset;
class MathCharInset;
class WriteStream;
class InfoStream;
-class BufferView;
-class UpdatableInset;
class MathMacroTemplate;
class MathMacro;
class MathPosFinder;
class Dimension;
-class FuncRequest;
+class LCursor;
class TextPainter;
class TextMetricsInfo;
class ReplaceData;
class MathInset : public InsetBase {
public:
- /// our members behave nicely...
- MathInset() {}
+ /// identification as math inset
+ MathInset * asMathInset() { return this; }
/// substitutes macro arguments if necessary
virtual void substitute(MathMacro const & macro);
/// draw the object as text
virtual void drawT(TextPainter &, int x, int y) const;
- /// Where should we go when we press the up or down cursor key?
- virtual bool idxUpDown(idx_type & idx, pos_type & pos, bool up,
- int targetx) const;
- /// Where should we go when we press the up or down cursor key?
- virtual bool idxUpDown2(idx_type & idx, pos_type & pos, bool up,
- int targetx) const;
- /// The left key
- virtual bool idxLeft(idx_type & idx, pos_type & pos) const;
- /// The right key
- virtual bool idxRight(idx_type & idx, pos_type & pos) const;
-
- /// Move one physical cell up
- virtual bool idxNext(idx_type & idx, pos_type & pos) const;
- /// Move one physical cell down
- virtual bool idxPrev(idx_type & idx, pos_type & pos) const;
-
- /// Target pos when we enter the inset from the left by pressing "Right"
- virtual bool idxFirst(idx_type & idx, pos_type & pos) const;
- /// Target pos when we enter the inset from the right by pressing "Left"
- virtual bool idxLast(idx_type & idx, pos_type & pos) const;
-
- /// Where should we go if we press home?
- virtual bool idxHome(idx_type & idx, pos_type & pos) const;
- /// Where should we go if we press end?
- virtual bool idxEnd(idx_type & idx, pos_type & pos) const;
-
- /// Delete a cell and move cursor
- virtual bool idxDelete(idx_type &) { return false; }
- /// pulls cell after pressing erase
- virtual void idxGlue(idx_type) {}
- // returns list of cell indices that are "between" from and to for
- // selection purposes
- virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
-
- /// the number of nested cells this inset owns
- virtual idx_type nargs() const;
-
/// return cell given its number
virtual MathArray & cell(idx_type);
/// return cell given its number
virtual MathArray const & cell(idx_type) const;
- /// the number of columns of this inset if it is grid-like
- virtual col_type ncols() const { return 1; }
- /// the number of rows of this inset if it is grid-like
- virtual row_type nrows() const { return 1; }
- /// to which column belongs a cell with a given index?
- virtual col_type col(idx_type) const { return 0; }
- /// to which row belongs a cell with a given index?
- virtual row_type row(idx_type) const { return 0; }
- /// cell idex corresponding to row and column;
- virtual idx_type index(row_type row, col_type col) const;
- /// any additional x-offset when drawing a cell?
- virtual int cellXOffset(idx_type) const { return 0; }
- /// any additional y-offset when drawing a cell?
- virtual int cellYOffset(idx_type) const { return 0; }
- /// can we enter this cell?
- virtual bool validCell(idx_type) const { return true; }
- /// get coordinates
- virtual void getPos(idx_type idx, pos_type pos, int & x, int & y) const;
-
/// identifies certain types of insets
virtual MathAMSArrayInset * asAMSArrayInset() { return 0; }
virtual MathAMSArrayInset const * asAMSArrayInset() const { return 0; }
/// identifies things that can get scripts
virtual bool isScriptable() const { return false; }
- /// thing that can be moved into
- virtual bool isActive() const { return nargs() > 0; }
/// is the a relational operator (used for splitting equations)
virtual bool isRelOp() const { return false; }
- /// -1: text mode, 1: math mode, 0 undecided
- enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
-
- virtual mode_type currentMode() const { return UNDECIDED_MODE; }
/// will this get written as a single block in {..}
virtual bool extraBraces() const { return false; }
virtual bool takesLimits() const { return false; }
/// char char code if possible
- virtual void handleFont(string const &) {}
- /// is this inset equal to a given other inset?
- virtual bool match(MathAtom const &) const { return false; }
+ virtual void handleFont(std::string const &) {}
/// replace things by other things
virtual void replace(ReplaceData &) {}
/// do we contain a given subsequence?
virtual bool lock() const { return false; }
/// access to the lock (only nest array have one)
virtual void lock(bool) {}
- /// get notification when the cursor leaves this inset
- virtual void notifyCursorLeaves(idx_type) {}
/// write LaTeX and Lyx code
virtual void write(WriteStream & os) const;
virtual void mathmlize(MathMLStream &) const;
/// write content as something readable by Octave
virtual void octave(OctaveStream &) const;
- /// describe content if cursor inside
- virtual void infoize(std::ostream &) const {}
- /// describe content if cursor behind
- virtual void infoize2(std::ostream &) const {}
- /// plain ascii output
- virtual int ascii(std::ostream & os, int) const;
- /// linuxdoc output
- virtual int linuxdoc(std::ostream & os) const;
- /// docbook output
- virtual int docbook(std::ostream & os, bool) const;
/// dump content to stderr for debugging
virtual void dump() const;
/// LyXInset stuff
virtual bool numberedType() const { return false; }
/// hull type
- virtual string const & getType() const;
+ virtual std::string const & getType() const;
/// change type
- virtual void mutate(string const &) {}
+ virtual void mutate(std::string const &) {}
/// how is the inset called in the .lyx file?
- virtual string fileInsetLabel() const;
+ virtual std::string fileInsetLabel() const;
/// usually the latex name
- virtual string name() const;
-
-protected:
- /// a dirty hack
- BufferView * view() const;
+ virtual std::string name() const;
};
std::ostream & operator<<(std::ostream &, MathAtom const &);