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 {
33 explicit InsetMathHull(HullType type);
37 void setBuffer(Buffer &);
39 void updateLabels(ParIterator const &);
41 void addToToc(ParConstIterator const &) const;
43 InsetMathHull & operator=(InsetMathHull const &);
45 mode_type currentMode() const;
47 void metrics(MetricsInfo & mi, Dimension & dim) const;
49 void draw(PainterInfo &, int x, int y) const;
51 void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
53 void drawT(TextPainter &, int x, int y) const;
55 docstring label(row_type row) const;
57 void label(row_type row, docstring const & label);
59 void numbered(row_type row, bool num);
61 bool numbered(row_type row) const;
63 bool numberedType() const;
66 /// Appends \c list with all labels found within this inset.
67 void getLabelList(std::vector<docstring> & list) const;
69 void validate(LaTeXFeatures & features) const;
70 /// identifies HullInset
71 InsetMathHull const * asHullInset() const { return this; }
72 /// identifies HullInset
73 InsetMathHull * asHullInset() { return this; }
76 void addRow(row_type row);
78 void delRow(row_type row);
80 void swapRow(row_type row);
82 void addCol(col_type col);
84 void delCol(col_type col);
87 HullType getType() const;
89 void mutate(HullType newtype);
92 int defaultColSpace(col_type col);
94 char defaultColAlign(col_type col);
96 bool idxFirst(Cursor &) const;
98 bool idxLast(Cursor &) const;
101 void write(WriteStream & os) const;
103 void mathmlize(MathStream &) const;
105 void normalize(NormalStream &) const;
107 void infoize(odocstream & os) const;
110 void write(std::ostream & os) const;
112 void read(Lexer & lex);
114 int plaintext(odocstream &, OutputParams const &) const;
116 int docbook(odocstream &, OutputParams const &) const;
117 /// the string that is passed to the TOC
118 void textString(odocstream &) const;
120 /// get notification when the cursor leaves this inset
121 bool notifyCursorLeaves(Cursor const & old, Cursor & cur);
123 //bool insetAllowed(InsetCode code) const;
125 void addPreview(graphics::PreviewLoader &) const;
128 static int displayMargin() { return 12; }
130 /// Force inset into LTR environment if surroundings are RTL?
131 virtual bool forceLTR() const { return true; }
134 InsetMathHull(InsetMathHull const &);
136 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
138 /// do we want to handle this event?
139 bool getStatus(Cursor & cur, FuncRequest const & cmd,
140 FuncStatus & status) const;
142 docstring eolString(row_type row, bool emptyline, bool fragile) const;
145 virtual Inset * clone() const;
147 void setType(HullType type);
149 void validate1(LaTeXFeatures & features);
151 void header_write(WriteStream &) const;
153 void footer_write(WriteStream &) const;
155 docstring nicelabel(row_type row) const;
157 void doExtern(Cursor & cur, FuncRequest & func);
161 * split every row at the first relation operator.
162 * The number of columns must be 1. One column is added.
163 * The first relation operator and everything after it goes to the
168 * split every row at the first relation operator.
169 * The number of columns must be < 3. One or two columns are added.
170 * The first relation operator goes to the second column.
171 * Everything after it goes to the third column.
174 /// change number of columns, split or combine columns if necessary.
175 void changeCols(col_type);
177 docstring standardFont() const;
178 /// consistency check
180 /// can this change its number of rows?
181 bool rowChangeOK() const;
182 /// can this change its number of cols?
183 bool colChangeOK() const;
185 /// "none", "simple", "display", "eqnarray",...
188 std::vector<bool> nonum_;
190 std::vector<InsetLabel *> label_;
192 boost::scoped_ptr<RenderPreview> preview_;
194 mutable bool use_preview_;
199 /// what appears in the minibuffer when opening
200 docstring editMessage() const;
202 virtual void mutateToText();
204 virtual void revealCodes(Cursor & cur) const;
206 EDITABLE editable() const { return HIGHLY_EDITABLE; }
208 void edit(Cursor & cur, bool front,
209 EntryDirection entry_from = ENTRY_DIRECTION_IGNORE);
211 Inset * editXY(Cursor & cur, int x, int y);
213 DisplayType display() const;
215 InsetCode lyxCode() const;
219 void handleFont(Cursor & cur, docstring const & arg,
220 docstring const & font);
222 void handleFont2(Cursor & cur, docstring const & arg);
224 bool previewState(BufferView * bv) const;