3 * \file InsetMathHull.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
12 #ifndef MATH_HULLINSET_H
13 #define MATH_HULLINSET_H
15 #include "InsetMathGrid.h"
17 #include <boost/scoped_ptr.hpp>
23 class ParConstIterator;
27 /// This provides an interface between "LyX insets" and "LyX math insets"
28 class InsetMathHull : public InsetMathGrid {
31 InsetMathHull(Buffer * buf);
33 InsetMathHull(Buffer * buf, HullType type);
37 void setBuffer(Buffer &);
39 void updateLabels(ParIterator const &, bool);
41 void addToToc(DocIterator const &);
43 InsetMathHull & operator=(InsetMathHull const &);
45 mode_type currentMode() const;
47 void metrics(MetricsInfo & mi, Dimension & dim) const;
49 void drawBackground(PainterInfo & pi, int x, int y) const;
51 void draw(PainterInfo &, int x, int y) const;
53 void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
55 void drawT(TextPainter &, int x, int y) const;
57 docstring label(row_type row) const;
59 void label(row_type row, docstring const & label);
61 ColorCode backgroundColor(PainterInfo const &) const;
63 void numbered(row_type row, bool num);
65 bool numbered(row_type row) const;
67 bool numberedType() const;
71 void validate(LaTeXFeatures & features) const;
72 /// identifies HullInset
73 InsetMathHull const * asHullInset() const { return this; }
74 /// identifies HullInset
75 InsetMathHull * asHullInset() { return this; }
78 void addRow(row_type row);
80 void delRow(row_type row);
82 void swapRow(row_type row);
84 void addCol(col_type col);
86 void delCol(col_type col);
89 HullType getType() const;
91 void mutate(HullType newtype);
94 int defaultColSpace(col_type col);
96 char defaultColAlign(col_type col);
98 bool idxFirst(Cursor &) const;
100 bool idxLast(Cursor &) const;
103 void write(WriteStream & os) const;
105 void mathmlize(MathStream &) const;
107 void normalize(NormalStream &) const;
109 void infoize(odocstream & os) const;
112 void write(std::ostream & os) const;
114 void header_write(WriteStream &) const;
116 void footer_write(WriteStream &) const;
118 void read(Lexer & lex);
120 bool readQuiet(Lexer & lex);
122 int plaintext(odocstream &, OutputParams const &) const;
124 int docbook(odocstream &, OutputParams const &) const;
126 docstring xhtml(XHTMLStream &, OutputParams const &) const;
127 /// the string that is passed to the TOC
128 void tocString(odocstream &) const;
130 /// get notification when the cursor leaves this inset
131 bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
133 //bool insetAllowed(InsetCode code) const;
135 void addPreview(DocIterator const & inset_pos,
136 graphics::PreviewLoader &) const;
137 /// Prepare the preview if preview is enabled.
138 void preparePreview(DocIterator const & pos) const;
139 /// Recreates the preview if preview is enabled.
140 void reloadPreview(DocIterator const & pos) const;
142 void initUnicodeMath() const;
145 static int displayMargin() { return 12; }
147 /// Force inset into LTR environment if surroundings are RTL?
148 virtual bool forceLTR() const { return true; }
151 virtual docstring contextMenu(BufferView const &, int, int) const;
153 InsetCode lyxCode() const { return MATH_HULL_CODE; }
156 InsetMathHull(InsetMathHull const &);
158 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
160 /// do we want to handle this event?
161 bool getStatus(Cursor & cur, FuncRequest const & cmd,
162 FuncStatus & status) const;
164 docstring eolString(row_type row, bool fragile) const;
167 virtual Inset * clone() const;
169 void setType(HullType type);
171 void validate1(LaTeXFeatures & features);
173 docstring nicelabel(row_type row) const;
175 void doExtern(Cursor & cur, FuncRequest & func);
179 * split every row at the first relation operator.
180 * The number of columns must be 1. One column is added.
181 * The first relation operator and everything after it goes to the
186 * split every row at the first relation operator.
187 * The number of columns must be < 3. One or two columns are added.
188 * The first relation operator goes to the second column.
189 * Everything after it goes to the third column.
192 /// change number of columns, split or combine columns if necessary.
193 void changeCols(col_type);
195 docstring standardFont() const;
196 /// consistency check
198 /// can this change its number of rows?
199 bool rowChangeOK() const;
200 /// can this change its number of cols?
201 bool colChangeOK() const;
203 /// "none", "simple", "display", "eqnarray",...
206 std::vector<bool> nonum_;
208 std::vector<InsetLabel *> label_;
210 boost::scoped_ptr<RenderPreview> preview_;
212 mutable bool use_preview_;
218 virtual void mutateToText();
220 virtual void revealCodes(Cursor & cur) const;
222 bool editable() const { return true; }
224 void edit(Cursor & cur, bool front,
225 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
227 Inset * editXY(Cursor & cur, int x, int y);
229 DisplayType display() const;
233 void handleFont(Cursor & cur, docstring const & arg,
234 docstring const & font);
236 void handleFont2(Cursor & cur, docstring const & arg);
238 bool previewState(BufferView * bv) const;